bafbal.de - Benutzerbeiträge [de]

Modul VAR neu

2026-05-06T09:12:29Z

Michaelebner: /* #file_op */

Das Modul Var sammelt neben den Variablen auch die grundlegenden Prozeduren und Funktionen.

=Variable=

==#var_set==

<nowiki>#setvar setzt den Wert einer Variablen</nowiki>

Hinweis: Variable sind global, auf sie kann auch in Sub-Kommandos zugegriffen werden. Values sind dagegen lokal.

'''Parameter'''
*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''. Liegt das Recht ''read'' vor, so wird statt dem Inhalt von ''z'' der Inhalt von ''zr'' gesetzt. Liegt kein Recht vor, dann wird der Inhalt von ''zn'' gesetzt
*rf (replace functions) - Wenn Y, dann werden nach der Zuweisung auf die Variable nochmals die Funktionen ersetzt. Wird zum Beispiel benötigt, wenn Code mit Funktionen mittels $DATA() aus der Datenbank geladen wird; Funktionen werden ersetzt, default N; siehe Beispiel
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String
*zn - Wert der Variablen, wenn das Recht r nicht vorliegt
*zr - Wert der Variablen, wenn das Recht r nur ein leserecht ist

'''Beispiele'''

#var_set n=test z="Hello world"
#var_set n=test2 z=$GUID()
#var_set n=edt z=$EDT(edt1) ie=42
#var_set n=_page_kunde_adressänderung_ro z=N zn=Y zr=Y r=kundenservice

Zum Parameter rf: $NOW() in die Zwischenablage kopieren und dann ausführen:

#var_set n=test z=$CLIPBOARD() rf=N
#message c=$VAR(test)
#var_set n=test z=$CLIPBOARD() rf=Y
#message c=$VAR(test)

==#var_setempty==

<nowiki>#var_setempty setzt den Wert einer Variablen, sofern sie (noch) leer ist.</nowiki>

(Besteht der Variableninhalt aus Leerzeichen, gilt die Variable auch als leer.)

'''Parameter'''

*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''. Liegt das Recht ''read'' vor, so wird statt dem Inhalt von ''z'' der Inhalt von ''zr'' gesetzt. Liegt kein Recht vor, dann wird der Inhalt von ''zn'' gesetzt
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String
*zn - Wert der Variablen, wenn das Recht r nicht vorliegt
*zr - Wert der Variablen, wenn das Recht r nur ein leserecht ist

'''Beispiele'''

#var_setempty n=test z="Hello world"
#var_setempty n=test2 z=$GUID()
#var_setempty n=edt z=$EDT(edt1) ie=42

==#var_add==

<nowiki>#var_add fügt einer Variablen einen Wert hinzu.</nowiki>

'''Parameter'''

*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''.
* y -Typ der Operation; default ''text''
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** month - Es wird dem Datum eine Anzahl von Monaten hinzugefügt
** text - Der Wert wird als Text hinzugefügt
*z - Wert, welcher der Variablen hinzugefügt wird, Funktionen werden ersetzt, default ist ein leerer String oder eine 0

'''Beispiel'''

#var_set n=test z=$NOW()
#var_add n=test z=1 y=datetime
#cout c=$VAR(test)

==#var_log==

Schreibt den Inhalt aller Variablen in das Debug-Log.

Wird nur zur Fehlersuche verwendet.

'''Parameter'''

(keine)

'''Beispiel'''

#var_log

==$VAR()==

Mit der Funktion $VAR() wird auf den Inhalt der Variable zugegriffen.

'''Parameter'''

# Name der Variable
# optional: Der Wert wird vor oder nach der Rückgabe als Funktionsergebnis verändert; nur für ganzzahlige Werte
## ib ("increment before") - Der Wert wird vor der Rückgabe um eins erhöht
## db ("decrement before") - Der Wert wird vor der Rückgabe um eins verringert
## ia ("increment after") - Der Wert wird nach der Rückgabe um eins erhöht
## da ("decrement after") - Der Wert wird nach der Rückgabe um eins verringert

'''Beispiele'''

#message c=$VAR(test)
#var_set n=neuer_wert z=$VAR(wert) ie=$VAR(alternativwert)
#execsql k_lfdnr=$VAR(lfdnr,ib)

=Kommandos=

(Primär- und Sub) Kommandos sind üblicherweise benannt und werden im Code-Dialog eingegeben.

Es besteht jedoch auch die Möglichkeit, lokale Kommandos innerhalb eines anderen Kommandos zu definieren. Diese Kommandos haben statt eines Kommando-Namens dann dann eine Kommando-Nummer.

Lokale Kommandos werden üblicherweise für folgende Zwecke verwendet:

* Bei der Verwendung von xlive werden bisweilen Prozeduren eingesetzt, die ihrerseits ein Kommando aufrufen (z.B. #sql_open). Wenn dieses Kommando nichts bereits existiert, kann es nur als lokales Kommando erstellt werden.

* Wenn das auszuführende Kommando auf derselben Seite stehen soll wie die aufrufende Prozedur.

Siehe als Beispiel: [[beispiele_csv|User-Tabelle als CSV-Datei exportieren]]

==#cmd==

<nowiki>#cmd fügt dem Kommando eine Zeile hinzu</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #cmd fügt dem ersten Kommando eine Zeile hinzu, #cmd2 fügt dem zweiten Kommando eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#cmd hat keine benannten Parameter. Die ganze Zeile nach dem #cmd und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

'''Beispiel'''

#cmd3 #text $DATA(n,login);$DATA(n,shortname);$DATA(n,firstname);$DATA(n,lastname);$DATA(n,userid);

Siehe auch [[beispiele_csv|User-Tabelle als CSV-Datei exportieren]]

==#cmd_clear==

<nowiki>#cmd_clear löscht ein Kommando</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #cmd_clear löscht das erste Kommando, #cmd_clear2 löscht das zweite Kommando, und so weiter.

'''Parameter'''

(keine)

Folgen dem #cmd_clear Zeichen, so werden die dem gerade gelöschten Kommando hinzugefügt. Auf diese Weise lässt sich etwas prägnanter formulieren.

'''Beispiele'''

#cmd_clear3
#cmd_clear #grd_add i=grid f_logtext="Kunde angerufen und nicht erreicht."

==#cmd_clearall==

<nowiki>#cmd_clearall löscht alle Kommandos</nowiki>

'''Parameter'''

(keine)

'''Beispiel'''

#cmd_clearall

=CSV=

Die CSV-Routinen werden verwendet, um CSV-Dateien einzulesen und zu verarbeiten.

==#csv_open==

<nowiki>#csv_open öffnet eine CSV-Datei</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #csv_open öffnet die erste CSV-Datei, #csv_open2 öffnet die zweite CSV-Datei, und so weiter.

'''Parameter'''

*ber - wenn Y, werden die Zeilenumbrüche innerhalb von Feldern durch Leerzeichen ersetzt. Die Felder müssen dabei in doppelten Anführungszeichen eingeschlossen sein.
* e ("encoding") - Encoding der zu öffnenden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - ("Filename") Dateiname der CSV-Datei
*hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden. Groß- und Kleinschreibung ist unerheblich. Muss bereits hier gesetzt werden, wenn mit $CSV_LINE auf den Header zugegriffen werden soll, bevor #csv_line ausgeführt wird.
*txt ("Text") - alternativ zum Dateinamen fn die Nummer eines Textes, der als CSV-Datei verwendet werden soll.

'''Beispiel'''

#csv_open fn=c:\temp\text.csv

==#csv_line==

<nowiki>#csv_line geht zeilenweise durch die CSV-Datei</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #csv_line geht durch die erste CSV-Datei, #csv_line2 geht durch die zweite CSV-Datei, und so weiter.

'''Parameter'''

* db ("database") - Die Datenbank, für welche die Transaktion ausgeführt wird, wenn ert=Y gesetzt ist. Default ist die Standard-Datenbank, Funktionen werden ersetzt.
*er ("each row") - Kommando, das für jede Zeile der CSV-Datei ausgeführt wird.
*ert ("each row transaction") - Für jede Ausführung des in er spezifizierten Kommandos wird eine eigene Datenbank-Transaktion ausgeführt, Funktionen werden ersetzt
*hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden. Groß- und Kleinschreibung ist unerheblich.
*m ("maximum") - Maximale Anzahl der Zeilen, die verarbeitet wird. Wird gerne bei der Entwicklung verwendet, um die Bearbeitungsgeschwindigkeit zu erhöhen. Funktionen werden ersetzt
* nex ("no exception") - Wenn Y, wird im Falle einer Exception die Bearbeitung nicht abgebrochen, sondern lediglich Warnungen geloggt; Default N, Funktionen werden ersetzt
*sep ("separator") - Trennzeichen zwichen den Spalten, default ist das Semikolon, Funktionen werden ersetzt
*trim - Wenn Y, dann werden in jeder Zelle führende und nachhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt

'''Beispiel'''

#csv_line er=test_csv_line hhr=Y m=3

==#csv_check==

<nowiki>#csv_check prüft die CSV-Datei</nowiki>

'''Parameter'''

*cnt ("count") - Anzahl der Header-Einträge, die geprüft wird; Funktionen werden ersetzt
*h1, h2... ("header") - Eintrag im Header, der auf existenz geprüft wird; Groß und Kleinschreibung ist unerheblich, Funktionen werden ersetzt.
*n ("name" / "number") - Name der Variable oder Nummer des Values, in die/den das Ergebnis (Y oder N) geschrieben wird; Funktionen werden ersetzt
*res ("result") - Name der Variable oder Nummer des Values, in die/den der Ergebnistext geschrieben wird; Funktionen werden ersetzt
*sep ("separator") - Trennzeichen zwischen den einzelnen Spalten; Funktionen werden ersetzt
*y - Typ der Prüfung; Funktionen werden ersetzt, default header
** header - Prüft die Existenz von Spaltennamen im Header. Die zu prüfenden Spaltennamen werden als h1, h2... übergeben, cnt ist entsprechend zu setzen. Wenn alle geprüften Spaltennamen vorhanden sind, wird Y zurück gegeben, ansonsten N. Die fehlenden Spaltennamen werden als Ergebnistext zurück gegeben.

'''Beispiel'''

#csv_open fn=C:\temp\mad\done\MTF3108_ET2607_selektion.CSV
#csv_check n=1 res=2 cnt=3 h1=eins h2=zwei h3=drei
#coutl $VAL(1) - $VAL(2)

==#csv_paste==

Übernimmt eine CSV-Datei aus der Zwischenablage. Auf die Werte kann mit $SEPLINE() zugegriffen werden, siehe [[beispiele_pastecsv|Eine Tabelle in der Zwischenablage in ein PDF-Dokument wandeln]]

'''Multi-Row'''

Mit dem Multi-Row-Modus können Daten eingelesen werden, die in einer Zeile mehrere gleichartige Werte haben.

Daten, die im Single-Row-Modus wie folgt aussehen:

01.01.2020 4465
01.01.2020 8574
01.01.2020 3456
02.01.2020 5467
03.01.2020 2436
03.01.2020 6578
03.01.2020 3456
03.01.2020 6578
03.01.2020 4457
03.01.2020 7658

Würden im Multi-Row-Modus wie folgt aussehen (und könnten auch so eingelesen werden):

01.01.2020 4465 8574 3456
02.01.2020 5467
03.01.2020 2436 6578 3456 6578 4457 7658

'''Parameter'''

* er ("each row") - Kommando, das für jede Zeile der CSV-Datei ausgeführt wird.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert ("each row transaction") - Für jede Ausführung des in er spezifizierten Kommandos wird eine eigene Datenbank-Transaktion ausgeführt.
* fr ("first row") - Wenn dieser Parameter einen Wert hat, dann muss die kopierte CSV-Datei in der ersten Zeile auch diesen Wert haben, oder die Aktion wird abgebrochen; Funktionen werden ersetzt
* hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden.
* mrs ("multi row start") - Erste Spalte für den Multi-Row-Bereich
* sep ("separator") - Trennzeichen zwichen den Spalten, default ist das Tabulatorzeichen
* trim - Wenn Y, dann werden in jeder Zelle führende und nachhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt
* y - Typ; default s
** m - multi; siehe Abschnitt Multi-Row
** s - single; die CSV-Datei wird Zeile für Zeile eingelesen

'''Beispiele'''
* [[beispiele_pastecsv|Eine Tabelle in der Zwischenablage in ein PDF-Dokument wandeln]]

#csv_paste er=imp_line hhr=Y
#csv_paste er=imp_line y=m mrs=1

==$CSV()==

<nowiki>$CSV() greift auf einen Feldinhalt der aktuellen CSV-Zeile zu.</nowiki>

'''Parameter'''

# Nummer der CSV-Datei
# Name der Spalte oder 0-relative Spaltennummer. Name der Spalte setzt voraus, dass bei #csv_line der Parameter hhr gleich Y ist.
# optional: Stelle der Zeichens, ab dem der Inhalt des CSV-Feldes zurück gegeben wird
# optional: Anzahl der Zeichen, die maximal zurück gegeben werden; wird meist dafür verwendet, damit die maximale Länge von Datenbankfeldern nicht überschritten wird.

'''Beispiele'''

#setvar n=test z=$CSV(1,0)

Hier im Beispiel wird in der ersten CSV-Datei (#csv_open) auf die erste Spalte (0, da 0-relativ) zugegriffen.

#setvar n=test z=$CSV(1,0,1,30)

Wie oben, nur werden nur die ersten 30 Zeichen zurück gegeben

==$CSV_LINE()==

<nowiki>$CSV_LINE() Gibt eine ganze Zeile einer CSV-Datei zurück</nowiki>

'''Parameter'''

# Nummer der CSV-Datei
# Name der Zeile: header gibt die Header-Zeile zurück, current die aktuelle Zeile in #csv_line

'''Beispiel'''

Die Funktion $CSV_LINE wird insbesondere dafür verwendet, um CSV-Dateien mit Daten zu ergänzen. Hier im Beispiel wird jede Zeile mit einer GUID ergänzt.

#cmd_clear #text $CSV_LINE(1,current)$GUID();

#csv_open fn=c:\temp\ex.csv hhr=Y
#text_clear $CSV_LINE(1,header)guid;
#csv_line er=1 hhr=Y

#text_save fn=c:\temp\ex2.csv

Nach dem Öffnen der bestehenden CSV-Datei (es muss hier bereits hhr gesetzt werden) wird zunächst der Header in Text 1 eingefügt, ergänzt um die Spalte ''guid'' und das abschließende Semikolon. Danach gehen wir mit #csv_line durch alle Zeile, fügen diese komplett in Text 1 ein und hängen eine GUID hinten dran. Danach wird die Datei gespeichert.

=Text=

==#text==

<nowiki>#text fügt dem Text eine Zeile hinzu</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text fügt dem ersten Text eine Zeile hinzu, #text2 fügt dem zweiten Text eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#text hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#text Zeile 1
#text Zeile 2
#text Und jetzt noch eine GUID: $GUID()
#text Der folgende Text kommt in Großbuchstaben: $UPP(hello world)

==#textn==

<nowiki>#textn fügt dem Text eine Zeile hinzu. Im Unterschied zu #text werden dabei keine Funktionen ersetzt.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #textn fügt dem ersten Text eine Zeile hinzu, #text2n fügt dem zweiten Text eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#text hat keine benannten Parameter. Die ganze Zeile nach dem #textn und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

Funktionen werden dabei '''nicht''' ersetzt.

'''Beispiel'''

#textn Zeile 1
#textn Zeile 2

==#text_clear==

<nowiki>#text_clear löscht einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_clear löscht den ersten Text, #text_clear2 löscht den zweiten Text, und so weiter.

'''Parameter'''

(keine)

Folgen dem #text_clear Zeichen, so werden die dem gerade gelöschten Text hinzugefügt. Auf diese Weise lässt sich etwas prägnanter formulieren.

'''Beispiel'''

#text_clear7
#text7 Zeile 1
#text7 Zeile 2

Das vorangestellt #text_clear stellt sicher, dass Text7 leer ist. Alternativ könnte man formulieren:

#text_clear7 Zeile 1
#text7 Zeile 2

==#text_save==

<nowiki>#text_save speichert einen Text in einer Datei.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_save speichert den ersten Text, #text_save2 speichert den zweiten Text, und so weiter.

'''Parameter'''
* bom ("Byte order mark") - Wenn Y, dann wird die Datei mit BOM geschrieben; default Y
* e ("encoding") - Encoding der zu speichernden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - Dateiname, unter dem die Datei gespeichert wird. Bestehende Dateien werden überschrieben, sofern das Betriebssystem das nicht verhindert (z.B, weil die Datei gerade geöffnet ist)
* o ("open") - Öffnet die gespeicherte Datei gleich anschließend.
*sort - Wenn Y, dann wird die Datei vor dem Speichern sortiert.

'''Beispiel'''

#text Hello world
#text_save fn=$DIR(userroot)hello_world.txt
#text_save fn=c:\temp\export_vert_export.prepared_.csv e=utf8 bom=N

==#text_open==

<nowiki>#text_open öffnet einen Text aus einer Datei, der bisherige Inhalt der Datei wird überschrieben.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_open öffnet den ersten Text, #text_open2 öffnet den zweiten Text, und so weiter.

'''Parameter'''

* e ("encoding") - Encoding der zu öffnenden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - Dateiname der Datei, die geöffnet wird.

'''Beispiel'''

#text_open fn=$DIR(userroot)test.txt
#text Eine weitere Zeile, $GUID()
#text_save fn=$DIR(userroot)test.txt

==#text_props==

<nowiki>#text_props stellt Eigenschaften des Textes ein.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_props bezieht sich auf den ersten Text, #text_props2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* dub ("duplicates") - Verhalten einer sortierten Liste bezüglich Dubletten
** acc ("accept") - Dubletten werden akzeptiert
** err ("error") - Dubletten führen zu Fehlern
** ign ("ignore) - Dubletten werden ignoriert
* srt ("sorted") - Wenn ja, dann ist die Liste sortiert

'''Beispiel'''

#text_props srt=Y dup=ign

==#text_set==

<nowiki>#text_set setzt eine bestimmte Zeile eines Textes</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_set bezieht sich auf den ersten Text, #text_set2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* i ("index") - 0-relativer Index der Zeile, die geschrieben werden soll. Mit ''last'' kann die letzte Zeile geschrieben werden, mit ''all'' werden alle Zeilen ersetzt, das wird dann gebraucht, wenn mehrzeiliger Text zugewiesen werden soll; Funktionen werden ersetzt
* z - Text, der geschrieben wird; Funktionen werden ersetzt

'''Beispiele'''

#text_set i=2 z="dritte Zeile"
#text_set i=last z="letzte Zeile"
#text_set i=all z=$CLIPBOARD()

==#text_sort==

<nowiki>#text_sort sortiert einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_sort bezieht sich auf den ersten Text, #text_sort2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* y - Typ, default alpha, Funktionen werden ersetzt
** alpha - sortiert alphanumerisch
** inv - invertiert die gegebene Reihenfolge

'''Beispiel'''

#val_set n=1 z=",OU=2nd_Level_T1,OU=Kundenservice,OU=Benutzer,OU=Testtours,OU=Travel"
#text_clear
#text_dissect z=$VAL(1) sep=",OU="
#coutl $TEXT(1)
#text_sort y=inv
#text_compose n=1 sep=.
#val_set n=1 z=tt.$VAL(1)
#coutl $VAL(1)

Ergebnis ist:
2nd_Level_T1
Kundenservice
Benutzer
Testtours
tt.Testtours.Benutzer.Kundenservice.2nd_Level_T1.

==#text_dissect==

<nowiki>#text_dissect zerteilt einen String anhand einer vorgegebenen Trennzeichenfolge und fügt das Ergebnis dem betreffenden Text hinzu. Gegebenenfalls muss der Text vorher mit #text_clear geleert werden.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_dissect bezieht sich auf den ersten Text, #text_dissect bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* ls ("last separator") - wenn Y, wird die sep-Zeichenfolge noch mal dem String angehängt; default N, Funktionen werden ersetzt
* sep ("separator") - Zeichenfolge, anhand der String zerteilt wird; Funktionen werden ersetzt
* z - String, der zerlegt wird; Funktionen werden ersetzt

'''Beispiel'''

Siehe #text_sort

==#text_compose==

<nowiki>#text_compose setzt einen Text mithilfe eines Trennzeichens zu einem String zusammen</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_compose bezieht sich auf den ersten Text, #text_compose bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* ls ("last separator") - Wenn Y, wird die Trennzeichenfolge auch noch mal am Ende des Strings eingefügt; default N, Funktionen werden ersetzt
* n - Nummer des Values oder Name der Variable, in welche der String geschrieben wird; Funktionen werden ersetzt
* sep ("separator") - Trennzeichenfolge, die beim Zusammenfügen des Textes verwendet wird; Funktionen werden ersetzt

'''Beispiel'''

Siehe #text_sort

==#text_act==

<nowiki>#text_act bearbeitet einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_act bezieht sich auf den ersten Text, #text_act2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''
* c ("caption") - Text der Zeile, die bei insert eingefügt werden soll; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* cu ("current") - 0-relative Zeilennummer der Operation; default 0, Funktionen werden ersetzt
* ne ("new") - 0-relative Zeilennummer als Ziel bei move; default 0, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt
** delete - Löscht die Zeile an Position cu ("current")
** insert - Fügt den Text c an der Position cu ("current") ein
** move - verschiebt die Zeile cu ("current") nach Zeile ne ("new")

'''Beispiel'''
#text_act y=move cu=0

==#text_loop==

<nowiki>#text_loop geht durch die Zeilen eines Textes und ruft für jede Zeile ''er'' auf</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_loop bezieht sich auf den ersten Text, #text_loop2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* db - ("database") Name der Datenbank, auf die sich ert bezieht
* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* m - ("maximum") Es wird maximal für die Anzahl der angegebenen Zeilen das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten.
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N, Funktionen werden ersetzt.
* n - Name der Variable, in welche die 0-relative Schleifenvariable geschrieben wird. (Es würde auch in einen Value geschrieben, wenn es sich um eine Nummer handelt, das ergibt in der Praxis aber meist nicht viel Sinn) Funktionen werden ersetzt

'''Beispiel'''

#text_clear eins
#text zwei
#text drei

#cmd_clear #coutl - $TEXT(1,$VAR(eins))
#text_loop er=1 n=eins

==#tvl_add==

Addiert dem Wert in einer Text-Valueliste einen Wert hinzu. Es handelt sich dabei um eine nummerierte Prozedur: #tvl_add arbeitet mit Text 1, #tvl_add2 mit Text 2 und so weiter.

'''Parameter'''

* cnd ("condition") - Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* n ("name") - Name der Zeile, der ein Wert hinzugefügt wird; Funktionen werden ersetzt.
* y - Typ der Operation, Funktionen werden ersetzt, default text
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** text - Der Wert wird als Text hinzugefügt
* z - Der Wert, der hinzugefügt wird

'''Beispiel'''

#text eins=1
#text zwei=2
#text drei=3
#tvl_add y=int n=zwei z=1
#coutl $TEXT(1)

==$TEXT()==

Mit der Funktion $TEXT() wird auf den Inhalt des Textes zugegriffen.

'''Parameter'''

# Nummer des Textes
# optional Zeile des Textes (0-relativ). Wenn es keinen zweiten Parameter gibt, wird der komplette Text zurück gegeben. Alternativ als zweiter Parameter eine Sonderfunktion:
## cnt / count - Gibt die Anzahl der Zeilen zurück
## last - Gibt die letzte Zeile zurück
## ix - Gibt die Position des Textes im dritten Parameter zurück
## as_line - Gibt den Text als eine Zeile zurück, Zeilenumbrüche werden durch den dritten Parameter ersetzt
# optional in abhängigkeit vom zweiten Paremeter
## wenn zweiter Parameter ix: Textzeile, nach der mit ix gesucht wird
## wenn zweiter Parameter as_line: Zeichenfolge, mit der die Zeilenumbrüche ersetzt werden

'''Beispiele'''

#text Zeile 1
#text Zeile 2
#text Zeile 3
#message c=$TEXT(1)

#code url=$TEXT(1,as_line,&)

=Code=

Grundsätzlich gilt in BAL: Eine Prozedur - eine Zeile.

Bei vielen und/oder langen Parametern führt das zu recht langen Code-Zeilen und zu Unübersichtlichkeit. Hier können nun Teile der Parameter mit #code in weitere Zeile ausgelagert werden, deren Inhalt dann mit $CODE$ oder $CODE$ der eigentlichen Code-Zeile hinzugefügt wird.

==#code==

Fügt Text dem Code-Speicher hinzu.

'''Parameter'''

<nowiki>#code hat keine benannten Parameter. Die ganze Zeile nach dem #code und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

'''Beispiel'''

#code cnt=2
#code fn1=G:\pics\pic5d68865cdaba62_62767562.jpg
#code fn2=G:\pics\pic5d913c48682128_67979256.jpg
#email_send from=test@****.de to=info@*****************.de bcc=info@*****.de subject=Testmail text=$TEXT(1) $CODE$

==$CODE$ / $CODEN$==

<nowiki>$CODE$ und $CODEN$ sind keine Funktionen, auch wenn sie auf den ersten Blick ähnlich aussehen. Sie haben keine Parameter und auch keine Klammern, dafür ein abschließendes $.</nowiki>

Beide Anweisungen fügen den Code-Speicher der jeweiligen Zeile hinzu. $CODE$ löscht danach den Code-Speicher, $CODEN$ tut das nicht, so dass dieselben Parameter wiederholt eingefügt werden können (beim letzten Einfügen sollte dann $CODE$ verwendet werden).

=Separierte Zeile=

Eine separierte Zeile ist eine Textzeile, die mehrere gleichartige Werte enthält, die durch Trennzeichen getrennt sind.

Beispiel:

3244,4465,7763,4536,4356,7777

Solche Zeilen können mit #sepline aufgetrennt werden.

==#sepline==

Trennt eine separierte Zeile auf und führt für jeden Wert das mit er angegebene Kommando aus.

Es handelt sich dabei um eine nummerierte Prozedur (#sepline, #sepline2...)

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y; Funktionen werden ersetzt
* db - ("database") Name der Datenbank, für welche die Transaktion gestartet wird, wenn ert=Y. Default ist die Standard-Datenbank, Funktionen werden ersetzt.
* er ("each row") - Das Kommando, das für jeden Wert der separierten Zeile aufgerufen wird. Funktionen werden ersetzt.
* ern ("each row no") - Das Kommando, das für jeden Wert der separierten Zeile aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert ("each row transaction") - Wenn Y, wird für jeden Wert der separierten Zeile eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* m ("maximum") - Es wird maximal für die Anzahl der angegebenen Werte das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten; Funktionen werden ersetzt.
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N; Funktionen werden ersetzt.
* nn ("not null") - Wenn Y, dann wird er nur für Werte der separierten Zeile aufgerufen, die nicht leer sind. Default N, Funktionen werden ersetzt.
* sep ("separator") - Das oder die Trennzeichen; default ist das Semikolon, Funktionen werden ersetzt.
* z - Der Inhalt der separierten Zeile; Funktionen werden ersetzt.

'''Beispiel'''

#cmd #cout c=$SEPLINE(1)
#sepline z=3244,4465,7763,4536,4356,7777 sep=, er=1

==$SEPLINE()==

Greift auf den einzelnen Wert einer mit #sepline getrennten Zeile zu.

'''Parameter'''

# Nummer der separierten Zeile

'''Beispiel'''

#cmd #cout c=$SEPLINE(3)
#sepline3 z=3244;4465;7763;4536;4356;7777 er=1

=User und Rechte=

Aus Gründen der Übersichtlichkeit ist die Rechtevergabe zweistufig:

# Es werden (meist am Anfang eines Primär-Kommandos) Rechte-Definitionen erstellt, die einer oder mehreren Benutzergruppen Rechte (lesen oder lesen und schreiben) zuweisen. Die Rechte werden dabei implizit auch allen Untergruppen der angegebenen Benutzergruppe erteilt (Zum Beispiel: Rechte der Gruppe ''user'' hat auch implizit die Gruppe ''user.admin'').
# Dem Parameter r verschiedener Prozeduren kann dann eine Rechte-Definition zugewiesen werden.

Den Parameter r als Rechte-Definition berücksichtigen die folgenden Prozeduren:

* #frm
* Buttons (#btn, #btns_btn)
* Alle Segmente (#text_seg, #memo_seg, #btns_seg, vl_seg, #grd_seg, #xgrd_seg)
* Tree (#tree_add, #tree_fill, #tree_fillsql, Lese-Recht reicht)
* Grid-Spalten (#grd_col, #xgrd_col)
* #vl_line (für die komplette Zeile (r) und die einzelne Zelle (r1, r2, r3...))

Wo der Parameter r nicht gesetzt ist, wird die Rechte-Definition der Formulars verwendet.

==#rights==

Setzt eine Rechte-Definition im betreffenden Kommando.

'''Parameter'''

* n ("name") - Name der Rechte-Definition; default ist ''frm'', also dsa Default-Recht für das Formular.
* r_ ("right") - Prefix für die Benutzergruppe. Für die Rechte-Definition sind die folgenden Werte zulässig
** n ("no") - kein Recht
** r ("read") - nur lesen
** w ("write") - lesen und schreiben

'''Beispiel'''

#rights n=frm r_user=r r_user.admin=w

Setzt für alle User das Lese-Recht und für Administratoren das Lese- und Schreibrecht.

==#rights_clear==

Löscht alle Rechte-Definitionen im betreffenden Kommando.

(Wird in der Praxis selten benötigt, weil Kommandos mit leerer Rechte-Definition starten.)

'''Parameter'''

(keine)

'''Beispiel'''

#rights_clear

==$USERID()==

Die ID des angemeldeten Users

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec kusr=$USERID()

==$RIGHTUSERID()==

Administratoren können andere User einstellen (Userliste links unten im BAF-Client), vor allem um deren Rechte zu prüfen. Die UserID dieses ausgewählten Users kann mit der Funktion $RIGHTUSERID() ermittelt werden.

In fast allen Fällen gilt der folgende Grundsatz: Lesende Operationen mit $RIGHTUSERID(), schreibende Operationen mit $USERID().

'''Parameter'''

(keine)

'''Beispiel'''

#sql_open kusr=$RIGHTUSERID()

==$ADM()==

Gibt den ersten Parameter (oder Y) zurück, wenn der angemeldete User Administrator-Rechte hat, andernfalls den zweiten Parameter (oder N).

'''Parameter'''

# Wert, der zurückgegeben wird, wenn der angemeldete User Administrator-Rechte hat; sofern kein Wert angegeben ist, Y
# Wert, der zurückgegeben wird, wenn der angemeldete User keine Administrator-Rechte hat; sofern kein Wert angegeben ist, N

(keine)

'''Beispiel'''

~ $ADM()

==$RADM()==

Gibt den ersten Parameter (oder Y) zurück, wenn der ausgewählte User Administrator-Rechte hat, andernfalls den zweiten Parameter (oder N).

'''Parameter'''

# Wert, der zurückgegeben wird, wenn der ausgewählte User Administrator-Rechte hat; sofern kein Wert angegeben ist, Y
# Wert, der zurückgegeben wird, wenn der ausgewählte User keine Administrator-Rechte hat; sofern kein Wert angegeben ist, N

'''Beispiel'''

~ $RADM()

=Ausführen=

==#exec==

Führt ein anderes Kommando aus

'''Parameter'''

* cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
* cmd ("command") - Names des (Primär- oder Sub-) Kommandos, das ausgeführt werden soll.
* ex ("exception") - Name oder Nummer des Kommandos, das ausgeführt wird, wenn bei der Ausführung von cmd eine Exception auftritt; siehe Beispiele
* fin ("finally") - Name oder Nummer des Kommandos, das nach der Ausführung von cmd ausgeführt wird - egal ob eine Exception aufgetreten ist oder nicht. Wird nur berücksichtigt, wenn der Parameter ex nicht gesetzt ist.

'''Beispiele'''

#exec cmd="xtodo_page_add(XU,$PVAL(vl,user_user_id),$PVAL(vl,login),$PVAL(vl,shortname)$CHR(crlf)$PVAL(vl,firstname) $PVAL(vl,lastname))"

Das folgende Beispiel löst das Problem, dass ein neues PDF unter demselben Dateinamen nicht erstellt werden kann, wenn beim vorherigen Versuche der Erstellung eine Exception aufgetreten ist. In einem solchen Fall wurde ein #pdf_start, aber kein #pdf_stop ausgeführt, und die geöffnete Datei sperrt diesen Dateiname, bis der BAF-Client geschlossen wird. Lösung dieses Problems ist es, im Parameter ex ein #pdf stop auszuführen; auf das Öffnen der Datei kann in einem solchen Fall verzichtet werden. Mit der Funktion $DATA() wird hier im Beispiel gezielt eine Exception ausgelöst.

#frm c="c_test_pdf" y=console

#cmd_clear
#cmd #pdf_text c="Hello World"
-- #cmd #pdf_text c="Hello World $DATA(dat,test)"
#cmd #pdf_stop o=Y

#pdf_start fn=$DIR(doc)\test.pdf
#exec cmd=1 ex="#pdf_stop o=N"

#cout c="c_test_pdf executed"

==#exec_async==

Führt ein anderes Kommando aus, allerdings asynchron (über einen Timer). Das wird beispielsweise dann benötigt, wenn mit einem chg-Parameter eines Grid oder eine VL-Segmentes die Seite neu aufgebaut wird. Würde hier mit #exec gearbeitet, würde nach dem Aufbau der Seite die Ausführung die diesem Segment zurückkehren, das es aber zu diesem Zeitpunkt gar nicht mehr gibt. Mit #exec_async tritt dieses Problem nicht auf.

'''Parameter'''

Die Parameter sind dieselben wie bei #exec

==#batchexec==

Speichert den Text n in der Datei batch.bat und führt diese aus.

'''Parameter'''

* clr ("clear") - Wenn Y, wird der Text nach Ausführung des Batch-Datei gelöscht; Default Y; Funktionen werden ersetzt;
* n ("number") - Nummer des Textes; der mit #text gespeicherte Text hat die Nummer 1

'''Beispiel'''

#batchexec n=1

==#file_open==

Öffnet eine Datei (oder auch eine Webseite)

'''Parameter'''

* fn ("FileName") - Name der Datei oder die URL der Webseite

'''Beispiel'''

#file_open fn=c:\temp\test.csv
#file_open fn=https://www.google.de

==#loop==

BAL kennt keine Schleifen als Sprachelement. Um Schleifen mit einer fest Schleifenzahl auszuführen, wird die Prozedur #loop verwendet. lf muss nicht kleiner als lt sein, #loop kann auch von oben nach unten zählen.

'''Parameter'''

* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* lf ("loop from") - Anfangswert der Schleifenvariable; Funktionen werden ersetzt.
* lt ("loop to") - Endwert der Schleifenvariable; Funktionen werden ersetzt.
* n ("name") - Name der Variablen, in der die Schleifenvariable gespeichert wird (damit sie an anderer Stelle gelesen werden kann); Funktionen werden ersetzt.

'''Beispiel'''

#loop lf=42 lt=1337 er=test_line

==#exit==

Die Prozedur #exit bricht die Ausführung auf der jeweiligen Code-Ebene (Kommando bzw. Sub-Kommando) ab

'''Parameter'''

(keine)

'''Beispiel'''

#page ras=Y

...

~ $EMPTY($PVAL(vl,id)) and $PVAL(vl,status) > 20
#sql select nextval('ausza_id') as id
#sql_openval f_id=1
#page_val i=vl f=id z=$VAL(1)
#save
#exit

~~

...

Der Beispiel-Code befindet sich auf der Seite xausza_page_ausza und baut die entsprechende Seite auf. Er prüft, ob bereits eine ID-Gesetzt ist - wenn nicht, wird über eine Datenbank-Sequenz die nächste ID abgefragt, in das VL-Segment geschrieben und die Seite gespeichert. Beim Speichern der Seite wird sie jedoch neu aufgerufen, also komplett neu aufgebaut, was erst einmal kein Problem ist. Danach würde aber die Ausführung auf der Code-Ebene, auf der sich #save befindet, fortgeführt, was zur Folge hat, dass die dann folgenden Segmente doppelt erscheinen (zunächst die aus dem Neu-Aufbau der Seite, dann die, die von der Fortsetzung des Codes her stammen).

Um dies zu vermeiden muss die Ausführung des Codes nach #save abgebrochen werden.

==$EXEC==

Führt ein Kommando. Im ausgeführten Kommando kann eine Variable gesetzt werden, die dann als Funktionsergebnis von $EXEC zurückgegeben wird.

'''Parameter'''

# Kommando, das ausgeführt werden soll
# optional: Der Name der Variablen, in der das Ergebnis steht; default ist ''result''

'''Beispiel'''

#frm c="test_funkexec" y=console
#cout c=$EXEC(test_funkexec_line)

-- test_funkexec_line
#var_set n=result z=42

=Dateien und Verzeichnisse=

==#file_op==

Führt eine Operation mit einer Datei oder einem Verzeichnis aus

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Name der Datei oder des Verzeichnisses
* n - Name der Variable oder Nummer des Values, in die/den das Ergebnis der Operation (Y oder N) geschrieben wird.
* on ("old name) - der bisherige Dateiname bei RenameFile
* y - Typ der Operation
** cd / createdir - Erzeugt ein Verzeichnis
** cf / copyfile - Kopiert eine Datei (von on zu fn)
** dac / deleteaftercopy - wenn sowohl die mit fn als auch die mit on spezifizierte Datei existiert, wird die mit on spezifizierte Datei gelöscht und das Kommando gibt Y zurück.
** df / deletefile - Löscht eine Datei
** fd / forcedirectories - Stellt sicher, dass ein Pfad vorhanden ist
** rd / removedir - Entfernt ein Verzeichnis
** rf / renamefile - Benennt eine Datei um, kann auch dazu verwendet werden, eine Datei zu verschieben

'''Beispiele'''

#file_op y=renamefile on=c:\temp\debug.txt fn=c:\temp\test\debug.txt n=1
#cout c=$VAL(1)

#file_op y=fd fn=c:\eins\zwei\drei\vier

==#file_search==

Sucht Dateien und schreibt die Ergebnisliste in einen Text.

'''Parameter'''

* all - wenn Y, dann werden nach dem Dateinamen auch noch das Dateidatum, die Größe und die Attribute in den Text geschrieben. Default N, Funktionen werden ersetzt
* clr - ("clear") wenn Y, wird der Text vor der Suche geleert. Default Y, Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Suchstring, siehe Beispiel; Funktionen werden ersetzt
* n ("number") - Nummer des Textes, in den die Ergebnisliste geschrieben wird; default 1, Funktionen werden ersetzt.
* y - Typ der Suche. Default AnyFile, Funktionen werden ersetzt
** AnyFile
** ReadOnly
** Hidden
** SysFile
** VolumeID
** Directory
** Archive

'''Beispiel'''

#file_search fn=c:\*.ini n=1 y=0 all_=Y
#coutl $TEXT(1)

==#file_wait==

Wartet, bis zumindest eine Datei vorhanden ist, die den Kriterien entspricht, und führt dann cmd aus. Wird nach der in to eingestellten Zeit keine Datei gefunden, dann wird mit dem in cmdto eingestellten Kommando abgebrochen.

'''Parameter'''

* all - wenn Y, dann werden nach dem Dateinamen auch noch das Dateidatum, die Größe und die Attribute in den Text geschrieben. Default N, Funktionen werden ersetzt
* cmd - Kommando, das ausgeführt wird, sobald eine Datei gefunden wird; Funktionen werden ersetzt
* cmdto - Kommando, das ausgeführt wird, sobald die Prozedur wegen eines TimeOuts abgebrochen wird; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Suchstring, siehe Beispiel; Funktionen werden ersetzt
* sleep - Zeit in ms zwischen den einzelnen Suchen nach einer Datei, die den Kriterien entspricht; Default 1000, Funktionen werden ersetzt
* to ("TimeOut") - Zeit in ms, nach der die Ausführung abgebrochen wird; Default 15000, Funktionen werden ersetzt
* y - Typ der Suche. Default AnyFile, Funktionen werden ersetzt
** AnyFile
** ReadOnly
** Hidden
** SysFile
** VolumeID
** Directory
** Archive

'''Beispiel'''

#cmd_clear #cout c="Gefunden"
#cmd_clear2 #cout c="TimeOut"

#file_wait fn=C:\temp\test\*.txt cmd=1 cmdto=2

==#dir_force==

Stellt sicher, dass es den spezifizierten Verzeichnispfad gibt, indem erforderlichenfalls Verzeichnisse angelegt werden.

'''Parameter'''

* n ("name") - Names des Pfads

'''Beispiel'''

#dir_force n=c:\temp\pdf

==#dir_proc==

Durchsucht ein Verzeichnis nach Dateien, die den angegebenen Kriterien entsprechen, und führt für jede gefundene Datei ''cmd'' aus.

'''Parameter'''

* cmd ("command") - Kommando, das für jede gefundene Datei ausgeführt wird
* dn ("DirectoryName") - Pfad des Verzeichnisses, in dem die Dateien gesucht werden; Funktionen werden ersetzt.
* done - Verzeichnis, in das die Dateien nach Abarbeitung verschoben werden (sofern der Parameter nicht leer ist). Funktionen werden ersetzt.
* error- Verzeichnis, in das die Dateien nach Abarbeitung verschoben werden (sofern der Parameter nicht leer ist), wenn der Inhalte der unter ndone angegebenen Variablen E ist. Funktionen werden ersetzt.
* fn ("filename") - Suchkriterium für den Dateinamen; Funktionen werden ersetzt; Default *
* n ("name") - Name der Variablen, in welcher der Dateiname der aktuell zu bearbeitenden Datei inklusive Pfad gespeichert wird; Funktionen werden ersetzt; Default dir_proc
* ndone("name done") - Name der Variablen, die bestimmt, ob eine Datei in das Done-Verzeichnis verschoben wird. Vor jedem Aufruf von cmd wird diese Variable auf 'Y' gesetzt. Sie kann während der Bearbeitung auf N gesetzt werden - damit wird verhindert, dass die Datei in das Done-Verzeichnis verschoben wird. Wir die Variable auf E gesetzt, wird die Datei ins Error-Verzeichnis verschoben.

'''Beispiel'''

#dir_proc dn=c:\temp\in done=c:\temp\done fn=*.csv cmd=importcsv_line

==$FILEINFO()==

Liefert Infos über eine Datei

'''Parameter'''

# Dateiname
# Typ der Information, es stehen dabei folgende Optionen zur Verfügung
#* size - Dateigröße in Byte
#* size_point - Dateigröße in Byte, Punkte alle drei Zeichen von rechts
#* size_auto - Dateigröße in Byte, kB, MB oder GB, je nach Größe; mit Einheit
#* size_kb - Dateigröße in kB (analog Windows-Explorer)
#* date - Datum im Format dd.mm.yyyy
#* date_yyyy - Datum im Format yyyymmdd
#* datetime - Datum und Uhrzeit im Format dd.mm.yyyy hh:mm:ss
#* datetime_yyyy - Datum im Format yyyymmddhhmmss
#* exists - Y, wenn die Datei existiert, sonst N

'''Beispiel'''

#var_set n=fn z="T:\Tools Gruppenrechte\BC3 light\BafClientFM.exe"
#coutl $FILEINFO($VAR(fn),size)
#coutl $FILEINFO($VAR(fn),size_point)
#coutl $FILEINFO($VAR(fn),size_auto)
#coutl $FILEINFO($VAR(fn),size_kb)
#coutl $FILEINFO($VAR(fn),date)
#coutl $FILEINFO($VAR(fn),date_yyyy)
#coutl $FILEINFO($VAR(fn),datetime)
#coutl $FILEINFO($VAR(fn),datetime_yyyy)
#coutl $FILEINFO($VAR(fn),exists)

Ergebnis

27668480
27.668.480
26,39 MB
27.020 kB
02.05.2023
20230502
02.05.2023 12:20:09
20230502122009
Y

==$DIR()==

Ermittelt einen Verzeichnisnamen. Trailing Path Delimiter (\ bei Windows) wird immer angehängt.

'''Parameter'''

# Bezeichnung des Verzeichnisses
## appdata - Verzeichnis für Anwendungsdaten des Users
## cappdata - gemeinsames Verzeichnis für Anwendungsdaten aller User
## cdoc - gemeinsames Dokumentenverzeichnis aller User
## cfav / cfavorites - gemeinsames Favoritenverzeichnis aller User
## cmusic - gemeinsames Musikverzeichnis aller User
## cpic / cpictures - gemeinsames Bilderverzeichnis aller User
## cvideo - gemeinsames Videoverzeichnis aller User
## desktop - Desktopverzeichnis des Rechners
## '''doc''' / docdir - Dokumentenverzeichnis des Users
## downloads - Downloadsverzeichnis des Users
## fav / favorites - Favoritenverzeichnis des Users
## fonts - Fontsverzeichnis des Rechners
## music - Musikverzeichnis des Users
## pic / pictures - Bilderverzeichnis des Users
## prog / program - Programmverzeichnis des Rechners
## prog86 / program86 - Programm86-Verzeichnis des Rechners
## '''root''' - Root-Verzeichnis des BAF-Clients bzw. des BAF-Servers
## '''userroot''' / usrroot - User-Verzeichnis des BAF-Clients
## video - Videoverzeichnis des Users

'''Beispiel'''

#text_save fn=$DIR(doc)test.txt

==$FILEDIALOG()==

Führt einen Dateiauswahl-Dialog aus und gibt den gewählten Dateinamen zurück. Im Falle des Abbruchs wird ''abort'' zurück gegeben.

'''Parameter'''

# Wenn der erste Parameter ''save'' lautet, wird ein Speichern-Dialog, sonst ein Öffnen-Dialog aufgerufen.
# Filter-Statement, immer Kombinationen aus Text (Text-Dateien *.txt) und Filter-Statement(*.txt), getrennt durch Pipes.
# Standard-Dateierweiterung

'''Beispiel'''

#text_save fn="$FILEDIALOG(save,Text-Dateien *.txt|*.txt|Alle Dateien *.*|*.*,txt)"

(Bitte beachten: Wegen der Leerzeichen im Filter-Statement muss der ganze Parameter in doppelte Anführungszeichen gesetzt werden.)

=ZIP=

==#zip_create==

Erzeugt eine ZIP-Datei

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Dateien, die der ZIP-Datei hinzugefügt werden; Funktionen werden ersetzt
* dir ("directory") - Verzeichnis, wenn das nicht bei allen fn1, fn2... angegeben werden soll
* fn ("FileName") - Der Dateiname, unter dem die ZIP-Datei gespeichert wird; Funktionen werden ersetzt
* fn1, fn2,... ("FileName") - Die Dateien, die in der ZIP-Datei gespeichert werden; die Anzahl wird mit dem Parameter cnt bestimmt; Funktionen werden ersetzt
* list - Nummer eines Textes (#text, #text2...), in dem die Dateien gelistet sind, die der ZIP-Datei hinzugefügt werden sollen. Wenn list ein Wert größer 0 hat, werden cnt und fn1, fn2... ignoriert. Default 0, Funktionen werden ersetzt.
* pw ("PassWord") - Password der erzeugten ZIP-Datei; Funktionen werden ersetzt.
* pwc ("PassWordCrypted") - Wenn Y, dann ist das Passwort mit der Verschlüsselungsfunktion auf der Seite Tools des Code-Dialogs verschlüsselt. Hinweis: Mit dieser Verschlüsselung verhindert man lediglich, dass das Passwort direkt aus dem Code ausgelesen werden kann. Wird der BAF-Client mit dem Delphi-Debugger ausgeführt, lässt sich leicht an die betreffende Stelle ein Breakpoint setzen und das Passwort dann im Klartext auslesen (dieselbe Unit uBafCrypt vorausgesetzt).

'''Beispiele'''
#zip_create fn=$VAR(root).zip list=1

#var_set n=fn_zip z=tt_mail_$VAR(reise)-$VAR(reisename)_$PAD($VAR(lfdnr),4,L,0)_$NOWFMT(yyyymmdd).zip
#file_op y=df fn=$VAR(path)\$VAR(fn_zip)
#code cnt=2
#code fn1=$VAR(filename).txt
#code fn2=$VAR(filename).sab
#zip_create dir=$VAR(path) fn=$VAR(path)\$VAR(fn_zip) pw=$VAR(pw) $CODE$

Die Prozedur #zip_create ersetzt nicht vorherige Dateien. Von daher im Zweifelsfall wie im zweiten Beispiel vorher eine Datei dieses Namens löschen.

=Ini-Dateien=

Der BAF-Client verwendet eine Ini-Datei im Root-Verzeichnis (vor allem für die Datenbankverbindungen) und eine Ini-Datei ''BafClientFM.ini'' im User-Anwendungsverzeichnis (vor allem für die Formularpositionen). Es können aber auch weitere Ini-Dateien verwendet werden.

==#ini_val==

Schreibt einen Wert in die Ini-Datei. #ini_val ist eine nummerierte Prozedur: #ini_val schreibt in die erste Ini-Datei, #ini_val2 in die zweite Ini-Datei und so weiter. Diese Ini-Dateien werden zunächst nur im Speicher gehalten und müssen explizit aus einer Datei geladen oder in eine Datei gespeichert werden.

'''Parameter'''

* i ("item" / "ident") - Name des Eintrags in der Ini-Datei; Funktionen werden ersetzt
* n ("name") - Wenn der Parameter n den Wert ''usr'' oder ''user'' hat, dann bleibt die Nummer der Ini-Datei unberücksichtigt und der Wert wird in die Datei ''BafClientFM.ini'' im im User-Anwendungsverzeichnis geschrieben.
* sec ("section") - Abschnitt in der Ini-Datei; Funktionen werden ersetzt; default ''values''
* z - Wert, der in die Ini-Datei geschrieben wird; Funktionen werden ersetzt.

'''Beispiel'''

#ini_val i=date_last z=$NOW()

==#ini_load==

Lädt eine Ini-Datei aus einer Datei. Es handelt sich um eine nummerierte Prozedur: #ini_load lädt die Ini-Datei 1, #ini_load2 lädt die Ini-Datei 2 und so weiter.

'''Parameter'''

* fn ("FileName") - Dateiname der Datei, die geladen wird

'''Beispiel'''

#ini_load fn=$DIR(userroot)werte.ini

==#ini_save==

Speichert eine Ini-Datei ineine Datei. Es handelt sich um eine nummerierte Prozedur: #ini_save speichert die Ini-Datei 1, #ini_save2 speichert die Ini-Datei 2 und so weiter.

'''Parameter'''

* fn ("FileName") - Dateiname der Datei, in die gespeichert wird

'''Beispiel'''

#ini_save fn=$DIR(userroot)werte.ini

==$INI()==

Liest einen Wert aus einer Ini-Datei.

'''Parameter'''

# Nummer der Ini-Datei, alternativ ''usr'' oder ''root''
# Item (Ident)
# optional: Sektion; wenn nicht vorhanden, dann ''values''. Wenn ''db!'', dann wird als Sektion die aktuell gewählte Datenbankverbindung verwendet (in diesem Fall sollte als erster Parameter ''root'' verwendet werden).
# optional: Default-Wert; wenn nicht vorhanden, dann ein leerer String

'''Beispiele'''

#var_set n=datum z=$INI(1,datum)
#var_set n=datum z=$INI(1,datum,bearbeitung,$TODAY())

==$INITEXT()==

Gibt die komplette Ini-Datei zurück. Wird vor allem beim Debugging verwendet.

'''Parameter'''

# Nummer der Ini-Datei, alternativ ''usr'' oder ''root''

'''Beispiel'''

#coutl $INITEXT(usr)

=Zwischenablage=

Das BAF-Framework unterstützt die Zwischenablage nur für Text.

==#clipboard==

Schreibt einen Text in die Zwischenablage

'''Parameter'''

* z - Wert, der in der Zwischenablage gespeichert werden soll; Funktionen werden ersetzt

'''Beispiele'''

#clipboard z=$TEXT()
#clipboard z=$CHR(dquote)$PVAL(test,zahl,allsel,$CHR(crlf))$CHR(dquote)

==$CLIPBOARD()==

Gibt den Text aus der Zwischenablage zurück.

'''Parameter'''

(keine)

'''Beispiel'''

#setvar n=clp z=$CLIPBOARD()

=String-Funktionen=

Die folgenden Funktionen geben einen String zurück.

==$BASE64()==

En- oder Decodiert einen Text im Base64-Code

'''Parameter'''

# Encoding oder Decoding:
## e - Encoding
## d - Decoding
# Text, der en-oder decodet werden soll.

'''Beispiel'''

#coutl $BASE64(e,Dies ist ein Test)

==$CHR()==

Gibt ein Zeichen (ggf zwei Zeichen) zurück

'''Parameter'''

# Ansi-Zeichennummer oder eine der folgenden Bezeichnungen:
## crlf - Zeilenumbruch #13#10
## cr - Zeichen #13
## lf - Zeichen #10
## tab - Tabulator
## quote - ' (einfache Anführungszeichen)
## dquote - " (doppelte Anführungszeichen)
## space / leer - Leerzeichen
## comma / komma - , (Komma)
## questionmark / qmark / frage / fragezeichen - ?
## bro / bracket_open - (
## brc / bracket_close - )
## dollar - $

'''Beispiel'''

#exec cmd="xtodo_page_add(XU,$PVAL(vl,user_user_id),$PVAL(vl,login),$PVAL(vl,shortname)$CHR(crlf)$PVAL(vl,firstname) $PVAL(vl,lastname))"

==$CONVERT()==

Konvertiert einen String.

'''Parameter'''

# Konvertierungsfunktion
## isodate
## isodatetime
## truefalse
## pointfloat
## urlcode
## utf8
# String, der konvertiert werden soll

'''Beispiel'''

#coutl $CONVERT(isodate,2025-03-12)
#coutl $CONVERT(isodatetime,2025-03-12 12:03:17)
#coutl $CONVERT(truefalse,true)
#coutl $CONVERT(pointfloat,12.3)
#coutl $CONVERT(urlcode,Für schönen Ärger)
#coutl $CONVERT(utf8,Für schönen Ärger)

(Ergebnis)
12.03.2025
12.03.2025 12:03:17
Y
12,3
F%C3%BCr%20sch%C3%B6nen%20%C3%84rger
Für schönen Ärger

==$COPY()==

Kopiert aus dem String im ersten Parameter einen Teil der Zeichen.

'''Parameter'''

# String, aus dem kopiert werden soll
# Position im String, ab dem Zeichen kopiert werden sollen
# optional: Anzahl der Zeichen, die kopiert werden sollen. Wenn dieser Parameter fehlt, werden alle Zeichen ab der angegebenen Position kopiert.

'''Beispiel'''

#grdcol f=ref c1="Ref" w=30 y=link ro=Y cmdn=xtodo_add(link,$COPY($PVAL(grid,ctype,sel),1,2))

==$EXEC()==

Führt ein Kommando aus und gibt ein Funktionsergebnis zurück.

'''Parameter'''

# Kommando, das ausgeführt werden soll.
# optional: Name der Variable, die als Funktionsergebnis zurück gegeben werden soll; default ''result''

'''Beispiel'''

#val_set n=test z=$EXEC(testkommando)

==$GUID()==

Erzeugt eine GUID und gibt sie zurück.

'''Parameter'''

# optional: Name einer Variablen, in welcher die GUID zusätzlich gespeichert wird.

'''Beispiel'''

#sql_exec kid=$GUID()

==$HASH()==

Erzeugt einen Hash-Wert vom String im ersten Parameter.

'''Parameter'''

# String, von welchem der Hash gebildet werden soll.
# zu verwendender Hash-Algorithmus:
## sha512
## sha512_256
## sha512_224
## sha384
## sha256
## sha224
## sha1
## md5 (Hinweis: MD5 gilt seit Längerem als nicht mehr sicher. Verwenden Sie ihn nur, wenn dies aus Gründen der Abwärts-Kompatbilität zwingend ist.)

'''Beispiel'''

#page_val i=vl col=1 row=3 z=$HASH($PVAL(vl,1,2),sha512)

==$INCLUDE()==

Stellt sicher, dass der als dritter Parameter übergebene Text am Anfang oder am Ende steht, gegebenenfalls wird er dort eingefügt.

'''Parameter'''

# Typ der Operation
## lead(oder leading) - Text muss am Anfang stehen
## leadci(oder leadingci oder leadingcaseinsensitive) - Text muss am Anfang stehen, Groß- und Kleinschreibung wird ignoriert
## trail(oder trailing) - Text muss am Ende stehen
## trailci(oder trailci oder trailingcaseinsensitive) - Text muss am Ende stehen, Groß- und Kleinschreibung wird ignoriert
# Text, in den gegebenenfalls eingefügt wird
# Text, der gegebenenfalls eingefügt wird

'''Beispiel'''

#cout c=$INCLUDE(trailci,test.PDF,.pdf)

==$INVLOOKUP()==

Ermittelt den Key aus einer Nachschlageliste bei Übergabe des Values.

'''Parameter'''

# Name der Nachschlageliste
# Value des Eintrags
# Default-Wert; wird verwendet, wenn der Rückgabe-Wert leer ist

'''Beispiel'''

#cout c="$INVLOOKUP(general_status,aktiv,Wert nicht vorhanden)"

==$LOOKUP()==

Ermittelt einen Wert aus einer Nachschlageliste.

'''Parameter'''

# Name der Nachschlageliste
# Key des Eintrags
# Default-Wert; wird verwendet, wenn der Rückgabe-Wert leer ist

'''Beispiel'''

#cout c="$LOOKUP(general_status,1,Status nicht gesetzt)"

==$LOW()==

Wandelt den übergebenen String in Kleinbuchstaben um.

'''Parameter'''

# String, der in Kleinbuchstaben gewandelt werden soll.

'''Beispiel'''

~ $LOW($EDT(edt1)) = bus

==$LOWNOSPACE()==

Wandelt einen String in Kleinbuchstaben und ersetzt alle Leerzeichen durch Unterstriche.

'''Parameter'''

# String, der gewandelt werden soll

'''Beispiel'''

#page_val i=vl col=1 row=3 z=$LOWNOSPACE($PVAL(vl,1,2))

==$NOCRLF()==

Entfernt Zeilenumbrüche

'''Parameter'''

# String, aus dem die Zeilenumbrüche entfernt werden sollen
# optional: Zeichenfolge, die an Stelle der Zeilenumbrüche eingefügt werden sollen

'''Beispiel'''

#val_set n=2 z=$NOCRLF($VAL(1),;)

==$NVL()==

Liefert einen Ersatzwert, wenn der Wert leer ist.

'''Parameter'''

# String, der als Funktionsergebnis zurückgegeben wird
# String, der als Funktionsergebnis zurückgegeben wird, wenn der erste Parameter leer ist

'''Beispiel'''

sql where ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)

Liefert $PVAL einen leeren Wert zurück (z.B., weil die Gridzeile neu angelegt wurde und daher noch keine Nummer eingetragen ist), so wird statt dessen 0 verwendet, damit die WHERE-Klausel syntaktisch korrekt ist.

==$ONLYCHAR()==

Entfernt unerwünschte Zeichen aus einem String.

'''Parameter'''

# Der ursprüngliche String
# optional: Typ der Funktion
## (leer) - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben (['a'..'z', 'A'..'Z', 'ä', 'ö', 'ü', 'Ä','Ö', 'Ü', 'ß']) sind
## charnum - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind
## low - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Kleinbuchstaben
## upp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Großbuchstaben
## charnumlow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Kleinbuchstaben
## charnumupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Großbuchstaben
## uml - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben (['a'..'z', 'A'..'Z') sind, Umlaute werden konvertiert (ä -> ae, ö -> oe, ü -> ue, Ä -> Ae, Ö -> Oe, Ü -> Ue, ß -> ss)
## umlcharnum - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Umlaute werden konvertiert
## umllow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Kleinbuchstaben, Umlaute werden konvertiert
## umlupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Großbuchstaben, Umlaute werden konvertiert
## umlcharnumlow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Kleinbuchstaben, Umlaute werden konvertiert
## umlcharnumupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Großbuchstaben, Umlaute werden konvertiert
## no191 / not191 - Es werden alle Zeichen mit der ANSI-Nummer 191 (¿) entfernt

'''Beispiele'''

#coutl $ONLYCHAR(Baden-Württemberg)
#coutl $ONLYCHAR(Baden-Württemberg,umllow)

==$PAD()==

Füllt links oder rechts bis zur vorgegebenen Länge mit Zeichen auf.

'''Parameter'''

# Der ursprüngliche String
# Soll-Länge. Ist der ursprüngliche String bereits länger, wird er nicht gekürzt, es werden aber auch keine weiteren Zeichen hinzugefügt
# Wenn L, werden die Zeichen vorne hinzugefügt, andernfalls hinten
# Zeichen, die soweit und so oft hinzugefügt werden, bis die Soll-Länge erreicht ist. Umfasst der Parameter mehrere Zeichen, werden diese ggf. nicht alle hinzugefügt.
# optional: Länge, auf die der ursprüngliche String vor der weiteren Verarbeitung gekürzt wird.

'''Beispiel'''

sql text1 = '$PAD($VAR(text1),70,R, )'

==$RANDOM()==

Ermittelt einen zufälligen Wert

'''Parameter'''

# Typ des Ergebnisses
## curr - Zahl mit zwei Nachkommastellen in den Grenzen Parameter 2 - Parameter 3
## curr4 - Zahl mit vier Nachkommastellen in den Grenzen Parameter 2 - Parameter 3
## date - Datum in den Grenzen Parameter 2 - Parameter 3
## int - ganze Zahl in den Grenzen Parameter 2 - Parameter 3
## ld - Key einer Nachschlageliste, Name der Nachschlageliste im Parameter 2
## ldv - Value einer Nachschlageliste, Name der Nachschlageliste im Parameter 2
## ls - Key eines Specials, Name des Specials im Parameter 2
## lsv - Value eines Specials, Name des Specials im Parameter 2
## text, text2, text3... - Zeile eines Textes
# untere Grenze bzw. Name der Nachschlageliste oder des Specials
# obere Grenze

'''Beispiel'''

#coutl $RANDOM(date,01.01.2022,31.12.2022)
#coutl $RANDOM(text2)

==$SUBSTR()==

Kopiert aus dem String im ersten Parameter einen Teil der Zeichen.

(Hinweis: Selbe Funktionalität wie $COPY())

'''Parameter'''

# String, aus dem kopiert werden soll
# Position im String, ab dem Zeichen kopiert werden sollen
# optional: Anzahl der Zeichen, die kopiert werden sollen. Wenn dieser Parameter fehlt, werden alle Zeichen ab der angegebenen Position kopiert.

'''Beispiel'''

#grdcol f=ref c1="Ref" w=30 y=link ro=Y cmdn=xtodo_add(link,$SUBSTR($PVAL(grid,ctype,sel),1,2))

==$STREP()==

("string replace") Ersetzt Zeichen im String durch andere Zeichen.

'''Parameter'''

# String, in welchen Zeichen ersetzt werden sollen.
# Zeichen, die ersetzt werden sollen
# Zeichen, die an deren Stelle treten sollen
# optional: Optionen (kombinierbar)
## i - Groß- und Kleinschreibung ignorieren
## a - Alle Vorkommen ersetzen (andernfalls wird nur das erste Vorkommen ersetzt)

'''Beispiele'''

#page_val i=vl col=1 row=3 z="$STREP($PVAL(vl,1,2), ,_,a)"
#page_val i=vl col=1 row=3 z=$STREP($PVAL(vl,1,2),$CHR(space),_,a)

Hinweis: Beide Beispiele haben exakt dieselbe Funktion. Im oberen Beispiel steht das Leerzeichen direkt im Text, dafür muss der komplette Parameter in doppelte Anführungszeichen, im unteren Beispiel wird das Leerzeichen durch $CHR(space) eingefügt, dafür können die Leerzeichen unterbleiben.

==$STROP()==

("string operation") Sammelsurium von String-Operationen

'''Parameter'''

# Typ der Operation
## trim - entfernt führende und folgende Leerzeichen
## trimleft - entfernt führende Leerzeichen
## trimright - entferne folgende Leerzeichen
## quote - setzt den String in einfache Anführungszeichen
## unquote - entfernt einschließende einfache Anführungszeichen
## dquote - setzt den String in doppelte Anführungszeichen
## unqduote - entfernt einschließende doppelte Anführungszeichen
## ex_filepath - entspricht der Delphi-Funktion ExtractFilePath
## ex_filedir - entspricht der Delphi-Funktion ExtractFileDir
## ex_filedrive - entspricht der Delphi-Funktion ExtractFileDrive
## ex_filename - entspricht der Delphi-Funktion ExtractFileName
## ex_fileext - entspricht der Delphi-Funktion ExtractFileExt
# String, der bearbeitet werden soll

'''Beispiele'''

#cout c=$STROP(quote,Test)

==$STREXTR()==

("string extract") Extrahiert einen Teil aus einem String.

'''Parameter'''

# String, aus dem extrahiert werden soll
# Extraktionstyp
## ffe ("from first exclude") - Extrahiert ab der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## ffi ("from first include") - Extrahiert ab der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## tfe ("to first exclude") - Extrahiert bis zur Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## tfi ("to first include") - Extrahiert bis zur Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## fle ("from last exclude") - Extrahiert ab dem letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## fli ("from last include") - Extrahiert ab dem letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## tle ("to last exclude") - Extrahiert bis zum letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## tli ("to last include") - Extrahiert bis zum letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein

# Trennzeichen

'''Beispiele'''

#cout c="$STREXTR(test;test2,ffe,;)" -- Ergebnis: test2
#cout c="$STREXTR(test;test2,ffi,;)" -- Ergebnis: ;test2
#cout c="$STREXTR(test;test2,tfe,;)" -- Ergebnis: test
#cout c="$STREXTR(test;test2,tfi,;)" -- Ergebnis: test;
#cout c="$STREXTR(test;!§§test2,tfe,;!§§)" -- Ergebnis: test

==$TRIM()==

Entfernt Leerzeichen und Zeilenumbrüche am Rand des Strings

'''Parameter'''

# String, der getrimmt werden soll
# optional
## L - trimmt nur auf der linken Seite
## R - trimmt nur auf der rechten Seite

'''Beispiel'''

#var_set n=test z=$TRIM($VAL(1),R)

==$UPP()==

Wandelt den übergebenen String in Großbuchstaben um.

'''Parameter'''

# String, der in Großbuchstaben gewandelt werden soll.

'''Beispiel'''

~ $UPP($EDT(edt1)) = BUS

==$VT()==

Die Funktion $VT ("Value Translate") ersetzt Werte durch andere. Groß- und Kleinschreibung wird beim Vergleich berücksichtigt.

'''Parameter'''

# String, dessen Inhalte ersetzt werden soll
# Else-Ergebnis; wird dann verwendet, wenn keine andere Entsprechung erkannt wird.
# Vergleichswert 1
# Ergebnis, wenn Vergleichswert 1 dem ersten Parameter entspricht
# Vergleichswert 2
# Ergebnis, wenn Vergleichswert 2 dem ersten Parameter entspricht
# Vergleichswert 3
# Ergebnis, wenn Vergleichswert 3 dem ersten Parameter entspricht
...

'''Beispiel'''

#coutl $VT(Frau,1,Herr,2,Frau,3)
-- Frau -> 3
-- Herr -> 2
-- Test -> 1
-- Firma -> 1

==$VTRDB()==

Die Funktion $VTRDB ("Value Translate Root Database") gibt eine String zurück, der von einem Wert im Datenbank-Segment der Root-Ini abhängt. Diese Ini-Datei (BafClientFM.ini im selben Verzeichnis wie die BafClientFM.exe) enthält die Datenbank-Zugangsdaten. Diese könnte den folgenden Block (Auszug) enthalten:

[DB_PGPROD]
prefix=prod
Name=Postgres PROD
DriverName=Postgres
Database=postgres
User=ttbaf3prodadmin
...

Der Wert in ''prefix'' spezifiziert, ob es sich um das Produktiv- oder das Test-System handelt. In Abhängigkeit davon gibt diese Funktion dann unterschiedliche Werte zurück. Es wird immer die Sektion der gerade ausgewählten Datenbank verwendet.

Der Hauptanwendungsfall dieser Funktion, die Notwendigkeit einer Änderung des Codes bei der Migration vom Test- in das Produktiv-System oder umgekehrt zu vermeiden. Statt dessen ermittelt die Funktion, ob sie gerade im Test- oder Produktiv-System ausgeführt wird und gibt den passenden Wert (Verzeichnis-Name, URL, ...) zurück.

'''Parameter'''

# Item (Ident) in der Root-Ini (die Sektion ist immer die der aktuell ausgewählten Datenbank)
# Vergleichswert 1
# Ergebnis, wenn Vergleichswert 1 dem Wert in der Ini-Datei entspricht
# Vergleichswert 2
# Ergebnis, wenn Vergleichswert 2 dem Wert in der Ini-Datei entspricht
...

'''Beispiele'''

#cout c="$VTRDB(prefix,test,Test-System,prod,Produktiv-System)"
#cout c="$VTRDB(prefix,test,C:\temp\export\busdaten,prod,T:\files\export\busdaten)"

==$VTVL()==

Die Funktion $VTVL ("Value Translate ValueList") ersetzt Werte durch andere. Groß- und Kleinschreibung wird beim Vergleich berücksichtigt.

Im Gegensatz zu $VT werden die zu prüfenden Werte und deren Entsprechungen nicht über Parameter übergeben, sondern aus einer Werte-Liste geholt, die in einem Text gespeichert sein muss.

Eine solche Werte-Liste lässt sich wie folgt aufbauen

key1=value1
key2=value2
key3=value3
key4=value4
...

Eine solche Werte-Liste lässt sich auch mit #sql_opentvl erzeugen, siehe Beispiel.

'''Parameter'''

# String, dessen Inhalte ersetzt werden soll
# Else-Ergebnis; wird dann verwendet, wenn keine andere Entsprechung erkannt wird.
# Nummer des Textes, in dem sich die Werteliste befindet.
...

'''Beispiel'''

#sql select userid as ckey, shortname as cvalue from user_user
#sql_opentvl n=1
#coutl $VTVL(591,(nicht gefunden),1)

==$XR()==

Die Funktion $XR ("XmlReplace") ersetzt in XML nicht zulässige Zeichen:
* aus & wird $amp ;
* aus < wird &lt ;
* aus > wird &gt ;
* aus " wird &quot ;
* aus ' wird &apos ;

(Hinweis: Das Leerzeichen vor dem Semikolon soll verhindern, dass die Zeichen hier in der Darstellung ersetzt werden und wird nicht eingefügt.)

'''Parameter'''

# String, dessen Zeichen ggf. ersetzt werden sollen

'''Beispiel'''

#text <firmenname>$XR($DATA(dat,firmenname))</firmenname>

==$XRR()==

Umkehrfunktion von $XR()
* aus $amp ; wird &
* aus &lt ; wird <
* aus &gt ; wird >
* aus &quot ; wird "
* aus &apos ; wird '

'''Parameter'''

# String, dessen Zeichen ggf. ersetzt werden sollen

=Integer-Funktionen=

Die folgenden Funktionen geben eine ganze Zahl zurück

==$DEC()==

Verringert die Zahl im ersten Parameter.

'''Parameter'''

# Zahl die verringert werden soll.
# optional: Zahl, um die verringert werden soll. Wenn nicht vorhanden, dann 1.

'''Beispiel'''

#setval n=1 z=$DEC($VAL(1))

==$ICALC()==

Führt eine Berechnung mit ganzzahligen Werten durch.

'''Parameter'''

# Operator, es stehen zur Verfügung
## +
## -
## *
## div
## mod
# Erste Zahl
# Zweite Zahl
# optional beim Operator +: weitere Summanden

'''Beispiel'''

#cout c=$ICALC(mod,17,5)

==$INC()==

Erhöht die Zahl im ersten Parameter.

'''Parameter'''

# Zahl die erhöht werden soll.
# optional: Zahl, um die erhöht werden soll. Wenn nicht vorhanden, dann 1.

'''Beispiel'''

#setval n=1 z=$INC($VAL(1))

==$INTLEN()==

Ist der String im Parameter eine ganz Zahl, dann wird deren Länge in Zeichen zurückgegeben, andernfalls -1; ein leerer String im ersten Parameter ergibt 0.

'''Parameter'''

# Zahl, deren Länge ermittelt wird.

'''Beispiel'''

~ $INTLEN($EDT(edt1)) = 4

==$LEN()==

Ermittelt die Länge eines Strings in Zeichen.

'''Parameter'''

# String, dessen Länge ermittelt werden soll.

'''Beispiel'''

~ $LEN($EDT(edt1)) = 4

==$LEVENSHTEIN()==

Ermittelt die Levenshtein-Distanz (https://de.wikipedia.org/wiki/Levenshtein-Distanz) der beiden übergebenen Strings

'''Parameter'''

# erster String
# zweiter String

'''Beispiel'''

#coutl $LEVENSHTEIN(alpha,beta)

==$POS()==

Ermittelt die Position des Substrings in einem String. Das Funktionsergebnis ist die Position, das erste Zeichen ist 1. 0 wird zurück gegeben, wenn der Substring im String nicht vorkommt.

'''Parameter'''

# Substring (nach dem gesucht wird)
# String (in dem gesucht wird)
# optional: Wenn ic (ignore case), dann wird bei der Suche die Groß- und Kleinschreibung nicht beachtet.

'''Beispiel'''

~ $POS($EDT(edt1),$VAR(1),ic) > 0

==$RANDOM()==

Ermittelt einen zufälligen Wert zwischen der oberen und unteren Grenze

'''Parameter'''

# Typ
## int - zufällige Ganzzahl
## date - zufälliges Datum
## curr - zufällige Zahl mit zwei Nachkommastellen
## curr4 - zufällige Zahl mit vier Nachkommastellen
## text1, text2, text3... - zufällige Zeile aus dem jeweiligen Text; text ist text1; untere und obere Grenze bleiben unberücksichtigt
## ld - zufälliger Schlüssel-Wert aus einer Nachschlageliste. Der Name der Nachschlageliste ist als zweiter Parameter (untere Grenze) zu übergeben
## ldv - zufälliger Text aus einer Nachschlageliste. Der Name der Nachschlageliste ist als zweiter Parameter (untere Grenze) zu übergeben
## ls - zufälliger Schlüssel-Wert aus einem Special. Der Name des Specials ist als zweiter Parameter (untere Grenze) zu übergeben
## lsv - zufälliger Text aus einem Special. Der Name des Specials ist als zweiter Parameter (untere Grenze) zu übergeben
# untere Grenze
# obere Grenze

'''Beispiel'''

#coutl $RANDOM(int,1,6)

=Datumsfunktionen=

==$INCDATE()==

Die Funktione $INCDATE() verändert das Datum im ersten Parameter um die Anzahl Tage im zweiten Parameter.

'''Parameter'''

# Datum, das verändert werden soll
# optional: Die Tage, um die verändert werden soll; wenn leer, dann 1.

'''Beispiel'''

#cout c=$INCDATE($NOW(),-3) clr=Y

==$INT2TIME()==

Macht aus z.B. 1130 die Zeit 11:30

'''Parameter'''

# Zeit im Integer-Format

'''Beispiel'''

#sql_exec k_time=$INT2TIME($VAL(1))

==$NOW()==

Gibt das aktuelle Datum und die aktuelle Uhrzeit im Format dd.mm.yyyy hh:mm:ss zurück.

'''Parameter'''

(keine)

'''Beispiel'''

#execsql k_datechg=$NOW()

==$NOWFMT()==

Gibt das aktuelle Datum und/oder die aktuelle Uhrzeit im angegebenen Format zurück.

'''Parameter'''

# Formatierungsstring (Syntax wie FormatDateTime in Delphi)

'''Beispiel'''

#sql_exec k_datechg="$NOWFMT(yyyy-mm-dd hh:mm:ss)"

==$NOWMIN()==

Gibt das aktuelle Datum und die aktuelle Uhrzeit ohne Sekunden (also dd.mm.yyyy hh:mm) zurück

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec k_datechg=$NOWMIN()

==$TODAY()==

Gibt das aktuelle Datum im Format dd.mm.yyyy zurück.

Hinweis: Wenn das Datum in einem anderen Format benötigt wird, ist $NOWFMT() das Mittel der Wahl.

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec k_datechg=$TODAY()

==$DFMT()==

("date formated") Formatiert das übergebene Datum.

'''Parameter'''

# Datum, ggf. mit Uhrzeit, das formatiert werden soll.
# Formatierungsstring wie in Delphi
# optional: Wenn hn ("hide null"), dann wird ein leerer String zurück gegeben, wenn das Datum kleiner/gleich 1

'''Beispiel'''

#sql_exec k_datechg="$DFMT($NOW(),yyyy-mm-dd hh:mm:ss)"

=Bool'sche Funktionen=

Die folgenden Funktionen geben Y oder N zurück.

==$BFMT()==

Formatiert einen bool'schen Wert

'''Parameter'''

# Bool'scher Wert
# optional: Ergebnis, wenn Wert Y ('y', 'J', 'j', '1') ist, default Y
# optional: Ergebnis, wenn Wert N (also nicht 'Y', 'y', 'J', 'j', '1') ist, default N

'''Beispiel'''
#cout c=$BFMT($VAR(test),x,)

==$BOOL()==

Wertet das bool'sche Statement im Parameter aus.

'''Operatoren'''

* = gleich
* == gleich ohne Berücksichtigung der Groß- und Kleinschreibung
* <> ungleich
* != ungleich
* > größer
* >= größer gleich
* < kleiner
* <= kleiner gleich
* and Und-Verknüpfung
* or ODER-Verknüpfung

Hinweis: Die Statements werden von links nach rechts ausgewertet, and und or sind gleichwetig, gegebenenfalls müssen Klammern eingesetzt werden.

'''Parameter'''

# Bool'sches Statement, das ausgewertet wird

'''Beispiel'''

#cout c="$BOOL((17 > 22) or (5 > 3))"
#cout c="$BOOL(17 > 22 or 5 > 3)"

==$DATECOMP()==

Gibt Y zurück, wenn Datum 2 Operator Datum 1 zutreffend ist. Ansonsten wird N zurückgegeben.

Wird kein Operator angegeben, dann wird die Anzahl der Tage Datum 2 - Datum 1 als Zahl zurückgegeben.

'''Parameter'''

# Datum 1
# Datum 2
# Operator

'''Beispiel'''

#cout c="$DATECOMP(01.01.2024,17.04.2024,<)"
#cout c="$DATECOMP(01.01.2024,17.04.2024)"

==$DATEMINREL()==

Gibt Y zurück, wenn das Datum im ersten Parameter nicht kleiner ("minimal gleich") dem aktuellen Datum ist, das um die Anzahl Tage im zweiten Parameter verändert wurde. Wird gerne verwendet, um das Erreichen von Deadlines zu prüfen.

'''Parameter'''

# Datum, das geprüft wird
# Anzahl an Tage, die dem aktuellen Datum vor der Prüfung hinzu addiert werden

'''Beispiel'''

~ $DATEMINREL($DATA(n,datum), 3)

==$DATEMAXREL()==

Gibt Y zurück, wenn das Datum im ersten Parameter nicht größer ("maximal gleich") dem aktuellen Datum ist, das um die Anzahl Tage im zweiten Parameter verändert wurde. Wird gerne verwendet, um das Erreichen von Deadlines zu prüfen.

'''Parameter'''

# Datum, das geprüft wird
# Anzahl an Tage, die dem aktuellen Datum vor der Prüfung hinzu addiert werden

'''Beispiel'''

~ $DATEMAXREL($DATA(n,datum), 3)

==$DATEBETWEEN==

Gibt Y zurück, wenn das Datum des ersten Parameters im angegebenen Bereich liegt.

Alle Paremeter, die sich nicht in ein Datum wandeln lassen, werden zu 0 (30.12.1899) konvertiert.

'''Parameter'''

# Wert, der geprüft wird
# Untere Grenze des Bereichs
# Obere Grenze des Bereichs
# und weitere: Das Ergebnis ist auch dann Y, wenn der erste Parameter diesem Datum entspricht.

'''Beispiel'''

#cout c="Test $DATEBETWEEN($TODAY(),1.1.2020,2.2.2022)"

==$EMPTY()==

Gibt Y zurück, wenn der Parameter ein leerer String ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# String, der geprüft wird

'''Beispiel'''

~ $EMPTY($DATE(n,grpname))

==$EMPTYVAR()==

Gibt Y zurück, wenn die Variable ein leerer String ist, deren Name im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Name der Variable

'''Beispiel'''

~ $EMPTYVAR(buchungsnr)

==$IN()==

Gibt Y zurück, wenn sich der erste Parameter in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INIC() beachtet

'''Parameter'''

# Wert, der geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Die erste Anweisung gibt Y und die zweite N zurück

#cout c="$IN(beta,alpha,beta,gamma,delta)"
#cout c="$IN(beta,alpha,BETA,gamma,delta)"

==$INIC()==

Gibt Y zurück, wenn sich der erste Parameter in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $IN() nicht beachtet beachtet

'''Parameter'''

# Wert, der geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Beide Anweisungen geben Y zurück

#cout c="$INIC(beta,alpha,beta,gamma,delta)"
#cout c="$INIC(beta,alpha,BETA,gamma,delta)"

==$INVAR()==

Gibt Y zurück, wenn sich die Variable, deren Namen im ersten Parameter steht, in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INICVAR() beachtet

'''Parameter'''

# Name der Variable, die geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Die erste Anweisung gibt Y und die zweite N zurück

#var_set n=test z=beta
#cout c="$INVAR(test,alpha,beta,gamma,delta)"
#cout c="$INVAR(test,alpha,BETA,gamma,delta)"

==$INICVAR()==

Gibt Y zurück, wenn sich die Variable, deren Namen im ersten Parameter steht, in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INVAR() nicht beachtet

'''Parameter'''

# Name der Variable, die geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Beide Anweisungen geben Y zurück

#var_set n=test z=beta
#cout c="$INVAR(test,alpha,beta,gamma,delta)"
#cout c="$INVAR(test,alpha,BETA,gamma,delta)"

==$ISCURR()==

Gibt Y zurück, wenn sich der Parameter in einen Currency-Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird

'''Beispiel'''

~ $ISCURR($DATA(n,rechnungssumme))

==$ISDATE()==

Gibt Y zurück, wenn sich der Parameter in ein Datums- oder DatumsZeit-Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird
# Prüfoperation, default ist date
## date - prüft, ob in ein Datum gewandelt werden kann
## datetime - prüft, ob in ein Datums-Zeit-Wert gewandelt werden kann

'''Beispiel'''

~ $ISDATE($DATA(n,beginn))

==$ISINT()==

Gibt Y zurück, wenn sich der Parameter in einen ganzzahligen Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird

'''Beispiel'''

~ $ISINT($DATA(n,tage))

==$INTMAX()==

Gibt Y zurück, wenn die Zahl im ersten Parameter nicht größer ("maximal gleich") als die Zahl im zweiten Parameter ist.

'''Parameter'''

# Zahl, die verglichen wird
# Zahl. mit der vergleichen wird

'''Beispiel'''

~ $INTMAX($DATA(n,lfdnr), 17)

==$INTMIN()==

Gibt Y zurück, wenn die Zahl im ersten Parameter nicht kleiner ("minimal gleich") als die Zahl im zweiten Parameter ist.

'''Parameter'''

# Zahl, die verglichen wird
# Zahl. mit der vergleichen wird

'''Beispiel'''

~ $INTMIN($DATA(n,lfdnr), 17)

==$NEMPTY()==

("not empty") Gibt Y zurück, wenn der Parameter nicht leer ist.

'''Parameter'''

# String, dessen Inhalt geprüft wird. Leerzeichen gelten als leerer String.

'''Beispiel'''

~ $NEMPTY($EDT(edt1))

==$NEMPTYVAR()==

Gibt Y zurück, wenn die Variable kein leerer String ist, deren Name im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Name der Variable

'''Beispiel'''

~ $NEMPTYVAR(kundennr)

==$NOT==

Invertiert einen bool'schen Wert. Aus Y (y, J, j, 1) wird N und aus N wird Y.

'''Parameter'''

# Wert, der invertiert wird

'''Beispiel'''

#coutl $NOT(2)

==$NUMBETWEEN==

Gibt Y zurück, wenn die Zahl des ersten Parameters im angegebenen Bereich liegt.

Alle Paremeter, die sich nicht in eine Zahl wandeln lassen, werden zu 0 konvertiert.

'''Parameter'''

# Wert, der geprüft wird
# Untere Grenze des Bereichs
# Obere Grenze des Bereichs
# und weitere: Das Ergebnis ist auch dann Y, wenn der erste Parameter dieser Zahl entspricht. Siehe Beispiel.

'''Beispiele'''

#page_check c="Die Schuhgröße muss zwischen 28 und 56 liegen" chk="$NUMBETWEEN($PVAL(vl,schuhgroesse),28,56)"
#page_check c="Die Schuhgröße muss zwischen 28 und 56 liegen" chk="$NUMBETWEEN($PVAL(vl,schuhgroesse),28,56,)"

Die beiden Beispiele unterscheiden sich auf den ersten Blick kaum. Bei der ersten Zeile muss jedoch eine Schuhgröße eingegeben werden. Bleibt das Feld im VL-Segment leer, so wird dieser fehlende Wert nach 0 konvertiert und liegt nicht zwischen 28 und 56.

Anders bei der zweiten Zeile: Das Komma vor der schließenden Klammer sorgt für einen vierten Parameter, der ebenfalls leer ist und damit nach 0 gewandelt wird. Auf diese Weise werden die leere Eingaben (und die Eingabe von 0) gültig.

==$REGEX()==

Die Funktion $REGEX() ("regular expressions") prüft, ob der String in Parameter 1 den Anforderungen von Parameter 2 entspricht (Ergebnis Y) oder nicht (Ergebnis N).

'''Parameter'''

# String, der geprüft werden soll
# Regulärer Ausdruck, mit dem der String in Parameter 2 geprüft wird.

'''Beispiel'''

~ $REGEX($VAR(med),^[A-Z]{3}$)

==$TEXT_HASLINE()==

Die Funktion $TEXT_HASLINE() prüft, ob die als Parameter 2 übergebene Textzeile in einem Text vorkommt. Es wird nur auf komplette Textzeilen geprüft. Wird zum Beispiel verwendet, um eine Liste von Kundennummern zu erstellen, und dann auf einzelne Nummern zu prüfen.

'''Parameter'''

# Nummer des Textes
# Textzeile, deren Vorkommen geprüft wird
# Ergebnis, wenn die Textzeile vorkommt; default Y
# Ergebnis, wenn die Textzeile nicht vorkommt; default N

'''Beispiel'''

#coutl $TEXT_HASLINE(1,990000018,1,0)

==$VIBAN()==

Die Funktion $VIBAN() ("validate IBAN") prüft eine IBAN anhand der Prüfziffern (3. und 4. Stelle).

'''Parameter'''

# IBAN, die geprüft werden soll

'''Beispiel'''

#coutl $VIBAN(DE12345)

=Currency-Funktionen=

==$CCALC()==

Führt eine Berechnung mit Festkommawerten durch

'''Operatoren'''

** + - Addition
** - - Subtraktion
** * - Multiplikation
** / - Division
** % - Division und Multiplikation des Ergebnisses mit 100
** +4 - Addition und Ausgabe mit 4 Nachkommastellen
** -4 - Subtraktion und Ausgabe mit 4 Nachkommastellen
** *4 - Multiplikation und Ausgabe mit 4 Nachkommastellen
** /4 - Division und Ausgabe mit 4 Nachkommastellen
** %4 - Division, Multiplikation des Ergebnisses mit 100 und Ausgabe mit 4 Nachkommastellen

** B, b, B4, b4 - Bruttobetrag, erster Parameter ist der Netto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** E, e, E4, e4 - Enthaltene MWSt, erster Parameter ist der Brutto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** M, m, M4, m4 - MWSt, erster Parameter ist der Netto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** N, n, N4, n4 - Nettobetrag, erster Parameter ist der Brutto-Betrag, zweiter Parameter ist der MWSt-Satz in %

'''Parameter'''

# Operator
# und weitere: Operanden

'''Beispiele'''

-- Ergebnis 10
#cout c="$CCALC(+,1,2,3,4)"
-- Ergebnis 16,67
#cout c="$CCALC(/,100,2,3)"

#val_set n=1 z=1038,87
#coutl $CCALC(N,$VAL(1),19) - $CCALC(E,$VAL(1),19) -

==$CURR()==

Currency-Werte müssen in Funktionen mit einem Punkt als Dezimaltrennzeichen eingegeben werden, da das Komma die Parameter trennt. Sofern Konstanten verwendet werden, lässt sich das einfach so eingeben, sobald aber die Werte aus anderen Funktionen kommen (zum Beispiel $DATA()), müssen sie dann mit $CURR() in dieses Format umgewandelt werden.

'''Parameter'''

# Vorkommastellen
# Nachkommastellen

'''Beispiel'''

-- Ergebnis 43,48
#cout c="$CCALC(/,100,$CURR(2,3))"
-- zum Vergleich; Ergebnis 16,67
#cout c="$CCALC(/,100,2,3)"

==$CFMT()==

Formatiert Curreny-Werte

'''Parameter'''

# Wert
# optional: Formatierungsstring, default 0.00
# optional: wenn hn ("hide null"), dann werden leere Strings als Wert auch als leerer String ausgegeben

'''Beispiel'''

#val_set n=1 z=###,###,###,##0.00
#val_set n=2 z=1337,42
#cout c=$CFMT($VAL(2),$VAL(1))

==$ONLYNUM()==

Stellt sicher, dass in einem String nur Zahlen (ggf. auch Kommas oder Punkte) enthalten sind.

'''Parameter'''

# Zahl
# Art der Operation; default numkomma
## flnnc ("from last not numeric character") - Ab dem letzten Zeichen, das keine Ziffer ist
## num - Nur Ziffern, alle anderen Zeichen werden entfernt
## numkomma - Nur Ziffern und Kommata, alle anderen Zeichen werden entfernt
## numpoint - Nur Ziffern und Punkte, alle anderen Zeichen werden entfernt
## ufnnc ("until first not numeric character") - vom Anfang bis zum ersten Zeichen, das keine Ziffer ist

'''Beispiel'''
-- Ergebnis 123456
#coutl $ONLYNUM(123-456,num)
-- Ergebnis 123
#coutl $ONLYNUM(123-456,ufnnc)
-- Ergebnis 456
#coutl $ONLYNUM(123-456,flnnc)

Modul VAR neu

2026-05-06T09:12:14Z

Michaelebner: /* #file_op */

Das Modul Var sammelt neben den Variablen auch die grundlegenden Prozeduren und Funktionen.

=Variable=

==#var_set==

<nowiki>#setvar setzt den Wert einer Variablen</nowiki>

Hinweis: Variable sind global, auf sie kann auch in Sub-Kommandos zugegriffen werden. Values sind dagegen lokal.

'''Parameter'''
*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''. Liegt das Recht ''read'' vor, so wird statt dem Inhalt von ''z'' der Inhalt von ''zr'' gesetzt. Liegt kein Recht vor, dann wird der Inhalt von ''zn'' gesetzt
*rf (replace functions) - Wenn Y, dann werden nach der Zuweisung auf die Variable nochmals die Funktionen ersetzt. Wird zum Beispiel benötigt, wenn Code mit Funktionen mittels $DATA() aus der Datenbank geladen wird; Funktionen werden ersetzt, default N; siehe Beispiel
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String
*zn - Wert der Variablen, wenn das Recht r nicht vorliegt
*zr - Wert der Variablen, wenn das Recht r nur ein leserecht ist

'''Beispiele'''

#var_set n=test z="Hello world"
#var_set n=test2 z=$GUID()
#var_set n=edt z=$EDT(edt1) ie=42
#var_set n=_page_kunde_adressänderung_ro z=N zn=Y zr=Y r=kundenservice

Zum Parameter rf: $NOW() in die Zwischenablage kopieren und dann ausführen:

#var_set n=test z=$CLIPBOARD() rf=N
#message c=$VAR(test)
#var_set n=test z=$CLIPBOARD() rf=Y
#message c=$VAR(test)

==#var_setempty==

<nowiki>#var_setempty setzt den Wert einer Variablen, sofern sie (noch) leer ist.</nowiki>

(Besteht der Variableninhalt aus Leerzeichen, gilt die Variable auch als leer.)

'''Parameter'''

*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''. Liegt das Recht ''read'' vor, so wird statt dem Inhalt von ''z'' der Inhalt von ''zr'' gesetzt. Liegt kein Recht vor, dann wird der Inhalt von ''zn'' gesetzt
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String
*zn - Wert der Variablen, wenn das Recht r nicht vorliegt
*zr - Wert der Variablen, wenn das Recht r nur ein leserecht ist

'''Beispiele'''

#var_setempty n=test z="Hello world"
#var_setempty n=test2 z=$GUID()
#var_setempty n=edt z=$EDT(edt1) ie=42

==#var_add==

<nowiki>#var_add fügt einer Variablen einen Wert hinzu.</nowiki>

'''Parameter'''

*cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie - "if empty", Wenn der Wert von z/zr/zn leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei SQL
*n - Name der Variablen, Groß- und Kleinschreibung wird nicht unterschieden, zwingend erforderlich
*r (rights) - Die Variable wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''.
* y -Typ der Operation; default ''text''
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** month - Es wird dem Datum eine Anzahl von Monaten hinzugefügt
** text - Der Wert wird als Text hinzugefügt
*z - Wert, welcher der Variablen hinzugefügt wird, Funktionen werden ersetzt, default ist ein leerer String oder eine 0

'''Beispiel'''

#var_set n=test z=$NOW()
#var_add n=test z=1 y=datetime
#cout c=$VAR(test)

==#var_log==

Schreibt den Inhalt aller Variablen in das Debug-Log.

Wird nur zur Fehlersuche verwendet.

'''Parameter'''

(keine)

'''Beispiel'''

#var_log

==$VAR()==

Mit der Funktion $VAR() wird auf den Inhalt der Variable zugegriffen.

'''Parameter'''

# Name der Variable
# optional: Der Wert wird vor oder nach der Rückgabe als Funktionsergebnis verändert; nur für ganzzahlige Werte
## ib ("increment before") - Der Wert wird vor der Rückgabe um eins erhöht
## db ("decrement before") - Der Wert wird vor der Rückgabe um eins verringert
## ia ("increment after") - Der Wert wird nach der Rückgabe um eins erhöht
## da ("decrement after") - Der Wert wird nach der Rückgabe um eins verringert

'''Beispiele'''

#message c=$VAR(test)
#var_set n=neuer_wert z=$VAR(wert) ie=$VAR(alternativwert)
#execsql k_lfdnr=$VAR(lfdnr,ib)

=Kommandos=

(Primär- und Sub) Kommandos sind üblicherweise benannt und werden im Code-Dialog eingegeben.

Es besteht jedoch auch die Möglichkeit, lokale Kommandos innerhalb eines anderen Kommandos zu definieren. Diese Kommandos haben statt eines Kommando-Namens dann dann eine Kommando-Nummer.

Lokale Kommandos werden üblicherweise für folgende Zwecke verwendet:

* Bei der Verwendung von xlive werden bisweilen Prozeduren eingesetzt, die ihrerseits ein Kommando aufrufen (z.B. #sql_open). Wenn dieses Kommando nichts bereits existiert, kann es nur als lokales Kommando erstellt werden.

* Wenn das auszuführende Kommando auf derselben Seite stehen soll wie die aufrufende Prozedur.

Siehe als Beispiel: [[beispiele_csv|User-Tabelle als CSV-Datei exportieren]]

==#cmd==

<nowiki>#cmd fügt dem Kommando eine Zeile hinzu</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #cmd fügt dem ersten Kommando eine Zeile hinzu, #cmd2 fügt dem zweiten Kommando eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#cmd hat keine benannten Parameter. Die ganze Zeile nach dem #cmd und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

'''Beispiel'''

#cmd3 #text $DATA(n,login);$DATA(n,shortname);$DATA(n,firstname);$DATA(n,lastname);$DATA(n,userid);

Siehe auch [[beispiele_csv|User-Tabelle als CSV-Datei exportieren]]

==#cmd_clear==

<nowiki>#cmd_clear löscht ein Kommando</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #cmd_clear löscht das erste Kommando, #cmd_clear2 löscht das zweite Kommando, und so weiter.

'''Parameter'''

(keine)

Folgen dem #cmd_clear Zeichen, so werden die dem gerade gelöschten Kommando hinzugefügt. Auf diese Weise lässt sich etwas prägnanter formulieren.

'''Beispiele'''

#cmd_clear3
#cmd_clear #grd_add i=grid f_logtext="Kunde angerufen und nicht erreicht."

==#cmd_clearall==

<nowiki>#cmd_clearall löscht alle Kommandos</nowiki>

'''Parameter'''

(keine)

'''Beispiel'''

#cmd_clearall

=CSV=

Die CSV-Routinen werden verwendet, um CSV-Dateien einzulesen und zu verarbeiten.

==#csv_open==

<nowiki>#csv_open öffnet eine CSV-Datei</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #csv_open öffnet die erste CSV-Datei, #csv_open2 öffnet die zweite CSV-Datei, und so weiter.

'''Parameter'''

*ber - wenn Y, werden die Zeilenumbrüche innerhalb von Feldern durch Leerzeichen ersetzt. Die Felder müssen dabei in doppelten Anführungszeichen eingeschlossen sein.
* e ("encoding") - Encoding der zu öffnenden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - ("Filename") Dateiname der CSV-Datei
*hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden. Groß- und Kleinschreibung ist unerheblich. Muss bereits hier gesetzt werden, wenn mit $CSV_LINE auf den Header zugegriffen werden soll, bevor #csv_line ausgeführt wird.
*txt ("Text") - alternativ zum Dateinamen fn die Nummer eines Textes, der als CSV-Datei verwendet werden soll.

'''Beispiel'''

#csv_open fn=c:\temp\text.csv

==#csv_line==

<nowiki>#csv_line geht zeilenweise durch die CSV-Datei</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #csv_line geht durch die erste CSV-Datei, #csv_line2 geht durch die zweite CSV-Datei, und so weiter.

'''Parameter'''

* db ("database") - Die Datenbank, für welche die Transaktion ausgeführt wird, wenn ert=Y gesetzt ist. Default ist die Standard-Datenbank, Funktionen werden ersetzt.
*er ("each row") - Kommando, das für jede Zeile der CSV-Datei ausgeführt wird.
*ert ("each row transaction") - Für jede Ausführung des in er spezifizierten Kommandos wird eine eigene Datenbank-Transaktion ausgeführt, Funktionen werden ersetzt
*hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden. Groß- und Kleinschreibung ist unerheblich.
*m ("maximum") - Maximale Anzahl der Zeilen, die verarbeitet wird. Wird gerne bei der Entwicklung verwendet, um die Bearbeitungsgeschwindigkeit zu erhöhen. Funktionen werden ersetzt
* nex ("no exception") - Wenn Y, wird im Falle einer Exception die Bearbeitung nicht abgebrochen, sondern lediglich Warnungen geloggt; Default N, Funktionen werden ersetzt
*sep ("separator") - Trennzeichen zwichen den Spalten, default ist das Semikolon, Funktionen werden ersetzt
*trim - Wenn Y, dann werden in jeder Zelle führende und nachhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt

'''Beispiel'''

#csv_line er=test_csv_line hhr=Y m=3

==#csv_check==

<nowiki>#csv_check prüft die CSV-Datei</nowiki>

'''Parameter'''

*cnt ("count") - Anzahl der Header-Einträge, die geprüft wird; Funktionen werden ersetzt
*h1, h2... ("header") - Eintrag im Header, der auf existenz geprüft wird; Groß und Kleinschreibung ist unerheblich, Funktionen werden ersetzt.
*n ("name" / "number") - Name der Variable oder Nummer des Values, in die/den das Ergebnis (Y oder N) geschrieben wird; Funktionen werden ersetzt
*res ("result") - Name der Variable oder Nummer des Values, in die/den der Ergebnistext geschrieben wird; Funktionen werden ersetzt
*sep ("separator") - Trennzeichen zwischen den einzelnen Spalten; Funktionen werden ersetzt
*y - Typ der Prüfung; Funktionen werden ersetzt, default header
** header - Prüft die Existenz von Spaltennamen im Header. Die zu prüfenden Spaltennamen werden als h1, h2... übergeben, cnt ist entsprechend zu setzen. Wenn alle geprüften Spaltennamen vorhanden sind, wird Y zurück gegeben, ansonsten N. Die fehlenden Spaltennamen werden als Ergebnistext zurück gegeben.

'''Beispiel'''

#csv_open fn=C:\temp\mad\done\MTF3108_ET2607_selektion.CSV
#csv_check n=1 res=2 cnt=3 h1=eins h2=zwei h3=drei
#coutl $VAL(1) - $VAL(2)

==#csv_paste==

Übernimmt eine CSV-Datei aus der Zwischenablage. Auf die Werte kann mit $SEPLINE() zugegriffen werden, siehe [[beispiele_pastecsv|Eine Tabelle in der Zwischenablage in ein PDF-Dokument wandeln]]

'''Multi-Row'''

Mit dem Multi-Row-Modus können Daten eingelesen werden, die in einer Zeile mehrere gleichartige Werte haben.

Daten, die im Single-Row-Modus wie folgt aussehen:

01.01.2020 4465
01.01.2020 8574
01.01.2020 3456
02.01.2020 5467
03.01.2020 2436
03.01.2020 6578
03.01.2020 3456
03.01.2020 6578
03.01.2020 4457
03.01.2020 7658

Würden im Multi-Row-Modus wie folgt aussehen (und könnten auch so eingelesen werden):

01.01.2020 4465 8574 3456
02.01.2020 5467
03.01.2020 2436 6578 3456 6578 4457 7658

'''Parameter'''

* er ("each row") - Kommando, das für jede Zeile der CSV-Datei ausgeführt wird.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert ("each row transaction") - Für jede Ausführung des in er spezifizierten Kommandos wird eine eigene Datenbank-Transaktion ausgeführt.
* fr ("first row") - Wenn dieser Parameter einen Wert hat, dann muss die kopierte CSV-Datei in der ersten Zeile auch diesen Wert haben, oder die Aktion wird abgebrochen; Funktionen werden ersetzt
* hhr ("has header row") - Wenn Y, ist die erste Zeile der CSV-Datei eine Überschriften-Zeile; für diese wird das in er spezifizierten Kommando nicht ausgeführt, dafür können Spaltenbezeichner für den Zugriff auf die einzelnen Spalten verwendet werden.
* mrs ("multi row start") - Erste Spalte für den Multi-Row-Bereich
* sep ("separator") - Trennzeichen zwichen den Spalten, default ist das Tabulatorzeichen
* trim - Wenn Y, dann werden in jeder Zelle führende und nachhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt
* y - Typ; default s
** m - multi; siehe Abschnitt Multi-Row
** s - single; die CSV-Datei wird Zeile für Zeile eingelesen

'''Beispiele'''
* [[beispiele_pastecsv|Eine Tabelle in der Zwischenablage in ein PDF-Dokument wandeln]]

#csv_paste er=imp_line hhr=Y
#csv_paste er=imp_line y=m mrs=1

==$CSV()==

<nowiki>$CSV() greift auf einen Feldinhalt der aktuellen CSV-Zeile zu.</nowiki>

'''Parameter'''

# Nummer der CSV-Datei
# Name der Spalte oder 0-relative Spaltennummer. Name der Spalte setzt voraus, dass bei #csv_line der Parameter hhr gleich Y ist.
# optional: Stelle der Zeichens, ab dem der Inhalt des CSV-Feldes zurück gegeben wird
# optional: Anzahl der Zeichen, die maximal zurück gegeben werden; wird meist dafür verwendet, damit die maximale Länge von Datenbankfeldern nicht überschritten wird.

'''Beispiele'''

#setvar n=test z=$CSV(1,0)

Hier im Beispiel wird in der ersten CSV-Datei (#csv_open) auf die erste Spalte (0, da 0-relativ) zugegriffen.

#setvar n=test z=$CSV(1,0,1,30)

Wie oben, nur werden nur die ersten 30 Zeichen zurück gegeben

==$CSV_LINE()==

<nowiki>$CSV_LINE() Gibt eine ganze Zeile einer CSV-Datei zurück</nowiki>

'''Parameter'''

# Nummer der CSV-Datei
# Name der Zeile: header gibt die Header-Zeile zurück, current die aktuelle Zeile in #csv_line

'''Beispiel'''

Die Funktion $CSV_LINE wird insbesondere dafür verwendet, um CSV-Dateien mit Daten zu ergänzen. Hier im Beispiel wird jede Zeile mit einer GUID ergänzt.

#cmd_clear #text $CSV_LINE(1,current)$GUID();

#csv_open fn=c:\temp\ex.csv hhr=Y
#text_clear $CSV_LINE(1,header)guid;
#csv_line er=1 hhr=Y

#text_save fn=c:\temp\ex2.csv

Nach dem Öffnen der bestehenden CSV-Datei (es muss hier bereits hhr gesetzt werden) wird zunächst der Header in Text 1 eingefügt, ergänzt um die Spalte ''guid'' und das abschließende Semikolon. Danach gehen wir mit #csv_line durch alle Zeile, fügen diese komplett in Text 1 ein und hängen eine GUID hinten dran. Danach wird die Datei gespeichert.

=Text=

==#text==

<nowiki>#text fügt dem Text eine Zeile hinzu</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text fügt dem ersten Text eine Zeile hinzu, #text2 fügt dem zweiten Text eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#text hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#text Zeile 1
#text Zeile 2
#text Und jetzt noch eine GUID: $GUID()
#text Der folgende Text kommt in Großbuchstaben: $UPP(hello world)

==#textn==

<nowiki>#textn fügt dem Text eine Zeile hinzu. Im Unterschied zu #text werden dabei keine Funktionen ersetzt.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #textn fügt dem ersten Text eine Zeile hinzu, #text2n fügt dem zweiten Text eine Zeile hinzu, und so weiter.

'''Parameter'''

<nowiki>#text hat keine benannten Parameter. Die ganze Zeile nach dem #textn und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

Funktionen werden dabei '''nicht''' ersetzt.

'''Beispiel'''

#textn Zeile 1
#textn Zeile 2

==#text_clear==

<nowiki>#text_clear löscht einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_clear löscht den ersten Text, #text_clear2 löscht den zweiten Text, und so weiter.

'''Parameter'''

(keine)

Folgen dem #text_clear Zeichen, so werden die dem gerade gelöschten Text hinzugefügt. Auf diese Weise lässt sich etwas prägnanter formulieren.

'''Beispiel'''

#text_clear7
#text7 Zeile 1
#text7 Zeile 2

Das vorangestellt #text_clear stellt sicher, dass Text7 leer ist. Alternativ könnte man formulieren:

#text_clear7 Zeile 1
#text7 Zeile 2

==#text_save==

<nowiki>#text_save speichert einen Text in einer Datei.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_save speichert den ersten Text, #text_save2 speichert den zweiten Text, und so weiter.

'''Parameter'''
* bom ("Byte order mark") - Wenn Y, dann wird die Datei mit BOM geschrieben; default Y
* e ("encoding") - Encoding der zu speichernden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - Dateiname, unter dem die Datei gespeichert wird. Bestehende Dateien werden überschrieben, sofern das Betriebssystem das nicht verhindert (z.B, weil die Datei gerade geöffnet ist)
* o ("open") - Öffnet die gespeicherte Datei gleich anschließend.
*sort - Wenn Y, dann wird die Datei vor dem Speichern sortiert.

'''Beispiel'''

#text Hello world
#text_save fn=$DIR(userroot)hello_world.txt
#text_save fn=c:\temp\export_vert_export.prepared_.csv e=utf8 bom=N

==#text_open==

<nowiki>#text_open öffnet einen Text aus einer Datei, der bisherige Inhalt der Datei wird überschrieben.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_open öffnet den ersten Text, #text_open2 öffnet den zweiten Text, und so weiter.

'''Parameter'''

* e ("encoding") - Encoding der zu öffnenden Datei, zulässig sind ''ansi'', ''ascii'', ''utf7'', ''utf8'', ''unicode'' und ''bigendianunicode''. Bei leerem oder nicht gesetzten Parameter wird das Default-Encoding verwendet (Bei Windows ansi, sonst utf8).
*fn - Dateiname der Datei, die geöffnet wird.

'''Beispiel'''

#text_open fn=$DIR(userroot)test.txt
#text Eine weitere Zeile, $GUID()
#text_save fn=$DIR(userroot)test.txt

==#text_props==

<nowiki>#text_props stellt Eigenschaften des Textes ein.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_props bezieht sich auf den ersten Text, #text_props2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* dub ("duplicates") - Verhalten einer sortierten Liste bezüglich Dubletten
** acc ("accept") - Dubletten werden akzeptiert
** err ("error") - Dubletten führen zu Fehlern
** ign ("ignore) - Dubletten werden ignoriert
* srt ("sorted") - Wenn ja, dann ist die Liste sortiert

'''Beispiel'''

#text_props srt=Y dup=ign

==#text_set==

<nowiki>#text_set setzt eine bestimmte Zeile eines Textes</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_set bezieht sich auf den ersten Text, #text_set2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* i ("index") - 0-relativer Index der Zeile, die geschrieben werden soll. Mit ''last'' kann die letzte Zeile geschrieben werden, mit ''all'' werden alle Zeilen ersetzt, das wird dann gebraucht, wenn mehrzeiliger Text zugewiesen werden soll; Funktionen werden ersetzt
* z - Text, der geschrieben wird; Funktionen werden ersetzt

'''Beispiele'''

#text_set i=2 z="dritte Zeile"
#text_set i=last z="letzte Zeile"
#text_set i=all z=$CLIPBOARD()

==#text_sort==

<nowiki>#text_sort sortiert einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_sort bezieht sich auf den ersten Text, #text_sort2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* y - Typ, default alpha, Funktionen werden ersetzt
** alpha - sortiert alphanumerisch
** inv - invertiert die gegebene Reihenfolge

'''Beispiel'''

#val_set n=1 z=",OU=2nd_Level_T1,OU=Kundenservice,OU=Benutzer,OU=Testtours,OU=Travel"
#text_clear
#text_dissect z=$VAL(1) sep=",OU="
#coutl $TEXT(1)
#text_sort y=inv
#text_compose n=1 sep=.
#val_set n=1 z=tt.$VAL(1)
#coutl $VAL(1)

Ergebnis ist:
2nd_Level_T1
Kundenservice
Benutzer
Testtours
tt.Testtours.Benutzer.Kundenservice.2nd_Level_T1.

==#text_dissect==

<nowiki>#text_dissect zerteilt einen String anhand einer vorgegebenen Trennzeichenfolge und fügt das Ergebnis dem betreffenden Text hinzu. Gegebenenfalls muss der Text vorher mit #text_clear geleert werden.</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_dissect bezieht sich auf den ersten Text, #text_dissect bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* ls ("last separator") - wenn Y, wird die sep-Zeichenfolge noch mal dem String angehängt; default N, Funktionen werden ersetzt
* sep ("separator") - Zeichenfolge, anhand der String zerteilt wird; Funktionen werden ersetzt
* z - String, der zerlegt wird; Funktionen werden ersetzt

'''Beispiel'''

Siehe #text_sort

==#text_compose==

<nowiki>#text_compose setzt einen Text mithilfe eines Trennzeichens zu einem String zusammen</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_compose bezieht sich auf den ersten Text, #text_compose bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* ls ("last separator") - Wenn Y, wird die Trennzeichenfolge auch noch mal am Ende des Strings eingefügt; default N, Funktionen werden ersetzt
* n - Nummer des Values oder Name der Variable, in welche der String geschrieben wird; Funktionen werden ersetzt
* sep ("separator") - Trennzeichenfolge, die beim Zusammenfügen des Textes verwendet wird; Funktionen werden ersetzt

'''Beispiel'''

Siehe #text_sort

==#text_act==

<nowiki>#text_act bearbeitet einen Text</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_act bezieht sich auf den ersten Text, #text_act2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''
* c ("caption") - Text der Zeile, die bei insert eingefügt werden soll; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* cu ("current") - 0-relative Zeilennummer der Operation; default 0, Funktionen werden ersetzt
* ne ("new") - 0-relative Zeilennummer als Ziel bei move; default 0, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt
** delete - Löscht die Zeile an Position cu ("current")
** insert - Fügt den Text c an der Position cu ("current") ein
** move - verschiebt die Zeile cu ("current") nach Zeile ne ("new")

'''Beispiel'''
#text_act y=move cu=0

==#text_loop==

<nowiki>#text_loop geht durch die Zeilen eines Textes und ruft für jede Zeile ''er'' auf</nowiki>

Es handelt sich dabei um eine nummerierte Prozedur. #text_loop bezieht sich auf den ersten Text, #text_loop2 bezieht sich auf den zweiten Text, und so weiter.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* db - ("database") Name der Datenbank, auf die sich ert bezieht
* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* m - ("maximum") Es wird maximal für die Anzahl der angegebenen Zeilen das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten.
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N, Funktionen werden ersetzt.
* n - Name der Variable, in welche die 0-relative Schleifenvariable geschrieben wird. (Es würde auch in einen Value geschrieben, wenn es sich um eine Nummer handelt, das ergibt in der Praxis aber meist nicht viel Sinn) Funktionen werden ersetzt

'''Beispiel'''

#text_clear eins
#text zwei
#text drei

#cmd_clear #coutl - $TEXT(1,$VAR(eins))
#text_loop er=1 n=eins

==#tvl_add==

Addiert dem Wert in einer Text-Valueliste einen Wert hinzu. Es handelt sich dabei um eine nummerierte Prozedur: #tvl_add arbeitet mit Text 1, #tvl_add2 mit Text 2 und so weiter.

'''Parameter'''

* cnd ("condition") - Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* n ("name") - Name der Zeile, der ein Wert hinzugefügt wird; Funktionen werden ersetzt.
* y - Typ der Operation, Funktionen werden ersetzt, default text
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** text - Der Wert wird als Text hinzugefügt
* z - Der Wert, der hinzugefügt wird

'''Beispiel'''

#text eins=1
#text zwei=2
#text drei=3
#tvl_add y=int n=zwei z=1
#coutl $TEXT(1)

==$TEXT()==

Mit der Funktion $TEXT() wird auf den Inhalt des Textes zugegriffen.

'''Parameter'''

# Nummer des Textes
# optional Zeile des Textes (0-relativ). Wenn es keinen zweiten Parameter gibt, wird der komplette Text zurück gegeben. Alternativ als zweiter Parameter eine Sonderfunktion:
## cnt / count - Gibt die Anzahl der Zeilen zurück
## last - Gibt die letzte Zeile zurück
## ix - Gibt die Position des Textes im dritten Parameter zurück
## as_line - Gibt den Text als eine Zeile zurück, Zeilenumbrüche werden durch den dritten Parameter ersetzt
# optional in abhängigkeit vom zweiten Paremeter
## wenn zweiter Parameter ix: Textzeile, nach der mit ix gesucht wird
## wenn zweiter Parameter as_line: Zeichenfolge, mit der die Zeilenumbrüche ersetzt werden

'''Beispiele'''

#text Zeile 1
#text Zeile 2
#text Zeile 3
#message c=$TEXT(1)

#code url=$TEXT(1,as_line,&)

=Code=

Grundsätzlich gilt in BAL: Eine Prozedur - eine Zeile.

Bei vielen und/oder langen Parametern führt das zu recht langen Code-Zeilen und zu Unübersichtlichkeit. Hier können nun Teile der Parameter mit #code in weitere Zeile ausgelagert werden, deren Inhalt dann mit $CODE$ oder $CODE$ der eigentlichen Code-Zeile hinzugefügt wird.

==#code==

Fügt Text dem Code-Speicher hinzu.

'''Parameter'''

<nowiki>#code hat keine benannten Parameter. Die ganze Zeile nach dem #code und dem trennenden Leerzeichen wird hinzugefügt.</nowiki>

'''Beispiel'''

#code cnt=2
#code fn1=G:\pics\pic5d68865cdaba62_62767562.jpg
#code fn2=G:\pics\pic5d913c48682128_67979256.jpg
#email_send from=test@****.de to=info@*****************.de bcc=info@*****.de subject=Testmail text=$TEXT(1) $CODE$

==$CODE$ / $CODEN$==

<nowiki>$CODE$ und $CODEN$ sind keine Funktionen, auch wenn sie auf den ersten Blick ähnlich aussehen. Sie haben keine Parameter und auch keine Klammern, dafür ein abschließendes $.</nowiki>

Beide Anweisungen fügen den Code-Speicher der jeweiligen Zeile hinzu. $CODE$ löscht danach den Code-Speicher, $CODEN$ tut das nicht, so dass dieselben Parameter wiederholt eingefügt werden können (beim letzten Einfügen sollte dann $CODE$ verwendet werden).

=Separierte Zeile=

Eine separierte Zeile ist eine Textzeile, die mehrere gleichartige Werte enthält, die durch Trennzeichen getrennt sind.

Beispiel:

3244,4465,7763,4536,4356,7777

Solche Zeilen können mit #sepline aufgetrennt werden.

==#sepline==

Trennt eine separierte Zeile auf und führt für jeden Wert das mit er angegebene Kommando aus.

Es handelt sich dabei um eine nummerierte Prozedur (#sepline, #sepline2...)

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y; Funktionen werden ersetzt
* db - ("database") Name der Datenbank, für welche die Transaktion gestartet wird, wenn ert=Y. Default ist die Standard-Datenbank, Funktionen werden ersetzt.
* er ("each row") - Das Kommando, das für jeden Wert der separierten Zeile aufgerufen wird. Funktionen werden ersetzt.
* ern ("each row no") - Das Kommando, das für jeden Wert der separierten Zeile aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert ("each row transaction") - Wenn Y, wird für jeden Wert der separierten Zeile eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* m ("maximum") - Es wird maximal für die Anzahl der angegebenen Werte das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten; Funktionen werden ersetzt.
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N; Funktionen werden ersetzt.
* nn ("not null") - Wenn Y, dann wird er nur für Werte der separierten Zeile aufgerufen, die nicht leer sind. Default N, Funktionen werden ersetzt.
* sep ("separator") - Das oder die Trennzeichen; default ist das Semikolon, Funktionen werden ersetzt.
* z - Der Inhalt der separierten Zeile; Funktionen werden ersetzt.

'''Beispiel'''

#cmd #cout c=$SEPLINE(1)
#sepline z=3244,4465,7763,4536,4356,7777 sep=, er=1

==$SEPLINE()==

Greift auf den einzelnen Wert einer mit #sepline getrennten Zeile zu.

'''Parameter'''

# Nummer der separierten Zeile

'''Beispiel'''

#cmd #cout c=$SEPLINE(3)
#sepline3 z=3244;4465;7763;4536;4356;7777 er=1

=User und Rechte=

Aus Gründen der Übersichtlichkeit ist die Rechtevergabe zweistufig:

# Es werden (meist am Anfang eines Primär-Kommandos) Rechte-Definitionen erstellt, die einer oder mehreren Benutzergruppen Rechte (lesen oder lesen und schreiben) zuweisen. Die Rechte werden dabei implizit auch allen Untergruppen der angegebenen Benutzergruppe erteilt (Zum Beispiel: Rechte der Gruppe ''user'' hat auch implizit die Gruppe ''user.admin'').
# Dem Parameter r verschiedener Prozeduren kann dann eine Rechte-Definition zugewiesen werden.

Den Parameter r als Rechte-Definition berücksichtigen die folgenden Prozeduren:

* #frm
* Buttons (#btn, #btns_btn)
* Alle Segmente (#text_seg, #memo_seg, #btns_seg, vl_seg, #grd_seg, #xgrd_seg)
* Tree (#tree_add, #tree_fill, #tree_fillsql, Lese-Recht reicht)
* Grid-Spalten (#grd_col, #xgrd_col)
* #vl_line (für die komplette Zeile (r) und die einzelne Zelle (r1, r2, r3...))

Wo der Parameter r nicht gesetzt ist, wird die Rechte-Definition der Formulars verwendet.

==#rights==

Setzt eine Rechte-Definition im betreffenden Kommando.

'''Parameter'''

* n ("name") - Name der Rechte-Definition; default ist ''frm'', also dsa Default-Recht für das Formular.
* r_ ("right") - Prefix für die Benutzergruppe. Für die Rechte-Definition sind die folgenden Werte zulässig
** n ("no") - kein Recht
** r ("read") - nur lesen
** w ("write") - lesen und schreiben

'''Beispiel'''

#rights n=frm r_user=r r_user.admin=w

Setzt für alle User das Lese-Recht und für Administratoren das Lese- und Schreibrecht.

==#rights_clear==

Löscht alle Rechte-Definitionen im betreffenden Kommando.

(Wird in der Praxis selten benötigt, weil Kommandos mit leerer Rechte-Definition starten.)

'''Parameter'''

(keine)

'''Beispiel'''

#rights_clear

==$USERID()==

Die ID des angemeldeten Users

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec kusr=$USERID()

==$RIGHTUSERID()==

Administratoren können andere User einstellen (Userliste links unten im BAF-Client), vor allem um deren Rechte zu prüfen. Die UserID dieses ausgewählten Users kann mit der Funktion $RIGHTUSERID() ermittelt werden.

In fast allen Fällen gilt der folgende Grundsatz: Lesende Operationen mit $RIGHTUSERID(), schreibende Operationen mit $USERID().

'''Parameter'''

(keine)

'''Beispiel'''

#sql_open kusr=$RIGHTUSERID()

==$ADM()==

Gibt den ersten Parameter (oder Y) zurück, wenn der angemeldete User Administrator-Rechte hat, andernfalls den zweiten Parameter (oder N).

'''Parameter'''

# Wert, der zurückgegeben wird, wenn der angemeldete User Administrator-Rechte hat; sofern kein Wert angegeben ist, Y
# Wert, der zurückgegeben wird, wenn der angemeldete User keine Administrator-Rechte hat; sofern kein Wert angegeben ist, N

(keine)

'''Beispiel'''

~ $ADM()

==$RADM()==

Gibt den ersten Parameter (oder Y) zurück, wenn der ausgewählte User Administrator-Rechte hat, andernfalls den zweiten Parameter (oder N).

'''Parameter'''

# Wert, der zurückgegeben wird, wenn der ausgewählte User Administrator-Rechte hat; sofern kein Wert angegeben ist, Y
# Wert, der zurückgegeben wird, wenn der ausgewählte User keine Administrator-Rechte hat; sofern kein Wert angegeben ist, N

'''Beispiel'''

~ $RADM()

=Ausführen=

==#exec==

Führt ein anderes Kommando aus

'''Parameter'''

* cnd (condition) - Die Variable wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
* cmd ("command") - Names des (Primär- oder Sub-) Kommandos, das ausgeführt werden soll.
* ex ("exception") - Name oder Nummer des Kommandos, das ausgeführt wird, wenn bei der Ausführung von cmd eine Exception auftritt; siehe Beispiele
* fin ("finally") - Name oder Nummer des Kommandos, das nach der Ausführung von cmd ausgeführt wird - egal ob eine Exception aufgetreten ist oder nicht. Wird nur berücksichtigt, wenn der Parameter ex nicht gesetzt ist.

'''Beispiele'''

#exec cmd="xtodo_page_add(XU,$PVAL(vl,user_user_id),$PVAL(vl,login),$PVAL(vl,shortname)$CHR(crlf)$PVAL(vl,firstname) $PVAL(vl,lastname))"

Das folgende Beispiel löst das Problem, dass ein neues PDF unter demselben Dateinamen nicht erstellt werden kann, wenn beim vorherigen Versuche der Erstellung eine Exception aufgetreten ist. In einem solchen Fall wurde ein #pdf_start, aber kein #pdf_stop ausgeführt, und die geöffnete Datei sperrt diesen Dateiname, bis der BAF-Client geschlossen wird. Lösung dieses Problems ist es, im Parameter ex ein #pdf stop auszuführen; auf das Öffnen der Datei kann in einem solchen Fall verzichtet werden. Mit der Funktion $DATA() wird hier im Beispiel gezielt eine Exception ausgelöst.

#frm c="c_test_pdf" y=console

#cmd_clear
#cmd #pdf_text c="Hello World"
-- #cmd #pdf_text c="Hello World $DATA(dat,test)"
#cmd #pdf_stop o=Y

#pdf_start fn=$DIR(doc)\test.pdf
#exec cmd=1 ex="#pdf_stop o=N"

#cout c="c_test_pdf executed"

==#exec_async==

Führt ein anderes Kommando aus, allerdings asynchron (über einen Timer). Das wird beispielsweise dann benötigt, wenn mit einem chg-Parameter eines Grid oder eine VL-Segmentes die Seite neu aufgebaut wird. Würde hier mit #exec gearbeitet, würde nach dem Aufbau der Seite die Ausführung die diesem Segment zurückkehren, das es aber zu diesem Zeitpunkt gar nicht mehr gibt. Mit #exec_async tritt dieses Problem nicht auf.

'''Parameter'''

Die Parameter sind dieselben wie bei #exec

==#batchexec==

Speichert den Text n in der Datei batch.bat und führt diese aus.

'''Parameter'''

* clr ("clear") - Wenn Y, wird der Text nach Ausführung des Batch-Datei gelöscht; Default Y; Funktionen werden ersetzt;
* n ("number") - Nummer des Textes; der mit #text gespeicherte Text hat die Nummer 1

'''Beispiel'''

#batchexec n=1

==#file_open==

Öffnet eine Datei (oder auch eine Webseite)

'''Parameter'''

* fn ("FileName") - Name der Datei oder die URL der Webseite

'''Beispiel'''

#file_open fn=c:\temp\test.csv
#file_open fn=https://www.google.de

==#loop==

BAL kennt keine Schleifen als Sprachelement. Um Schleifen mit einer fest Schleifenzahl auszuführen, wird die Prozedur #loop verwendet. lf muss nicht kleiner als lt sein, #loop kann auch von oben nach unten zählen.

'''Parameter'''

* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen.
* lf ("loop from") - Anfangswert der Schleifenvariable; Funktionen werden ersetzt.
* lt ("loop to") - Endwert der Schleifenvariable; Funktionen werden ersetzt.
* n ("name") - Name der Variablen, in der die Schleifenvariable gespeichert wird (damit sie an anderer Stelle gelesen werden kann); Funktionen werden ersetzt.

'''Beispiel'''

#loop lf=42 lt=1337 er=test_line

==#exit==

Die Prozedur #exit bricht die Ausführung auf der jeweiligen Code-Ebene (Kommando bzw. Sub-Kommando) ab

'''Parameter'''

(keine)

'''Beispiel'''

#page ras=Y

...

~ $EMPTY($PVAL(vl,id)) and $PVAL(vl,status) > 20
#sql select nextval('ausza_id') as id
#sql_openval f_id=1
#page_val i=vl f=id z=$VAL(1)
#save
#exit

~~

...

Der Beispiel-Code befindet sich auf der Seite xausza_page_ausza und baut die entsprechende Seite auf. Er prüft, ob bereits eine ID-Gesetzt ist - wenn nicht, wird über eine Datenbank-Sequenz die nächste ID abgefragt, in das VL-Segment geschrieben und die Seite gespeichert. Beim Speichern der Seite wird sie jedoch neu aufgerufen, also komplett neu aufgebaut, was erst einmal kein Problem ist. Danach würde aber die Ausführung auf der Code-Ebene, auf der sich #save befindet, fortgeführt, was zur Folge hat, dass die dann folgenden Segmente doppelt erscheinen (zunächst die aus dem Neu-Aufbau der Seite, dann die, die von der Fortsetzung des Codes her stammen).

Um dies zu vermeiden muss die Ausführung des Codes nach #save abgebrochen werden.

==$EXEC==

Führt ein Kommando. Im ausgeführten Kommando kann eine Variable gesetzt werden, die dann als Funktionsergebnis von $EXEC zurückgegeben wird.

'''Parameter'''

# Kommando, das ausgeführt werden soll
# optional: Der Name der Variablen, in der das Ergebnis steht; default ist ''result''

'''Beispiel'''

#frm c="test_funkexec" y=console
#cout c=$EXEC(test_funkexec_line)

-- test_funkexec_line
#var_set n=result z=42

=Dateien und Verzeichnisse=

==#file_op==

Führt eine Operation mit einer Datei oder einem Verzeichnis aus

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Name der Datei oder des Verzeichnisses
* n - Name der Variable oder Nummer des Values, in die/den das Ergebnis der Operation (Y oder N) geschrieben wird.
* on ("old name) - der bisherige Dateiname bei RenameFile
* y - Typ der Operation
** cd / createdir - Erzeugt ein Verzeichnis
** cf / copyfile - Kopiert eine Datei (von on zu fn)
** dac / deleteaftercopy _ wenn sowohl die mit fn als auch die mit on spezifizierte Datei existiert, wird die mit on spezifizierte Datei gelöscht und das Kommando gibt Y zurück.
** df / deletefile - Löscht eine Datei
** fd / forcedirectories - Stellt sicher, dass ein Pfad vorhanden ist
** rd / removedir - Entfernt ein Verzeichnis
** rf / renamefile - Benennt eine Datei um, kann auch dazu verwendet werden, eine Datei zu verschieben

'''Beispiele'''

#file_op y=renamefile on=c:\temp\debug.txt fn=c:\temp\test\debug.txt n=1
#cout c=$VAL(1)

#file_op y=fd fn=c:\eins\zwei\drei\vier

==#file_search==

Sucht Dateien und schreibt die Ergebnisliste in einen Text.

'''Parameter'''

* all - wenn Y, dann werden nach dem Dateinamen auch noch das Dateidatum, die Größe und die Attribute in den Text geschrieben. Default N, Funktionen werden ersetzt
* clr - ("clear") wenn Y, wird der Text vor der Suche geleert. Default Y, Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Suchstring, siehe Beispiel; Funktionen werden ersetzt
* n ("number") - Nummer des Textes, in den die Ergebnisliste geschrieben wird; default 1, Funktionen werden ersetzt.
* y - Typ der Suche. Default AnyFile, Funktionen werden ersetzt
** AnyFile
** ReadOnly
** Hidden
** SysFile
** VolumeID
** Directory
** Archive

'''Beispiel'''

#file_search fn=c:\*.ini n=1 y=0 all_=Y
#coutl $TEXT(1)

==#file_wait==

Wartet, bis zumindest eine Datei vorhanden ist, die den Kriterien entspricht, und führt dann cmd aus. Wird nach der in to eingestellten Zeit keine Datei gefunden, dann wird mit dem in cmdto eingestellten Kommando abgebrochen.

'''Parameter'''

* all - wenn Y, dann werden nach dem Dateinamen auch noch das Dateidatum, die Größe und die Attribute in den Text geschrieben. Default N, Funktionen werden ersetzt
* cmd - Kommando, das ausgeführt wird, sobald eine Datei gefunden wird; Funktionen werden ersetzt
* cmdto - Kommando, das ausgeführt wird, sobald die Prozedur wegen eines TimeOuts abgebrochen wird; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Suchstring, siehe Beispiel; Funktionen werden ersetzt
* sleep - Zeit in ms zwischen den einzelnen Suchen nach einer Datei, die den Kriterien entspricht; Default 1000, Funktionen werden ersetzt
* to ("TimeOut") - Zeit in ms, nach der die Ausführung abgebrochen wird; Default 15000, Funktionen werden ersetzt
* y - Typ der Suche. Default AnyFile, Funktionen werden ersetzt
** AnyFile
** ReadOnly
** Hidden
** SysFile
** VolumeID
** Directory
** Archive

'''Beispiel'''

#cmd_clear #cout c="Gefunden"
#cmd_clear2 #cout c="TimeOut"

#file_wait fn=C:\temp\test\*.txt cmd=1 cmdto=2

==#dir_force==

Stellt sicher, dass es den spezifizierten Verzeichnispfad gibt, indem erforderlichenfalls Verzeichnisse angelegt werden.

'''Parameter'''

* n ("name") - Names des Pfads

'''Beispiel'''

#dir_force n=c:\temp\pdf

==#dir_proc==

Durchsucht ein Verzeichnis nach Dateien, die den angegebenen Kriterien entsprechen, und führt für jede gefundene Datei ''cmd'' aus.

'''Parameter'''

* cmd ("command") - Kommando, das für jede gefundene Datei ausgeführt wird
* dn ("DirectoryName") - Pfad des Verzeichnisses, in dem die Dateien gesucht werden; Funktionen werden ersetzt.
* done - Verzeichnis, in das die Dateien nach Abarbeitung verschoben werden (sofern der Parameter nicht leer ist). Funktionen werden ersetzt.
* error- Verzeichnis, in das die Dateien nach Abarbeitung verschoben werden (sofern der Parameter nicht leer ist), wenn der Inhalte der unter ndone angegebenen Variablen E ist. Funktionen werden ersetzt.
* fn ("filename") - Suchkriterium für den Dateinamen; Funktionen werden ersetzt; Default *
* n ("name") - Name der Variablen, in welcher der Dateiname der aktuell zu bearbeitenden Datei inklusive Pfad gespeichert wird; Funktionen werden ersetzt; Default dir_proc
* ndone("name done") - Name der Variablen, die bestimmt, ob eine Datei in das Done-Verzeichnis verschoben wird. Vor jedem Aufruf von cmd wird diese Variable auf 'Y' gesetzt. Sie kann während der Bearbeitung auf N gesetzt werden - damit wird verhindert, dass die Datei in das Done-Verzeichnis verschoben wird. Wir die Variable auf E gesetzt, wird die Datei ins Error-Verzeichnis verschoben.

'''Beispiel'''

#dir_proc dn=c:\temp\in done=c:\temp\done fn=*.csv cmd=importcsv_line

==$FILEINFO()==

Liefert Infos über eine Datei

'''Parameter'''

# Dateiname
# Typ der Information, es stehen dabei folgende Optionen zur Verfügung
#* size - Dateigröße in Byte
#* size_point - Dateigröße in Byte, Punkte alle drei Zeichen von rechts
#* size_auto - Dateigröße in Byte, kB, MB oder GB, je nach Größe; mit Einheit
#* size_kb - Dateigröße in kB (analog Windows-Explorer)
#* date - Datum im Format dd.mm.yyyy
#* date_yyyy - Datum im Format yyyymmdd
#* datetime - Datum und Uhrzeit im Format dd.mm.yyyy hh:mm:ss
#* datetime_yyyy - Datum im Format yyyymmddhhmmss
#* exists - Y, wenn die Datei existiert, sonst N

'''Beispiel'''

#var_set n=fn z="T:\Tools Gruppenrechte\BC3 light\BafClientFM.exe"
#coutl $FILEINFO($VAR(fn),size)
#coutl $FILEINFO($VAR(fn),size_point)
#coutl $FILEINFO($VAR(fn),size_auto)
#coutl $FILEINFO($VAR(fn),size_kb)
#coutl $FILEINFO($VAR(fn),date)
#coutl $FILEINFO($VAR(fn),date_yyyy)
#coutl $FILEINFO($VAR(fn),datetime)
#coutl $FILEINFO($VAR(fn),datetime_yyyy)
#coutl $FILEINFO($VAR(fn),exists)

Ergebnis

27668480
27.668.480
26,39 MB
27.020 kB
02.05.2023
20230502
02.05.2023 12:20:09
20230502122009
Y

==$DIR()==

Ermittelt einen Verzeichnisnamen. Trailing Path Delimiter (\ bei Windows) wird immer angehängt.

'''Parameter'''

# Bezeichnung des Verzeichnisses
## appdata - Verzeichnis für Anwendungsdaten des Users
## cappdata - gemeinsames Verzeichnis für Anwendungsdaten aller User
## cdoc - gemeinsames Dokumentenverzeichnis aller User
## cfav / cfavorites - gemeinsames Favoritenverzeichnis aller User
## cmusic - gemeinsames Musikverzeichnis aller User
## cpic / cpictures - gemeinsames Bilderverzeichnis aller User
## cvideo - gemeinsames Videoverzeichnis aller User
## desktop - Desktopverzeichnis des Rechners
## '''doc''' / docdir - Dokumentenverzeichnis des Users
## downloads - Downloadsverzeichnis des Users
## fav / favorites - Favoritenverzeichnis des Users
## fonts - Fontsverzeichnis des Rechners
## music - Musikverzeichnis des Users
## pic / pictures - Bilderverzeichnis des Users
## prog / program - Programmverzeichnis des Rechners
## prog86 / program86 - Programm86-Verzeichnis des Rechners
## '''root''' - Root-Verzeichnis des BAF-Clients bzw. des BAF-Servers
## '''userroot''' / usrroot - User-Verzeichnis des BAF-Clients
## video - Videoverzeichnis des Users

'''Beispiel'''

#text_save fn=$DIR(doc)test.txt

==$FILEDIALOG()==

Führt einen Dateiauswahl-Dialog aus und gibt den gewählten Dateinamen zurück. Im Falle des Abbruchs wird ''abort'' zurück gegeben.

'''Parameter'''

# Wenn der erste Parameter ''save'' lautet, wird ein Speichern-Dialog, sonst ein Öffnen-Dialog aufgerufen.
# Filter-Statement, immer Kombinationen aus Text (Text-Dateien *.txt) und Filter-Statement(*.txt), getrennt durch Pipes.
# Standard-Dateierweiterung

'''Beispiel'''

#text_save fn="$FILEDIALOG(save,Text-Dateien *.txt|*.txt|Alle Dateien *.*|*.*,txt)"

(Bitte beachten: Wegen der Leerzeichen im Filter-Statement muss der ganze Parameter in doppelte Anführungszeichen gesetzt werden.)

=ZIP=

==#zip_create==

Erzeugt eine ZIP-Datei

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Dateien, die der ZIP-Datei hinzugefügt werden; Funktionen werden ersetzt
* dir ("directory") - Verzeichnis, wenn das nicht bei allen fn1, fn2... angegeben werden soll
* fn ("FileName") - Der Dateiname, unter dem die ZIP-Datei gespeichert wird; Funktionen werden ersetzt
* fn1, fn2,... ("FileName") - Die Dateien, die in der ZIP-Datei gespeichert werden; die Anzahl wird mit dem Parameter cnt bestimmt; Funktionen werden ersetzt
* list - Nummer eines Textes (#text, #text2...), in dem die Dateien gelistet sind, die der ZIP-Datei hinzugefügt werden sollen. Wenn list ein Wert größer 0 hat, werden cnt und fn1, fn2... ignoriert. Default 0, Funktionen werden ersetzt.
* pw ("PassWord") - Password der erzeugten ZIP-Datei; Funktionen werden ersetzt.
* pwc ("PassWordCrypted") - Wenn Y, dann ist das Passwort mit der Verschlüsselungsfunktion auf der Seite Tools des Code-Dialogs verschlüsselt. Hinweis: Mit dieser Verschlüsselung verhindert man lediglich, dass das Passwort direkt aus dem Code ausgelesen werden kann. Wird der BAF-Client mit dem Delphi-Debugger ausgeführt, lässt sich leicht an die betreffende Stelle ein Breakpoint setzen und das Passwort dann im Klartext auslesen (dieselbe Unit uBafCrypt vorausgesetzt).

'''Beispiele'''
#zip_create fn=$VAR(root).zip list=1

#var_set n=fn_zip z=tt_mail_$VAR(reise)-$VAR(reisename)_$PAD($VAR(lfdnr),4,L,0)_$NOWFMT(yyyymmdd).zip
#file_op y=df fn=$VAR(path)\$VAR(fn_zip)
#code cnt=2
#code fn1=$VAR(filename).txt
#code fn2=$VAR(filename).sab
#zip_create dir=$VAR(path) fn=$VAR(path)\$VAR(fn_zip) pw=$VAR(pw) $CODE$

Die Prozedur #zip_create ersetzt nicht vorherige Dateien. Von daher im Zweifelsfall wie im zweiten Beispiel vorher eine Datei dieses Namens löschen.

=Ini-Dateien=

Der BAF-Client verwendet eine Ini-Datei im Root-Verzeichnis (vor allem für die Datenbankverbindungen) und eine Ini-Datei ''BafClientFM.ini'' im User-Anwendungsverzeichnis (vor allem für die Formularpositionen). Es können aber auch weitere Ini-Dateien verwendet werden.

==#ini_val==

Schreibt einen Wert in die Ini-Datei. #ini_val ist eine nummerierte Prozedur: #ini_val schreibt in die erste Ini-Datei, #ini_val2 in die zweite Ini-Datei und so weiter. Diese Ini-Dateien werden zunächst nur im Speicher gehalten und müssen explizit aus einer Datei geladen oder in eine Datei gespeichert werden.

'''Parameter'''

* i ("item" / "ident") - Name des Eintrags in der Ini-Datei; Funktionen werden ersetzt
* n ("name") - Wenn der Parameter n den Wert ''usr'' oder ''user'' hat, dann bleibt die Nummer der Ini-Datei unberücksichtigt und der Wert wird in die Datei ''BafClientFM.ini'' im im User-Anwendungsverzeichnis geschrieben.
* sec ("section") - Abschnitt in der Ini-Datei; Funktionen werden ersetzt; default ''values''
* z - Wert, der in die Ini-Datei geschrieben wird; Funktionen werden ersetzt.

'''Beispiel'''

#ini_val i=date_last z=$NOW()

==#ini_load==

Lädt eine Ini-Datei aus einer Datei. Es handelt sich um eine nummerierte Prozedur: #ini_load lädt die Ini-Datei 1, #ini_load2 lädt die Ini-Datei 2 und so weiter.

'''Parameter'''

* fn ("FileName") - Dateiname der Datei, die geladen wird

'''Beispiel'''

#ini_load fn=$DIR(userroot)werte.ini

==#ini_save==

Speichert eine Ini-Datei ineine Datei. Es handelt sich um eine nummerierte Prozedur: #ini_save speichert die Ini-Datei 1, #ini_save2 speichert die Ini-Datei 2 und so weiter.

'''Parameter'''

* fn ("FileName") - Dateiname der Datei, in die gespeichert wird

'''Beispiel'''

#ini_save fn=$DIR(userroot)werte.ini

==$INI()==

Liest einen Wert aus einer Ini-Datei.

'''Parameter'''

# Nummer der Ini-Datei, alternativ ''usr'' oder ''root''
# Item (Ident)
# optional: Sektion; wenn nicht vorhanden, dann ''values''. Wenn ''db!'', dann wird als Sektion die aktuell gewählte Datenbankverbindung verwendet (in diesem Fall sollte als erster Parameter ''root'' verwendet werden).
# optional: Default-Wert; wenn nicht vorhanden, dann ein leerer String

'''Beispiele'''

#var_set n=datum z=$INI(1,datum)
#var_set n=datum z=$INI(1,datum,bearbeitung,$TODAY())

==$INITEXT()==

Gibt die komplette Ini-Datei zurück. Wird vor allem beim Debugging verwendet.

'''Parameter'''

# Nummer der Ini-Datei, alternativ ''usr'' oder ''root''

'''Beispiel'''

#coutl $INITEXT(usr)

=Zwischenablage=

Das BAF-Framework unterstützt die Zwischenablage nur für Text.

==#clipboard==

Schreibt einen Text in die Zwischenablage

'''Parameter'''

* z - Wert, der in der Zwischenablage gespeichert werden soll; Funktionen werden ersetzt

'''Beispiele'''

#clipboard z=$TEXT()
#clipboard z=$CHR(dquote)$PVAL(test,zahl,allsel,$CHR(crlf))$CHR(dquote)

==$CLIPBOARD()==

Gibt den Text aus der Zwischenablage zurück.

'''Parameter'''

(keine)

'''Beispiel'''

#setvar n=clp z=$CLIPBOARD()

=String-Funktionen=

Die folgenden Funktionen geben einen String zurück.

==$BASE64()==

En- oder Decodiert einen Text im Base64-Code

'''Parameter'''

# Encoding oder Decoding:
## e - Encoding
## d - Decoding
# Text, der en-oder decodet werden soll.

'''Beispiel'''

#coutl $BASE64(e,Dies ist ein Test)

==$CHR()==

Gibt ein Zeichen (ggf zwei Zeichen) zurück

'''Parameter'''

# Ansi-Zeichennummer oder eine der folgenden Bezeichnungen:
## crlf - Zeilenumbruch #13#10
## cr - Zeichen #13
## lf - Zeichen #10
## tab - Tabulator
## quote - ' (einfache Anführungszeichen)
## dquote - " (doppelte Anführungszeichen)
## space / leer - Leerzeichen
## comma / komma - , (Komma)
## questionmark / qmark / frage / fragezeichen - ?
## bro / bracket_open - (
## brc / bracket_close - )
## dollar - $

'''Beispiel'''

#exec cmd="xtodo_page_add(XU,$PVAL(vl,user_user_id),$PVAL(vl,login),$PVAL(vl,shortname)$CHR(crlf)$PVAL(vl,firstname) $PVAL(vl,lastname))"

==$CONVERT()==

Konvertiert einen String.

'''Parameter'''

# Konvertierungsfunktion
## isodate
## isodatetime
## truefalse
## pointfloat
## urlcode
## utf8
# String, der konvertiert werden soll

'''Beispiel'''

#coutl $CONVERT(isodate,2025-03-12)
#coutl $CONVERT(isodatetime,2025-03-12 12:03:17)
#coutl $CONVERT(truefalse,true)
#coutl $CONVERT(pointfloat,12.3)
#coutl $CONVERT(urlcode,Für schönen Ärger)
#coutl $CONVERT(utf8,Für schönen Ärger)

(Ergebnis)
12.03.2025
12.03.2025 12:03:17
Y
12,3
F%C3%BCr%20sch%C3%B6nen%20%C3%84rger
Für schönen Ärger

==$COPY()==

Kopiert aus dem String im ersten Parameter einen Teil der Zeichen.

'''Parameter'''

# String, aus dem kopiert werden soll
# Position im String, ab dem Zeichen kopiert werden sollen
# optional: Anzahl der Zeichen, die kopiert werden sollen. Wenn dieser Parameter fehlt, werden alle Zeichen ab der angegebenen Position kopiert.

'''Beispiel'''

#grdcol f=ref c1="Ref" w=30 y=link ro=Y cmdn=xtodo_add(link,$COPY($PVAL(grid,ctype,sel),1,2))

==$EXEC()==

Führt ein Kommando aus und gibt ein Funktionsergebnis zurück.

'''Parameter'''

# Kommando, das ausgeführt werden soll.
# optional: Name der Variable, die als Funktionsergebnis zurück gegeben werden soll; default ''result''

'''Beispiel'''

#val_set n=test z=$EXEC(testkommando)

==$GUID()==

Erzeugt eine GUID und gibt sie zurück.

'''Parameter'''

# optional: Name einer Variablen, in welcher die GUID zusätzlich gespeichert wird.

'''Beispiel'''

#sql_exec kid=$GUID()

==$HASH()==

Erzeugt einen Hash-Wert vom String im ersten Parameter.

'''Parameter'''

# String, von welchem der Hash gebildet werden soll.
# zu verwendender Hash-Algorithmus:
## sha512
## sha512_256
## sha512_224
## sha384
## sha256
## sha224
## sha1
## md5 (Hinweis: MD5 gilt seit Längerem als nicht mehr sicher. Verwenden Sie ihn nur, wenn dies aus Gründen der Abwärts-Kompatbilität zwingend ist.)

'''Beispiel'''

#page_val i=vl col=1 row=3 z=$HASH($PVAL(vl,1,2),sha512)

==$INCLUDE()==

Stellt sicher, dass der als dritter Parameter übergebene Text am Anfang oder am Ende steht, gegebenenfalls wird er dort eingefügt.

'''Parameter'''

# Typ der Operation
## lead(oder leading) - Text muss am Anfang stehen
## leadci(oder leadingci oder leadingcaseinsensitive) - Text muss am Anfang stehen, Groß- und Kleinschreibung wird ignoriert
## trail(oder trailing) - Text muss am Ende stehen
## trailci(oder trailci oder trailingcaseinsensitive) - Text muss am Ende stehen, Groß- und Kleinschreibung wird ignoriert
# Text, in den gegebenenfalls eingefügt wird
# Text, der gegebenenfalls eingefügt wird

'''Beispiel'''

#cout c=$INCLUDE(trailci,test.PDF,.pdf)

==$INVLOOKUP()==

Ermittelt den Key aus einer Nachschlageliste bei Übergabe des Values.

'''Parameter'''

# Name der Nachschlageliste
# Value des Eintrags
# Default-Wert; wird verwendet, wenn der Rückgabe-Wert leer ist

'''Beispiel'''

#cout c="$INVLOOKUP(general_status,aktiv,Wert nicht vorhanden)"

==$LOOKUP()==

Ermittelt einen Wert aus einer Nachschlageliste.

'''Parameter'''

# Name der Nachschlageliste
# Key des Eintrags
# Default-Wert; wird verwendet, wenn der Rückgabe-Wert leer ist

'''Beispiel'''

#cout c="$LOOKUP(general_status,1,Status nicht gesetzt)"

==$LOW()==

Wandelt den übergebenen String in Kleinbuchstaben um.

'''Parameter'''

# String, der in Kleinbuchstaben gewandelt werden soll.

'''Beispiel'''

~ $LOW($EDT(edt1)) = bus

==$LOWNOSPACE()==

Wandelt einen String in Kleinbuchstaben und ersetzt alle Leerzeichen durch Unterstriche.

'''Parameter'''

# String, der gewandelt werden soll

'''Beispiel'''

#page_val i=vl col=1 row=3 z=$LOWNOSPACE($PVAL(vl,1,2))

==$NOCRLF()==

Entfernt Zeilenumbrüche

'''Parameter'''

# String, aus dem die Zeilenumbrüche entfernt werden sollen
# optional: Zeichenfolge, die an Stelle der Zeilenumbrüche eingefügt werden sollen

'''Beispiel'''

#val_set n=2 z=$NOCRLF($VAL(1),;)

==$NVL()==

Liefert einen Ersatzwert, wenn der Wert leer ist.

'''Parameter'''

# String, der als Funktionsergebnis zurückgegeben wird
# String, der als Funktionsergebnis zurückgegeben wird, wenn der erste Parameter leer ist

'''Beispiel'''

sql where ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)

Liefert $PVAL einen leeren Wert zurück (z.B., weil die Gridzeile neu angelegt wurde und daher noch keine Nummer eingetragen ist), so wird statt dessen 0 verwendet, damit die WHERE-Klausel syntaktisch korrekt ist.

==$ONLYCHAR()==

Entfernt unerwünschte Zeichen aus einem String.

'''Parameter'''

# Der ursprüngliche String
# optional: Typ der Funktion
## (leer) - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben (['a'..'z', 'A'..'Z', 'ä', 'ö', 'ü', 'Ä','Ö', 'Ü', 'ß']) sind
## charnum - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind
## low - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Kleinbuchstaben
## upp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Großbuchstaben
## charnumlow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Kleinbuchstaben
## charnumupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Großbuchstaben
## uml - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben (['a'..'z', 'A'..'Z') sind, Umlaute werden konvertiert (ä -> ae, ö -> oe, ü -> ue, Ä -> Ae, Ö -> Oe, Ü -> Ue, ß -> ss)
## umlcharnum - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Umlaute werden konvertiert
## umllow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Kleinbuchstaben, Umlaute werden konvertiert
## umlupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben sind, Ergebnis in Großbuchstaben, Umlaute werden konvertiert
## umlcharnumlow - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Kleinbuchstaben, Umlaute werden konvertiert
## umlcharnumupp - Es werden alle Zeichen aus dem String entfernt, die keine Buchstaben oder Zahlen sind, Ergebnis in Großbuchstaben, Umlaute werden konvertiert
## no191 / not191 - Es werden alle Zeichen mit der ANSI-Nummer 191 (¿) entfernt

'''Beispiele'''

#coutl $ONLYCHAR(Baden-Württemberg)
#coutl $ONLYCHAR(Baden-Württemberg,umllow)

==$PAD()==

Füllt links oder rechts bis zur vorgegebenen Länge mit Zeichen auf.

'''Parameter'''

# Der ursprüngliche String
# Soll-Länge. Ist der ursprüngliche String bereits länger, wird er nicht gekürzt, es werden aber auch keine weiteren Zeichen hinzugefügt
# Wenn L, werden die Zeichen vorne hinzugefügt, andernfalls hinten
# Zeichen, die soweit und so oft hinzugefügt werden, bis die Soll-Länge erreicht ist. Umfasst der Parameter mehrere Zeichen, werden diese ggf. nicht alle hinzugefügt.
# optional: Länge, auf die der ursprüngliche String vor der weiteren Verarbeitung gekürzt wird.

'''Beispiel'''

sql text1 = '$PAD($VAR(text1),70,R, )'

==$RANDOM()==

Ermittelt einen zufälligen Wert

'''Parameter'''

# Typ des Ergebnisses
## curr - Zahl mit zwei Nachkommastellen in den Grenzen Parameter 2 - Parameter 3
## curr4 - Zahl mit vier Nachkommastellen in den Grenzen Parameter 2 - Parameter 3
## date - Datum in den Grenzen Parameter 2 - Parameter 3
## int - ganze Zahl in den Grenzen Parameter 2 - Parameter 3
## ld - Key einer Nachschlageliste, Name der Nachschlageliste im Parameter 2
## ldv - Value einer Nachschlageliste, Name der Nachschlageliste im Parameter 2
## ls - Key eines Specials, Name des Specials im Parameter 2
## lsv - Value eines Specials, Name des Specials im Parameter 2
## text, text2, text3... - Zeile eines Textes
# untere Grenze bzw. Name der Nachschlageliste oder des Specials
# obere Grenze

'''Beispiel'''

#coutl $RANDOM(date,01.01.2022,31.12.2022)
#coutl $RANDOM(text2)

==$SUBSTR()==

Kopiert aus dem String im ersten Parameter einen Teil der Zeichen.

(Hinweis: Selbe Funktionalität wie $COPY())

'''Parameter'''

# String, aus dem kopiert werden soll
# Position im String, ab dem Zeichen kopiert werden sollen
# optional: Anzahl der Zeichen, die kopiert werden sollen. Wenn dieser Parameter fehlt, werden alle Zeichen ab der angegebenen Position kopiert.

'''Beispiel'''

#grdcol f=ref c1="Ref" w=30 y=link ro=Y cmdn=xtodo_add(link,$SUBSTR($PVAL(grid,ctype,sel),1,2))

==$STREP()==

("string replace") Ersetzt Zeichen im String durch andere Zeichen.

'''Parameter'''

# String, in welchen Zeichen ersetzt werden sollen.
# Zeichen, die ersetzt werden sollen
# Zeichen, die an deren Stelle treten sollen
# optional: Optionen (kombinierbar)
## i - Groß- und Kleinschreibung ignorieren
## a - Alle Vorkommen ersetzen (andernfalls wird nur das erste Vorkommen ersetzt)

'''Beispiele'''

#page_val i=vl col=1 row=3 z="$STREP($PVAL(vl,1,2), ,_,a)"
#page_val i=vl col=1 row=3 z=$STREP($PVAL(vl,1,2),$CHR(space),_,a)

Hinweis: Beide Beispiele haben exakt dieselbe Funktion. Im oberen Beispiel steht das Leerzeichen direkt im Text, dafür muss der komplette Parameter in doppelte Anführungszeichen, im unteren Beispiel wird das Leerzeichen durch $CHR(space) eingefügt, dafür können die Leerzeichen unterbleiben.

==$STROP()==

("string operation") Sammelsurium von String-Operationen

'''Parameter'''

# Typ der Operation
## trim - entfernt führende und folgende Leerzeichen
## trimleft - entfernt führende Leerzeichen
## trimright - entferne folgende Leerzeichen
## quote - setzt den String in einfache Anführungszeichen
## unquote - entfernt einschließende einfache Anführungszeichen
## dquote - setzt den String in doppelte Anführungszeichen
## unqduote - entfernt einschließende doppelte Anführungszeichen
## ex_filepath - entspricht der Delphi-Funktion ExtractFilePath
## ex_filedir - entspricht der Delphi-Funktion ExtractFileDir
## ex_filedrive - entspricht der Delphi-Funktion ExtractFileDrive
## ex_filename - entspricht der Delphi-Funktion ExtractFileName
## ex_fileext - entspricht der Delphi-Funktion ExtractFileExt
# String, der bearbeitet werden soll

'''Beispiele'''

#cout c=$STROP(quote,Test)

==$STREXTR()==

("string extract") Extrahiert einen Teil aus einem String.

'''Parameter'''

# String, aus dem extrahiert werden soll
# Extraktionstyp
## ffe ("from first exclude") - Extrahiert ab der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## ffi ("from first include") - Extrahiert ab der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## tfe ("to first exclude") - Extrahiert bis zur Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## tfi ("to first include") - Extrahiert bis zur Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## fle ("from last exclude") - Extrahiert ab dem letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## fli ("from last include") - Extrahiert ab dem letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein
## tle ("to last exclude") - Extrahiert bis zum letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge aus
## tli ("to last include") - Extrahiert bis zum letzten Vorkommen der Zeichenfolge im dritten Parameter und schließt diese Zeichenfolge ein

# Trennzeichen

'''Beispiele'''

#cout c="$STREXTR(test;test2,ffe,;)" -- Ergebnis: test2
#cout c="$STREXTR(test;test2,ffi,;)" -- Ergebnis: ;test2
#cout c="$STREXTR(test;test2,tfe,;)" -- Ergebnis: test
#cout c="$STREXTR(test;test2,tfi,;)" -- Ergebnis: test;
#cout c="$STREXTR(test;!§§test2,tfe,;!§§)" -- Ergebnis: test

==$TRIM()==

Entfernt Leerzeichen und Zeilenumbrüche am Rand des Strings

'''Parameter'''

# String, der getrimmt werden soll
# optional
## L - trimmt nur auf der linken Seite
## R - trimmt nur auf der rechten Seite

'''Beispiel'''

#var_set n=test z=$TRIM($VAL(1),R)

==$UPP()==

Wandelt den übergebenen String in Großbuchstaben um.

'''Parameter'''

# String, der in Großbuchstaben gewandelt werden soll.

'''Beispiel'''

~ $UPP($EDT(edt1)) = BUS

==$VT()==

Die Funktion $VT ("Value Translate") ersetzt Werte durch andere. Groß- und Kleinschreibung wird beim Vergleich berücksichtigt.

'''Parameter'''

# String, dessen Inhalte ersetzt werden soll
# Else-Ergebnis; wird dann verwendet, wenn keine andere Entsprechung erkannt wird.
# Vergleichswert 1
# Ergebnis, wenn Vergleichswert 1 dem ersten Parameter entspricht
# Vergleichswert 2
# Ergebnis, wenn Vergleichswert 2 dem ersten Parameter entspricht
# Vergleichswert 3
# Ergebnis, wenn Vergleichswert 3 dem ersten Parameter entspricht
...

'''Beispiel'''

#coutl $VT(Frau,1,Herr,2,Frau,3)
-- Frau -> 3
-- Herr -> 2
-- Test -> 1
-- Firma -> 1

==$VTRDB()==

Die Funktion $VTRDB ("Value Translate Root Database") gibt eine String zurück, der von einem Wert im Datenbank-Segment der Root-Ini abhängt. Diese Ini-Datei (BafClientFM.ini im selben Verzeichnis wie die BafClientFM.exe) enthält die Datenbank-Zugangsdaten. Diese könnte den folgenden Block (Auszug) enthalten:

[DB_PGPROD]
prefix=prod
Name=Postgres PROD
DriverName=Postgres
Database=postgres
User=ttbaf3prodadmin
...

Der Wert in ''prefix'' spezifiziert, ob es sich um das Produktiv- oder das Test-System handelt. In Abhängigkeit davon gibt diese Funktion dann unterschiedliche Werte zurück. Es wird immer die Sektion der gerade ausgewählten Datenbank verwendet.

Der Hauptanwendungsfall dieser Funktion, die Notwendigkeit einer Änderung des Codes bei der Migration vom Test- in das Produktiv-System oder umgekehrt zu vermeiden. Statt dessen ermittelt die Funktion, ob sie gerade im Test- oder Produktiv-System ausgeführt wird und gibt den passenden Wert (Verzeichnis-Name, URL, ...) zurück.

'''Parameter'''

# Item (Ident) in der Root-Ini (die Sektion ist immer die der aktuell ausgewählten Datenbank)
# Vergleichswert 1
# Ergebnis, wenn Vergleichswert 1 dem Wert in der Ini-Datei entspricht
# Vergleichswert 2
# Ergebnis, wenn Vergleichswert 2 dem Wert in der Ini-Datei entspricht
...

'''Beispiele'''

#cout c="$VTRDB(prefix,test,Test-System,prod,Produktiv-System)"
#cout c="$VTRDB(prefix,test,C:\temp\export\busdaten,prod,T:\files\export\busdaten)"

==$VTVL()==

Die Funktion $VTVL ("Value Translate ValueList") ersetzt Werte durch andere. Groß- und Kleinschreibung wird beim Vergleich berücksichtigt.

Im Gegensatz zu $VT werden die zu prüfenden Werte und deren Entsprechungen nicht über Parameter übergeben, sondern aus einer Werte-Liste geholt, die in einem Text gespeichert sein muss.

Eine solche Werte-Liste lässt sich wie folgt aufbauen

key1=value1
key2=value2
key3=value3
key4=value4
...

Eine solche Werte-Liste lässt sich auch mit #sql_opentvl erzeugen, siehe Beispiel.

'''Parameter'''

# String, dessen Inhalte ersetzt werden soll
# Else-Ergebnis; wird dann verwendet, wenn keine andere Entsprechung erkannt wird.
# Nummer des Textes, in dem sich die Werteliste befindet.
...

'''Beispiel'''

#sql select userid as ckey, shortname as cvalue from user_user
#sql_opentvl n=1
#coutl $VTVL(591,(nicht gefunden),1)

==$XR()==

Die Funktion $XR ("XmlReplace") ersetzt in XML nicht zulässige Zeichen:
* aus & wird $amp ;
* aus < wird &lt ;
* aus > wird &gt ;
* aus " wird &quot ;
* aus ' wird &apos ;

(Hinweis: Das Leerzeichen vor dem Semikolon soll verhindern, dass die Zeichen hier in der Darstellung ersetzt werden und wird nicht eingefügt.)

'''Parameter'''

# String, dessen Zeichen ggf. ersetzt werden sollen

'''Beispiel'''

#text <firmenname>$XR($DATA(dat,firmenname))</firmenname>

==$XRR()==

Umkehrfunktion von $XR()
* aus $amp ; wird &
* aus &lt ; wird <
* aus &gt ; wird >
* aus &quot ; wird "
* aus &apos ; wird '

'''Parameter'''

# String, dessen Zeichen ggf. ersetzt werden sollen

=Integer-Funktionen=

Die folgenden Funktionen geben eine ganze Zahl zurück

==$DEC()==

Verringert die Zahl im ersten Parameter.

'''Parameter'''

# Zahl die verringert werden soll.
# optional: Zahl, um die verringert werden soll. Wenn nicht vorhanden, dann 1.

'''Beispiel'''

#setval n=1 z=$DEC($VAL(1))

==$ICALC()==

Führt eine Berechnung mit ganzzahligen Werten durch.

'''Parameter'''

# Operator, es stehen zur Verfügung
## +
## -
## *
## div
## mod
# Erste Zahl
# Zweite Zahl
# optional beim Operator +: weitere Summanden

'''Beispiel'''

#cout c=$ICALC(mod,17,5)

==$INC()==

Erhöht die Zahl im ersten Parameter.

'''Parameter'''

# Zahl die erhöht werden soll.
# optional: Zahl, um die erhöht werden soll. Wenn nicht vorhanden, dann 1.

'''Beispiel'''

#setval n=1 z=$INC($VAL(1))

==$INTLEN()==

Ist der String im Parameter eine ganz Zahl, dann wird deren Länge in Zeichen zurückgegeben, andernfalls -1; ein leerer String im ersten Parameter ergibt 0.

'''Parameter'''

# Zahl, deren Länge ermittelt wird.

'''Beispiel'''

~ $INTLEN($EDT(edt1)) = 4

==$LEN()==

Ermittelt die Länge eines Strings in Zeichen.

'''Parameter'''

# String, dessen Länge ermittelt werden soll.

'''Beispiel'''

~ $LEN($EDT(edt1)) = 4

==$LEVENSHTEIN()==

Ermittelt die Levenshtein-Distanz (https://de.wikipedia.org/wiki/Levenshtein-Distanz) der beiden übergebenen Strings

'''Parameter'''

# erster String
# zweiter String

'''Beispiel'''

#coutl $LEVENSHTEIN(alpha,beta)

==$POS()==

Ermittelt die Position des Substrings in einem String. Das Funktionsergebnis ist die Position, das erste Zeichen ist 1. 0 wird zurück gegeben, wenn der Substring im String nicht vorkommt.

'''Parameter'''

# Substring (nach dem gesucht wird)
# String (in dem gesucht wird)
# optional: Wenn ic (ignore case), dann wird bei der Suche die Groß- und Kleinschreibung nicht beachtet.

'''Beispiel'''

~ $POS($EDT(edt1),$VAR(1),ic) > 0

==$RANDOM()==

Ermittelt einen zufälligen Wert zwischen der oberen und unteren Grenze

'''Parameter'''

# Typ
## int - zufällige Ganzzahl
## date - zufälliges Datum
## curr - zufällige Zahl mit zwei Nachkommastellen
## curr4 - zufällige Zahl mit vier Nachkommastellen
## text1, text2, text3... - zufällige Zeile aus dem jeweiligen Text; text ist text1; untere und obere Grenze bleiben unberücksichtigt
## ld - zufälliger Schlüssel-Wert aus einer Nachschlageliste. Der Name der Nachschlageliste ist als zweiter Parameter (untere Grenze) zu übergeben
## ldv - zufälliger Text aus einer Nachschlageliste. Der Name der Nachschlageliste ist als zweiter Parameter (untere Grenze) zu übergeben
## ls - zufälliger Schlüssel-Wert aus einem Special. Der Name des Specials ist als zweiter Parameter (untere Grenze) zu übergeben
## lsv - zufälliger Text aus einem Special. Der Name des Specials ist als zweiter Parameter (untere Grenze) zu übergeben
# untere Grenze
# obere Grenze

'''Beispiel'''

#coutl $RANDOM(int,1,6)

=Datumsfunktionen=

==$INCDATE()==

Die Funktione $INCDATE() verändert das Datum im ersten Parameter um die Anzahl Tage im zweiten Parameter.

'''Parameter'''

# Datum, das verändert werden soll
# optional: Die Tage, um die verändert werden soll; wenn leer, dann 1.

'''Beispiel'''

#cout c=$INCDATE($NOW(),-3) clr=Y

==$INT2TIME()==

Macht aus z.B. 1130 die Zeit 11:30

'''Parameter'''

# Zeit im Integer-Format

'''Beispiel'''

#sql_exec k_time=$INT2TIME($VAL(1))

==$NOW()==

Gibt das aktuelle Datum und die aktuelle Uhrzeit im Format dd.mm.yyyy hh:mm:ss zurück.

'''Parameter'''

(keine)

'''Beispiel'''

#execsql k_datechg=$NOW()

==$NOWFMT()==

Gibt das aktuelle Datum und/oder die aktuelle Uhrzeit im angegebenen Format zurück.

'''Parameter'''

# Formatierungsstring (Syntax wie FormatDateTime in Delphi)

'''Beispiel'''

#sql_exec k_datechg="$NOWFMT(yyyy-mm-dd hh:mm:ss)"

==$NOWMIN()==

Gibt das aktuelle Datum und die aktuelle Uhrzeit ohne Sekunden (also dd.mm.yyyy hh:mm) zurück

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec k_datechg=$NOWMIN()

==$TODAY()==

Gibt das aktuelle Datum im Format dd.mm.yyyy zurück.

Hinweis: Wenn das Datum in einem anderen Format benötigt wird, ist $NOWFMT() das Mittel der Wahl.

'''Parameter'''

(keine)

'''Beispiel'''

#sql_exec k_datechg=$TODAY()

==$DFMT()==

("date formated") Formatiert das übergebene Datum.

'''Parameter'''

# Datum, ggf. mit Uhrzeit, das formatiert werden soll.
# Formatierungsstring wie in Delphi
# optional: Wenn hn ("hide null"), dann wird ein leerer String zurück gegeben, wenn das Datum kleiner/gleich 1

'''Beispiel'''

#sql_exec k_datechg="$DFMT($NOW(),yyyy-mm-dd hh:mm:ss)"

=Bool'sche Funktionen=

Die folgenden Funktionen geben Y oder N zurück.

==$BFMT()==

Formatiert einen bool'schen Wert

'''Parameter'''

# Bool'scher Wert
# optional: Ergebnis, wenn Wert Y ('y', 'J', 'j', '1') ist, default Y
# optional: Ergebnis, wenn Wert N (also nicht 'Y', 'y', 'J', 'j', '1') ist, default N

'''Beispiel'''
#cout c=$BFMT($VAR(test),x,)

==$BOOL()==

Wertet das bool'sche Statement im Parameter aus.

'''Operatoren'''

* = gleich
* == gleich ohne Berücksichtigung der Groß- und Kleinschreibung
* <> ungleich
* != ungleich
* > größer
* >= größer gleich
* < kleiner
* <= kleiner gleich
* and Und-Verknüpfung
* or ODER-Verknüpfung

Hinweis: Die Statements werden von links nach rechts ausgewertet, and und or sind gleichwetig, gegebenenfalls müssen Klammern eingesetzt werden.

'''Parameter'''

# Bool'sches Statement, das ausgewertet wird

'''Beispiel'''

#cout c="$BOOL((17 > 22) or (5 > 3))"
#cout c="$BOOL(17 > 22 or 5 > 3)"

==$DATECOMP()==

Gibt Y zurück, wenn Datum 2 Operator Datum 1 zutreffend ist. Ansonsten wird N zurückgegeben.

Wird kein Operator angegeben, dann wird die Anzahl der Tage Datum 2 - Datum 1 als Zahl zurückgegeben.

'''Parameter'''

# Datum 1
# Datum 2
# Operator

'''Beispiel'''

#cout c="$DATECOMP(01.01.2024,17.04.2024,<)"
#cout c="$DATECOMP(01.01.2024,17.04.2024)"

==$DATEMINREL()==

Gibt Y zurück, wenn das Datum im ersten Parameter nicht kleiner ("minimal gleich") dem aktuellen Datum ist, das um die Anzahl Tage im zweiten Parameter verändert wurde. Wird gerne verwendet, um das Erreichen von Deadlines zu prüfen.

'''Parameter'''

# Datum, das geprüft wird
# Anzahl an Tage, die dem aktuellen Datum vor der Prüfung hinzu addiert werden

'''Beispiel'''

~ $DATEMINREL($DATA(n,datum), 3)

==$DATEMAXREL()==

Gibt Y zurück, wenn das Datum im ersten Parameter nicht größer ("maximal gleich") dem aktuellen Datum ist, das um die Anzahl Tage im zweiten Parameter verändert wurde. Wird gerne verwendet, um das Erreichen von Deadlines zu prüfen.

'''Parameter'''

# Datum, das geprüft wird
# Anzahl an Tage, die dem aktuellen Datum vor der Prüfung hinzu addiert werden

'''Beispiel'''

~ $DATEMAXREL($DATA(n,datum), 3)

==$DATEBETWEEN==

Gibt Y zurück, wenn das Datum des ersten Parameters im angegebenen Bereich liegt.

Alle Paremeter, die sich nicht in ein Datum wandeln lassen, werden zu 0 (30.12.1899) konvertiert.

'''Parameter'''

# Wert, der geprüft wird
# Untere Grenze des Bereichs
# Obere Grenze des Bereichs
# und weitere: Das Ergebnis ist auch dann Y, wenn der erste Parameter diesem Datum entspricht.

'''Beispiel'''

#cout c="Test $DATEBETWEEN($TODAY(),1.1.2020,2.2.2022)"

==$EMPTY()==

Gibt Y zurück, wenn der Parameter ein leerer String ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# String, der geprüft wird

'''Beispiel'''

~ $EMPTY($DATE(n,grpname))

==$EMPTYVAR()==

Gibt Y zurück, wenn die Variable ein leerer String ist, deren Name im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Name der Variable

'''Beispiel'''

~ $EMPTYVAR(buchungsnr)

==$IN()==

Gibt Y zurück, wenn sich der erste Parameter in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INIC() beachtet

'''Parameter'''

# Wert, der geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Die erste Anweisung gibt Y und die zweite N zurück

#cout c="$IN(beta,alpha,beta,gamma,delta)"
#cout c="$IN(beta,alpha,BETA,gamma,delta)"

==$INIC()==

Gibt Y zurück, wenn sich der erste Parameter in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $IN() nicht beachtet beachtet

'''Parameter'''

# Wert, der geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Beide Anweisungen geben Y zurück

#cout c="$INIC(beta,alpha,beta,gamma,delta)"
#cout c="$INIC(beta,alpha,BETA,gamma,delta)"

==$INVAR()==

Gibt Y zurück, wenn sich die Variable, deren Namen im ersten Parameter steht, in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INICVAR() beachtet

'''Parameter'''

# Name der Variable, die geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Die erste Anweisung gibt Y und die zweite N zurück

#var_set n=test z=beta
#cout c="$INVAR(test,alpha,beta,gamma,delta)"
#cout c="$INVAR(test,alpha,BETA,gamma,delta)"

==$INICVAR()==

Gibt Y zurück, wenn sich die Variable, deren Namen im ersten Parameter steht, in der Menge der nachfolgenden Parameter befindet. Groß- und Kleinschreibung wird im Gegensatz zu $INVAR() nicht beachtet

'''Parameter'''

# Name der Variable, die geprüft wird
# Liste, gegen die geprüft wird

'''Beispiel'''

Beide Anweisungen geben Y zurück

#var_set n=test z=beta
#cout c="$INVAR(test,alpha,beta,gamma,delta)"
#cout c="$INVAR(test,alpha,BETA,gamma,delta)"

==$ISCURR()==

Gibt Y zurück, wenn sich der Parameter in einen Currency-Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird

'''Beispiel'''

~ $ISCURR($DATA(n,rechnungssumme))

==$ISDATE()==

Gibt Y zurück, wenn sich der Parameter in ein Datums- oder DatumsZeit-Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird
# Prüfoperation, default ist date
## date - prüft, ob in ein Datum gewandelt werden kann
## datetime - prüft, ob in ein Datums-Zeit-Wert gewandelt werden kann

'''Beispiel'''

~ $ISDATE($DATA(n,beginn))

==$ISINT()==

Gibt Y zurück, wenn sich der Parameter in einen ganzzahligen Wert wandeln lässt

'''Parameter'''

# Wert, der geprüft wird

'''Beispiel'''

~ $ISINT($DATA(n,tage))

==$INTMAX()==

Gibt Y zurück, wenn die Zahl im ersten Parameter nicht größer ("maximal gleich") als die Zahl im zweiten Parameter ist.

'''Parameter'''

# Zahl, die verglichen wird
# Zahl. mit der vergleichen wird

'''Beispiel'''

~ $INTMAX($DATA(n,lfdnr), 17)

==$INTMIN()==

Gibt Y zurück, wenn die Zahl im ersten Parameter nicht kleiner ("minimal gleich") als die Zahl im zweiten Parameter ist.

'''Parameter'''

# Zahl, die verglichen wird
# Zahl. mit der vergleichen wird

'''Beispiel'''

~ $INTMIN($DATA(n,lfdnr), 17)

==$NEMPTY()==

("not empty") Gibt Y zurück, wenn der Parameter nicht leer ist.

'''Parameter'''

# String, dessen Inhalt geprüft wird. Leerzeichen gelten als leerer String.

'''Beispiel'''

~ $NEMPTY($EDT(edt1))

==$NEMPTYVAR()==

Gibt Y zurück, wenn die Variable kein leerer String ist, deren Name im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Name der Variable

'''Beispiel'''

~ $NEMPTYVAR(kundennr)

==$NOT==

Invertiert einen bool'schen Wert. Aus Y (y, J, j, 1) wird N und aus N wird Y.

'''Parameter'''

# Wert, der invertiert wird

'''Beispiel'''

#coutl $NOT(2)

==$NUMBETWEEN==

Gibt Y zurück, wenn die Zahl des ersten Parameters im angegebenen Bereich liegt.

Alle Paremeter, die sich nicht in eine Zahl wandeln lassen, werden zu 0 konvertiert.

'''Parameter'''

# Wert, der geprüft wird
# Untere Grenze des Bereichs
# Obere Grenze des Bereichs
# und weitere: Das Ergebnis ist auch dann Y, wenn der erste Parameter dieser Zahl entspricht. Siehe Beispiel.

'''Beispiele'''

#page_check c="Die Schuhgröße muss zwischen 28 und 56 liegen" chk="$NUMBETWEEN($PVAL(vl,schuhgroesse),28,56)"
#page_check c="Die Schuhgröße muss zwischen 28 und 56 liegen" chk="$NUMBETWEEN($PVAL(vl,schuhgroesse),28,56,)"

Die beiden Beispiele unterscheiden sich auf den ersten Blick kaum. Bei der ersten Zeile muss jedoch eine Schuhgröße eingegeben werden. Bleibt das Feld im VL-Segment leer, so wird dieser fehlende Wert nach 0 konvertiert und liegt nicht zwischen 28 und 56.

Anders bei der zweiten Zeile: Das Komma vor der schließenden Klammer sorgt für einen vierten Parameter, der ebenfalls leer ist und damit nach 0 gewandelt wird. Auf diese Weise werden die leere Eingaben (und die Eingabe von 0) gültig.

==$REGEX()==

Die Funktion $REGEX() ("regular expressions") prüft, ob der String in Parameter 1 den Anforderungen von Parameter 2 entspricht (Ergebnis Y) oder nicht (Ergebnis N).

'''Parameter'''

# String, der geprüft werden soll
# Regulärer Ausdruck, mit dem der String in Parameter 2 geprüft wird.

'''Beispiel'''

~ $REGEX($VAR(med),^[A-Z]{3}$)

==$TEXT_HASLINE()==

Die Funktion $TEXT_HASLINE() prüft, ob die als Parameter 2 übergebene Textzeile in einem Text vorkommt. Es wird nur auf komplette Textzeilen geprüft. Wird zum Beispiel verwendet, um eine Liste von Kundennummern zu erstellen, und dann auf einzelne Nummern zu prüfen.

'''Parameter'''

# Nummer des Textes
# Textzeile, deren Vorkommen geprüft wird
# Ergebnis, wenn die Textzeile vorkommt; default Y
# Ergebnis, wenn die Textzeile nicht vorkommt; default N

'''Beispiel'''

#coutl $TEXT_HASLINE(1,990000018,1,0)

==$VIBAN()==

Die Funktion $VIBAN() ("validate IBAN") prüft eine IBAN anhand der Prüfziffern (3. und 4. Stelle).

'''Parameter'''

# IBAN, die geprüft werden soll

'''Beispiel'''

#coutl $VIBAN(DE12345)

=Currency-Funktionen=

==$CCALC()==

Führt eine Berechnung mit Festkommawerten durch

'''Operatoren'''

** + - Addition
** - - Subtraktion
** * - Multiplikation
** / - Division
** % - Division und Multiplikation des Ergebnisses mit 100
** +4 - Addition und Ausgabe mit 4 Nachkommastellen
** -4 - Subtraktion und Ausgabe mit 4 Nachkommastellen
** *4 - Multiplikation und Ausgabe mit 4 Nachkommastellen
** /4 - Division und Ausgabe mit 4 Nachkommastellen
** %4 - Division, Multiplikation des Ergebnisses mit 100 und Ausgabe mit 4 Nachkommastellen

** B, b, B4, b4 - Bruttobetrag, erster Parameter ist der Netto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** E, e, E4, e4 - Enthaltene MWSt, erster Parameter ist der Brutto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** M, m, M4, m4 - MWSt, erster Parameter ist der Netto-Betrag, zweiter Parameter ist der MWSt-Satz in %
** N, n, N4, n4 - Nettobetrag, erster Parameter ist der Brutto-Betrag, zweiter Parameter ist der MWSt-Satz in %

'''Parameter'''

# Operator
# und weitere: Operanden

'''Beispiele'''

-- Ergebnis 10
#cout c="$CCALC(+,1,2,3,4)"
-- Ergebnis 16,67
#cout c="$CCALC(/,100,2,3)"

#val_set n=1 z=1038,87
#coutl $CCALC(N,$VAL(1),19) - $CCALC(E,$VAL(1),19) -

==$CURR()==

Currency-Werte müssen in Funktionen mit einem Punkt als Dezimaltrennzeichen eingegeben werden, da das Komma die Parameter trennt. Sofern Konstanten verwendet werden, lässt sich das einfach so eingeben, sobald aber die Werte aus anderen Funktionen kommen (zum Beispiel $DATA()), müssen sie dann mit $CURR() in dieses Format umgewandelt werden.

'''Parameter'''

# Vorkommastellen
# Nachkommastellen

'''Beispiel'''

-- Ergebnis 43,48
#cout c="$CCALC(/,100,$CURR(2,3))"
-- zum Vergleich; Ergebnis 16,67
#cout c="$CCALC(/,100,2,3)"

==$CFMT()==

Formatiert Curreny-Werte

'''Parameter'''

# Wert
# optional: Formatierungsstring, default 0.00
# optional: wenn hn ("hide null"), dann werden leere Strings als Wert auch als leerer String ausgegeben

'''Beispiel'''

#val_set n=1 z=###,###,###,##0.00
#val_set n=2 z=1337,42
#cout c=$CFMT($VAL(2),$VAL(1))

==$ONLYNUM()==

Stellt sicher, dass in einem String nur Zahlen (ggf. auch Kommas oder Punkte) enthalten sind.

'''Parameter'''

# Zahl
# Art der Operation; default numkomma
## flnnc ("from last not numeric character") - Ab dem letzten Zeichen, das keine Ziffer ist
## num - Nur Ziffern, alle anderen Zeichen werden entfernt
## numkomma - Nur Ziffern und Kommata, alle anderen Zeichen werden entfernt
## numpoint - Nur Ziffern und Punkte, alle anderen Zeichen werden entfernt
## ufnnc ("until first not numeric character") - vom Anfang bis zum ersten Zeichen, das keine Ziffer ist

'''Beispiel'''
-- Ergebnis 123456
#coutl $ONLYNUM(123-456,num)
-- Ergebnis 123
#coutl $ONLYNUM(123-456,ufnnc)
-- Ergebnis 456
#coutl $ONLYNUM(123-456,flnnc)

Interpreter

2026-05-06T09:09:00Z

Michaelebner: /* #tab_new */

Im Interpreter sind nur wenige Prozeduren und Funktionen direkt implementiert. Die meisten Routinen finden sich in den Modulen.

=Values=

Im Gegensatz zu Variablen ist der Gültigkeitsbereich von Values auf das jeweilige (Primär- oder Sub-) Kommando beschränkt. Values haben Nummern, während Variable Namen haben.

==#val_set==

Setzt der Wert für einen Value.

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie (if empty) - Wenn der Wert von z leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei Oracle; Funktionen werden ersetzt
*n - Nummer des Values
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht vorliegt; default ist ''frm''
*rf (replace functions) - Wenn Y, dann werden nach der Zuweisung auf den Value nochmals die Funktionen ersetzt. Wird zum Beispiel benötigt, wenn Code mit Funktionen mittels $DATA() aus der Datenbank geladen wird; Funktionen werden ersetzt, default N; siehe Beispiel
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String

'''Beispiele'''

#val_set n=7 z=$GUID()
#val_set n=1 z=$GUID() r=admin

-- Zum Parameter rf: $NOW() in die Zwischenablage kopieren und dann ausführen
#val_set n=1 z=$CLIPBOARD() rf=N
#message c=$VAL(1)
#val_set n=1 z=$CLIPBOARD() rf=Y
#message c=$VAL(1)

==#val_add==

<nowiki>#val_add fügt einem Value einen Wert hinzu.</nowiki>

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*n - Nummer des Values; zwingend erforderlich
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''.
* y -Typ der Operation; default ''text''
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** text - Der Wert wird als Text hinzugefügt
*z - Wert, welcher dem Value hinzugefügt wird, Funktionen werden ersetzt, default ist ein leerer String oder eine 0

'''Beispiel'''

#val_set n=1 z=$NOW()
#val_add n=1 z=1 y=datetime
#cout c=$VAL(1)

==#val_clearall==

Löscht alle Values. Wird selten benötigt, da die Values mit Ende des (Primär- oder Sub-) Kommandos ohnehin ihre Gültigkeit verlieren.

'''Parameter'''

(keine)

'''Beispiel'''

#val_clearall

==$VAL()==

Gibt den Inhalt eines Values zurück

'''Parameter'''

# Nummer des Values

'''Beispiel'''

#cout c=$VAL(3)

==$EMPTYVAL()==

Gibt Y zurück, wenn der Value ein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $EMPTYVAL(1)

==$NEMPTYVAL()==

Gibt Y zurück, wenn der Value kein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $NEMPTYVAL(2)

=Log=

==#exception_info==

Tritt eine Exception auf, dann wird die entsprechende Fehlermeldung in das Log geschrieben. Mit #exception_info kann eine Information ergänzt werden, die vor diese Fehlermeldung gesetzt wird. Üblicherweise wird das dazu verwendet, um eine ID zu schreiben, damit der fehlerhafte Datensatz gefunden wird.

'''Parameter'''

* z - Wert, welcher vor die Fehlermeldung geschrieben wird.

'''Beispiel'''

#exception_info z=$DATA(dat,knd_nr)

==#log==

Schreibt einen Text in das Log.

'''Parameter'''

* c ("caption") - Text, der in das Log geschrieben wird; Funktionen werden ersetzt; default ist ''#log, Parameter c nicht gesetzt''
* y - Typ des Log-Eintrags; default I. Vorgesehen sind die folgenden Typen:
** E - Error
** I - Info
** W - Warning

'''Beispiel'''

#log y=W c="Ermittelte Summe untypisch gering"

==#logi==

Schreibt einen Text als Info in das Log.

'''Parameter'''

Die Prozedur #logi hat keine benannten Parameter. Der komplette Text nach dem #logi und dem folgenden Leerzeichen wird in das Log geschrieben; Funktionen werden ersetzt.

'''Beispiel'''

#logi Berechnung beendet

=Kommandos=

==#tab_new==

Öffnet einen neuen Tab im BAF-Client und führt dort ein Kommando aus.

'''Parameter'''

* c ("caption") - Beschriftung des neuen Tabs; Funktionen werden ersetzt
* cmd ("command") - Kommando, das im neuen Tab ausgeführt wird; Funktionen werden ersetzt
* debug - Wenn Y, wird für den neuen Tab das Debug-Log aktiviert; Default N, Funktionen werden ersetzt

'''Beispiel'''

#tab_new c=xuser cmd=xuser($PAGE(link))

==#code_open==

Öffnet den Code-Dialog und geht zum entsprechenden Kommando

'''Parameter'''

* cmd ("command") - Kommando, das im Code-Dialog selektiert wird
* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.

'''Beispiel'''

#btns_btn c="Direkt zum Code" w=130 cmd="#code_open cmd=$PVAL(vl,cmd)"

==$CP()==

("command parameter") - Greift auf einen Parameter des Kommandos zu.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.

'''Beispiel'''

#page_fill d=$CP(1)

==$ICP()==

("is command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit einem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $ICP(0,ex)
~ $ICP(0,ex,im,new)

==$INCP()==

("is not command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit keinem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $INCP(0,ex)
~ $INCP(0,ex,im,new)

=Internes=

Die folgenden Funktionen werden für interne Zwecke verwendet:

* $INTER() - Name des Interpreters
* $HISTSQL() - SQL-Statement für den History-Dialog
* $HISTTABLE() - Tabellenname der History-Tabelle
* $HISTMEMOFIELD() - Feldname des Memo-Feldes für den History-Dialog

Archiv

2026-01-11T12:09:07Z

Michaelebner: /* 31.12.2023 */

===30.06.2024===
* [[Versionen| Neue Version: BAF-Client 1.01]]

===31.12.2023===
* [[Versionen| Neue Version: BAF-Client 1.00]]
* Youtube-Video: [https://www.youtube.com/watch?v=tCAL7MmKO6c| Version 1.00 (19:24)]

===23.7.2023===
* [[Versionen| Neue Version: BAF-Client 0.99]]

===26.03.2023===
* [[Versionen| Neue Version: BAF-Client 0.98]]

===26.02.2023===
* [[Versionen| Neue Version: BAF-Client 0.97]]
* [https://www.youtube.com/watch?v=HKDW09g7ikc| Video Version 0.97 (5:51)]

===29.01.2023===
* [[Versionen| Neue Version: BAF-Client 0.96]]

===31.12.2022===
*[[beispiele_rest_json|Neues Beispiel: Daten von einem REST-Server holen, anzeigen und bearbeiten (längeres Tutorial)]]

===24.12.2022===
* [[Versionen| Neue Version: BAF-Client 0.95]]

===03.12.2022===

* Video [https://youtu.be/gdUh9S_KEAQ| BIC ergänzen (10:11)]
* Video [https://youtu.be/XenPgo0OTn8| Version 0.91 (4:45)]
* [[Versionen| Neue Version: BAF-Client 0.91]]

===27.11.2022===

* Video [https://www.youtube.com/watch?v=95NUxGX6R1k| BAF-Server einrichten (13:01)]
* [[Versionen_Server| Erste Version: BAF-Server 0.1 / SerProc 0.9]]

===26.11.2022===

* Video [https://www.youtube.com/watch?v=iarhXOJJVuA| Version 0.9 (7:28)]
* [[Versionen| Neue Version: BAF-Client 0.9]]

===25.11.2022===

* Video: [https://www.youtube.com/watch?v=6_Ngk-EJmuY| Threads (8:53)]

===19.11.2022===

* Video: [https://www.youtube.com/watch?v=u7JVPvnB0es| Dialoge erstellen (15:53)]
* Video: [https://www.youtube.com/watch?v=5yXkC2B0jQM| Länderkürzel anlegen (11:32)]

===19.11.2022===

* Video: [https://www.youtube.com/watch?v=tUtmq1l11ls| Version 0.8 (13:54)]
* [[Versionen| Neue Version: BAF-Client 0.8]]

===13.11.2022===

* Video: [https://www.youtube.com/watch?v=iJxdU6A9NrE| User und Rechte (21:49)]
* Video: [https://www.youtube.com/watch?v=c1NYgMhP1F8| User importieren (28:11)]
* Video: [https://www.youtube.com/watch?v=PrENFgNIwpY| Testdaten und $RANDOM (16:14)]

===12.11.2022===

* Video: [https://www.youtube.com/watch?v=P8aK_vkmlcI| Text (10:51)]
* Video: [https://www.youtube.com/watch?v=cWvvcC8QVZo| INI verwenden (4:11)]

===29.10.2022===

* Video: [https://www.youtube.com/watch?v=_HGqS9_R_Xc| xsql - ein simples SQL-Tool (21:29)]
* Video: [https://www.youtube.com/watch?v=83sqJmoC068| Zusaätzliche Datenbank einbinden (5:35)]
* Video: [https://www.youtube.com/watch?v=u-71YXZlcRk| Variable und Values (9.30)]

===23.10.2022===

* [[Versionen| Neue Version: BAF-Client 0.7]]
* Video: [https://www.youtube.com/watch?v=St3fj1WB098| Die Sprache BAL (7:20)]
* Video: [https://www.youtube.com/watch?v=R2ceP0UYgoY| PDFs erstellen (8:11)]
* Video: [https://www.youtube.com/watch?v=RDJBGeG1xsA| BAF-Client 0.7 (3:21)]

Hauptseite

2026-01-11T12:08:55Z

Michaelebner: /* Aktuelles */

=BAF/BAL=

BAF steht für ''Business Applications Framework''

BAL steht für ''Business Applications Language''

==Aktuelles==

===11.01.2026===
* [[Versionen| Neue Version: BAF-Client 1.04]]

===13.07.2025===
* [[Versionen| Neue Version: BAF-Client 1.03]]

===25.12.2024===
* [[Versionen| Neue Version: BAF-Client 1.02]]

[[Archiv]]

==Was ?==

BAF ist eine Framework zur schnellen Entwicklung von Datenbankanwendungen im Business-Umfeld.

==Warum?==

Kurzfassung: Für schnelle Entwicklung

[[Gruende|Langfassung: Gründe für die Entwiklung von BAF/BAL]]

==Wo ?==

[[Versionen|BAF-Client Download-Seite]]

[[Videos|Videos]]

==Lizenz==

Das Framework steht unter der [[bful|BAF fair use license]], einer unkomplizierten OpenSource-Lizenz.

==BAF Client==

Der BAF-Client ist sowohl IDE als auch Benutzeroberfläche für den Endanwender.

*[[BC_Login|Der Login-Dialog]]
*[[BC_Programmfenster|Programmfenster]]
*[[BC_Typisch|typisches Formular]]
*[[BC_Code_|Code]]
*[[BC_SGWizard|Code - Simple Grid Wizard]]
*[[BC_SqlOpen|Code - SQL Open / SQL Open 2]]
*[[BC_SqlExec|Code - SQL Exec]]
*[[BC_Tools|Code - Tools]]
*[[BC_Lists|Code - Lists]]
*[[BC_Debug|Debug]]
*[[BC_Migration|Migration]]

==BAF Server==

[[Versionen_Server|BAF-Server Download-Seite]]

[[Videos|Videos]]

==Datenbanken==

*[[BafClientFmIni|Datenbanken einbinden mit der BafClientFM.ini]]
*[[DbBesonderheiten|Besonderheiten der unterstützten Datenbanksysteme]]

==Sprache und Bibliotheken==

*[[BAL|Die Sprache BAL]]
*[[Interpreter|Interpreter]]
*[[Modul VAR neu|Modul VAR]]
*[[Modul DB|Modul DB]]
*[[Modul Form|Modul Form]]
*[[Modul Translation|Modul Translation]]
*[[Modul Web|Modul Web]]
*[[Modul XML|Modul XML]]
*[[Modul JSON|Modul JSON]]
*[[Modul PDF|Modul PDF]]
*[[Modul XLS|Modul XLS]]
*[[beispiele|Beispiele]]

==Die Standard-Module==

Mit den Standard-Modulen werden die Standard-Aufgaben in einer Datenbankanwendung abgedeckt.

*[[xuser|xuser - Benutzerverwaltung]]
*[[xlookup|xlookup - Nachschlagelisten]]
*[[xspecial|xspecial - Nachschlagelisten aus SQL-Abfragen]]
*[[xdevtext|xdevtext - Entwicklertexte]]
*[[xmenu|xmenu - Das Menü]]
*[[xtranslation|xtranslation - Übersetzung]]
*[[xsettings|xsettings - Benutzereinstellungen]]
*[[xtodo|xtodo - Aufgabenliste]]

==[[Impressum|Impressum]]==

Versionen Server

2026-01-11T12:08:19Z

Michaelebner: /* BAF-Server 0.1 mit SrvProc 1.03 */

=BAF-Server Download=

* Einfach die ZIP-Datei entpacken
* Datenbank in der Ini passend zum Client einrichten
* Tabellen und xserver im BAF-Client ergänzen
* Den BAF-Server einfach mit der Datei pBafServer.exe starten

* Video [https://www.youtube.com/watch?v=95NUxGX6R1k| BAF-Server einrichten (13:01)]

==BAF-Server 0.1 mit SrvProc 1.04==

Download Server (bs_v1_04.zip, 26.427 KB)[[https://bafbal.de/downloads/bs_v1_04.zip]]

==BAF-Server 0.1 mit SrvProc 1.03==

Download (bs_v1_03.zip, 26.420 KB)[[https://bafbal.de/downloads/bs_v1_03.zip]]

==BAF-Server 0.1 mit SrvProc 1.02==

Download (bs_v1_02.zip, 25.071 KB)[[https://bafbal.de/downloads/bs_v1_02.zip]]

==BAF-Server 0.1 mit SrvProc 0.98==

Download (bs_v0_98.zip, 24.577 KB)[[https://bafbal.de/downloads/bs_v0_98.zip]]

==BAF-Server 0.1 mit SrvProc 0.97==

Download (bs_v0_97.zip, 24.572 KB)[[https://bafbal.de/downloads/bs_v0_97.zip]]

==BAF-Server 0.1 mit SrvProc 0.96==

Download (bs_v0_96.zip, 24.569 KB)[[https://bafbal.de/downloads/bs_v0_96.zip]]

==BAF-Server 0.1 mit SrvProc 0.95==

Download (bs_v0_95.zip, 24.518 KB)[[https://bafbal.de/downloads/bs_v0_95.zip]]

==BAF-Server 0.1 mit SrvProc 0.9==

Download (bs_v0_9.zip, 24,5 MB)[[https://bafbal.de/downloads/bs_v0_9.zip]]

Versionen

2026-01-11T12:07:30Z

Michaelebner: /* Version 1.04 */

=BAF-Client Download=

* Einfach die ZIP-Datei entpacken und dann erst mal die beiliegenden Fonts installieren (recht Maustaste, "Installieren")
* Den BAF-Client einfach mit der Datei BafCLientFM.exe starten
* Username und Passwort (admin/admin) kommen aus der Ini-Datei. Vor dem Produktivbetrieb das Passwort dort löschen und in der Userverwaltung abändern.

==Version 1.04==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Var: #exec_async, $VTRDB()
* DB: #sql_openkvl
* Form: #grd_lookupliveclear
* XML: $XML_VALEX()
* XLS: #xls_delete_sheet

Download Client (bc3_v1_04.zip, 25.971 KB)[[https://bafbal.de/downloads/bc3_v1_04.zip]]

Download Server (bs_v1_04.zip, 26.427 KB)[[https://bafbal.de/downloads/bs_v1_04.zip]]

==Version 1.03==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Die Suche kann nun auf die Kommandos in den Favoriten beschränkt werden.
* Int: $EMPTYVAL(), $NEMPTYVAL()
* Var: $CONVERT(), $DATECOMP(), $EMPTYVAR(), $NEMPTYVAR()
* DB: #sql_openval hat nun die Parameter af und de
* Form: #tree_node hat nun den Parameter iek, $GRD_REGEX(), S-Grid (#sgrd_seg, #sgrd_node, #sgrd_hf, #sgrd_data), #grd_data kennt nun auch q=text
* Web: #email_init hat nun den Parameter sasl, #email_send hat nun den Parameter fn_list
* JSON: $JSON_ARRAY_VALUE(), $JSON_LFR()
* PDF: #pdf_text hat nun den Parameter d

Download Client (bc3_v1_03.zip, 25.880 KB)[[https://bafbal.de/downloads/bc3_v1_03.zip]]

Download Server (bs_v1_03.zip, 26.420 KB)[[https://bafbal.de/downloads/bs_v1_03.zip]]

==Version 1.02==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Var: #file_wait, $BFMT(), $CFMT()
* Form: #dlg, #dlg_close
* XML: $XML_VALEX()
* Code-Dialog: Es wurde die Seite ''Fav'' und die entsprechende Checkbox auf der Seite ''Code'' hinzugefügt. Um dies nutzen zu können, muss die folgende Tabelle existieren:

create table sys_userfav(
name varchar(80) not null,
user_user_id varchar(40) not null
)

Download Client (bc3_v1_02.zip, 23.627 KB)[[https://bafbal.de/downloads/bc3_v1_02.zip]]

Download Server (bs_v1_02.zip, 25.071 KB)[[https://bafbal.de/downloads/bs_v1_02.zip]]

==Version 1.01==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Interpreter: Funktion $INCP() ergänzt (if not command parameter)
* DB: #sql_upsert2 (gibt es den Datensatz noch nicht, wird er angelegt, haben sich die Daten geändert, werden sie geschrieben)
* Form: $DLG_YESNO() (Dialog mit Yes/No)
* Form: #tree_clearnode (Entfernt einen Zweig, damit er neu aufgebaut werden kann)
* Form: #grd_dub (ermittelt Dubletten in einem Grid)
* XML: $XML_DATATEXT (ermittelt ein XML in einer Schleife)
* XML: $XML_LFR (loop first regex)
* XLS: #xls_load (öffnet eine XLS-Datei)
* XLS: #xls_looprows (loop über die Zeilen einer XLS-Datei)
* XLS: $XLS_COUNT() (ermittelt die Anzahl von Sheets, Zeilen oder Zellen)
* XLS: $XLS_CELL() (Gibt der Wert einer Zelle aus)

Download Client (bc3_v1_01.zip, 23.620 KB)[[https://bafbal.de/downloads/bc3_v1_01.zip]]

Download Server (bs_v1_01.zip, 25.067 KB)[[https://bafbal.de/downloads/bs_v1_01.zip]]

==Version 1.00==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Im Code-Dialog wurde die Seite ''Open SQL'' überarbeitet und auf drei solche Seiten erweitert
*[[Modul_VAR_neu#.23csv_check|#csv_check]] Prüft eine CSV-Datei
*[[Modul_VAR_neu#.24CSV_LINE.28.29|$CSV_LINE()]] Gibt eine ganze Zeile einer CSV-Datei zurück
*[[Modul_VAR_neu#.23tvl_add|#tvl_add]] Addiert einem Wert in einer Text-Value-Liste einen Wert hinzu
*[[Modul_VAR_neu#.23exit|#exit]] Bricht die Ausführung eines (Sub-)Kommandos ab
*[[Modul_VAR_neu#.24STROP.28.29|$STROP()]] Verschiedene String-Bearbeitungen wie Trim, Quote oder Unquote
*[[Modul_Form#.24CCI.28.29|$CCI()]] Ermittelt die zu setzende Zellen-Farbe
*[[Modul_Form#.23grd_sort|#grd_sort]] Sortiert ein Grid
*[[Modul_Form#.23grd_pos|#grd_pos]] Ermittelt das erste Vorkommen einer Zeile, deren Zelleninhalte den Kriterien entsprechen

Download Client (bc3_v1_00.zip, 23.476 KB)[[https://bafbal.de/downloads/bc3_v1_00.zip]]

Download Server (bs_v1_00.zip, 25.040 KB)[[https://bafbal.de/downloads/bs_v1_00.zip]]

==Version 0.99==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Vereinzelt wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier meist nicht aufgeführt sind)

*[[Modul_VAR_neu#.23text_act|#text_act]] Bearbeitet einen Text
*[[Modul_VAR_neu#.24FILEINFO.28.29|$FILEINFO()]] Liefert Infos zu einer Datei
*[[Modul_VAR_neu#.23zip_create|#zip_create]] Erzeugt eine ZIP-Datei
*[[Modul_VAR_neu#.24LEVENSHTEIN.28.29|$LEVENSHTEIN()]] Ermittelt die Levensthein-Distanz (Größe bei einem String-Vergleich)
*[[Modul_VAR_neu#.24RANDOM.28.29_2|$RANDOM()]] Erzeugt eine Zufalls-Zahl
* Bei Konsolen-Programmen kann nun auf den Bestätigungsdialog verzichtet werden, siehe [[Modul_Form#.23frm|#frm]]
* Bei [[Modul_Form#.23tree_sel|#tree_sel]] können nun auch Unterknoten durchsucht werden.
*[[Modul_Form#.23tree_fillthread|#tree_fillthread]] - Ergänzt den Baum in einem Thread (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23vl_thread|#vl_thread]] Ergänzt die Daten in einem VL-Segment (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23xgrd_calc|#xgrd_calc]] Berechnet einen Wert in einem XGrid-Segment
*[[Modul_Form#.24XGRD_CALC|$XGRD_CALC()]] Berechnet einen Wert in einem XGrid-Segment, aber als Funktion
*[[Modul_Form#XXGrid-Segmente|XX-Grid-Segmente]] (mehrere Prozeduren)
*[[Modul_XML#.23xml_gav|#xml_gav]] Holt die Array-Werte aus einem XML
* In [[Modul_JSON#.24JSON_DATA|$JSON_DATA()]] können nun auch Namen ausgelesen werden
* In [[Modul_XLS#.23xls_cell|#xls_cell]] kann nun auch die vertikale Ausrichtung in einer Zelle spezifiziert werden.

Download Client (bc3_v0_99.zip, 23.345 KB)[[https://bafbal.de/downloads/bc3_v0_99.zip]]

Download Server (bs_v0_99.zip, 24.935 KB)[[https://bafbal.de/downloads/bs_v0_99.zip]]

==Version 0.98==

* Im GridWizard funktioniert nun der Hint der Spaltenüberschriften
* Links funktionieren nun im VL-Segment
* #tree_sel erweitert
* #sql_opentvl
* #sql_line
* Lookups, Specials und Kommandos cachen nun
* XGrid und XXGrid stretchen nun
* grd_thread y=gridlist
* #grd_seg und #vl_seg - whs
* Werte werden nun nur vom Grid in den Baum zurück geschrieben, wenn sie tatsächlich geändert wurden
* #tree_fillthread
* Prozessabbruch beim Fortschrittsdialog wird nun resettet
* cmd no_crlf
* Verbesserung von dateMin und dateSek
* $INCP
* Pos1 und End im Grid
* Wizzard für csv und xlsx
* Beim Debug-Fenster Select werden nun nicht mehr die Selects angezeigt, die Commands holen

Download Client (bc3_v0_98.zip, 20.246 KB)[[https://bafbal.de/downloads/bc3_v0_98.zip]]

Download Server (bs_v0_98.zip, 24.577 KB)[[https://bafbal.de/downloads/bs_v0_98.zip]]

==Version 0.97==

* #grd_ac ergänzt
* $INCLUDE() ergänzt
* $ONLYNUM() ergänzt
* Fehler beim Parsen von XML behoben
* UserIni wird nun beim ServerProzess beim Ende gespeichert
* Cursor beim Login-Dialog

Download Client (bc3_v0_97.zip, 20.236 KB)[[https://bafbal.de/downloads/bc3_v0_97.zip]]

Download Server (bs_v0_97.zip, 24.572 KB)[[https://bafbal.de/downloads/bs_v0_97.zip]]

==Version 0.96==

* TBafTree Scrollbar bei langen Listen gleich
* #ftp_connect Parameter isc
* #email_init Parameter port, isc und to
* Menu scrollt nun richtig
* PDF Grid (#pdf_gdef, #pdf_grow, #pdf_gend)
* #upsert, y=c und n
* Performance Log
* Debug, Request and Response
* History Statement bei anderen DB
* PG, AlterTable, AlterHistory, Leerzeilen in CREATE TABLE kein Problem mehr bei Funktionen
* Vorbelegung Username aus INI beim Login-Dialog
* Baum kann mit Tasten gesteuert werden
* Page, kleinere Bugs behoben, TAB nun auch bei VL-Segment
* $ISDATE ergänzt

Download Client (bc3_v0_96.zip, 20.232 KB)[[https://bafbal.de/downloads/bc3_v0_96.zip]]

Download Server (bs_v0_96.zip, 24.569 KB)[[https://bafbal.de/downloads/bs_v0_96.zip]]

==Version 0.95==

* REST und JSON
* Bilder
* ein wenig XML
* tvl bei Nachschlagelisten

Download Client (bc3_v0_95.zip, 24.541 KB)[[https://bafbal.de/downloads/bc3_v0_95.zip]]

Download Server (bs_v0_95.zip, 24.518 KB)[[https://bafbal.de/downloads/bs_v0_95.zip]]

==Version 0.91==

* TBafTree
* uServer und uServer2
* Parameter isc bei #http_request

Download (bc3_v0_91.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_91.zip]]

==Version 0.9==

* Werden Texte in Nachschlagelisten geladen, werden nun Funktionen (z.B. Übersetzungen) ersetzt
* Werden nach einer Änderung im Tree Werte in den Baum zurückgeschrieben, wird nicht nur - wie bisher - c1 und c2 geschrieben, sondern auch k. Zudem werden nun Funktionen ersetzt
* Wurde bei VL-Wizard nachgebessert
* lookuptext
* Die Listen im Code-Dialog wurden erweitert
* Funktion $BASE64

Download (bc3_v0_9.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_9.zip]]

==Version 0.8==

* Grid- und VL-Wizard
* SQL-Creator
* Dialoge

Download (bc3_v0_8.zip, 19,87 MB)[[https://bafbal.de/downloads/bc3_v0_8.zip]]

==Version 0.7==

Download nicht mehr verfügbar

==Version 0.3 "Public Preview"==

Hinweise:

Download (copy_303.zip, 9,39 MB)[[https://bafbal.de/downloads/copy_303.zip]]

Versionen

2026-01-11T12:07:12Z

Michaelebner: /* Version 1.04 */

=BAF-Client Download=

* Einfach die ZIP-Datei entpacken und dann erst mal die beiliegenden Fonts installieren (recht Maustaste, "Installieren")
* Den BAF-Client einfach mit der Datei BafCLientFM.exe starten
* Username und Passwort (admin/admin) kommen aus der Ini-Datei. Vor dem Produktivbetrieb das Passwort dort löschen und in der Userverwaltung abändern.

==Version 1.04==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

Var: #exec_async, $VTRDB()
DB: #sql_openkvl
Form: #grd_lookupliveclear
XML: $XML_VALEX()
XLS: #xls_delete_sheet

Download Client (bc3_v1_04.zip, 25.971 KB)[[https://bafbal.de/downloads/bc3_v1_04.zip]]

Download Server (bs_v1_04.zip, 26.427 KB)[[https://bafbal.de/downloads/bs_v1_04.zip]]

==Version 1.03==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Die Suche kann nun auf die Kommandos in den Favoriten beschränkt werden.
* Int: $EMPTYVAL(), $NEMPTYVAL()
* Var: $CONVERT(), $DATECOMP(), $EMPTYVAR(), $NEMPTYVAR()
* DB: #sql_openval hat nun die Parameter af und de
* Form: #tree_node hat nun den Parameter iek, $GRD_REGEX(), S-Grid (#sgrd_seg, #sgrd_node, #sgrd_hf, #sgrd_data), #grd_data kennt nun auch q=text
* Web: #email_init hat nun den Parameter sasl, #email_send hat nun den Parameter fn_list
* JSON: $JSON_ARRAY_VALUE(), $JSON_LFR()
* PDF: #pdf_text hat nun den Parameter d

Download Client (bc3_v1_03.zip, 25.880 KB)[[https://bafbal.de/downloads/bc3_v1_03.zip]]

Download Server (bs_v1_03.zip, 26.420 KB)[[https://bafbal.de/downloads/bs_v1_03.zip]]

==Version 1.02==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Var: #file_wait, $BFMT(), $CFMT()
* Form: #dlg, #dlg_close
* XML: $XML_VALEX()
* Code-Dialog: Es wurde die Seite ''Fav'' und die entsprechende Checkbox auf der Seite ''Code'' hinzugefügt. Um dies nutzen zu können, muss die folgende Tabelle existieren:

create table sys_userfav(
name varchar(80) not null,
user_user_id varchar(40) not null
)

Download Client (bc3_v1_02.zip, 23.627 KB)[[https://bafbal.de/downloads/bc3_v1_02.zip]]

Download Server (bs_v1_02.zip, 25.071 KB)[[https://bafbal.de/downloads/bs_v1_02.zip]]

==Version 1.01==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Interpreter: Funktion $INCP() ergänzt (if not command parameter)
* DB: #sql_upsert2 (gibt es den Datensatz noch nicht, wird er angelegt, haben sich die Daten geändert, werden sie geschrieben)
* Form: $DLG_YESNO() (Dialog mit Yes/No)
* Form: #tree_clearnode (Entfernt einen Zweig, damit er neu aufgebaut werden kann)
* Form: #grd_dub (ermittelt Dubletten in einem Grid)
* XML: $XML_DATATEXT (ermittelt ein XML in einer Schleife)
* XML: $XML_LFR (loop first regex)
* XLS: #xls_load (öffnet eine XLS-Datei)
* XLS: #xls_looprows (loop über die Zeilen einer XLS-Datei)
* XLS: $XLS_COUNT() (ermittelt die Anzahl von Sheets, Zeilen oder Zellen)
* XLS: $XLS_CELL() (Gibt der Wert einer Zelle aus)

Download Client (bc3_v1_01.zip, 23.620 KB)[[https://bafbal.de/downloads/bc3_v1_01.zip]]

Download Server (bs_v1_01.zip, 25.067 KB)[[https://bafbal.de/downloads/bs_v1_01.zip]]

==Version 1.00==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Im Code-Dialog wurde die Seite ''Open SQL'' überarbeitet und auf drei solche Seiten erweitert
*[[Modul_VAR_neu#.23csv_check|#csv_check]] Prüft eine CSV-Datei
*[[Modul_VAR_neu#.24CSV_LINE.28.29|$CSV_LINE()]] Gibt eine ganze Zeile einer CSV-Datei zurück
*[[Modul_VAR_neu#.23tvl_add|#tvl_add]] Addiert einem Wert in einer Text-Value-Liste einen Wert hinzu
*[[Modul_VAR_neu#.23exit|#exit]] Bricht die Ausführung eines (Sub-)Kommandos ab
*[[Modul_VAR_neu#.24STROP.28.29|$STROP()]] Verschiedene String-Bearbeitungen wie Trim, Quote oder Unquote
*[[Modul_Form#.24CCI.28.29|$CCI()]] Ermittelt die zu setzende Zellen-Farbe
*[[Modul_Form#.23grd_sort|#grd_sort]] Sortiert ein Grid
*[[Modul_Form#.23grd_pos|#grd_pos]] Ermittelt das erste Vorkommen einer Zeile, deren Zelleninhalte den Kriterien entsprechen

Download Client (bc3_v1_00.zip, 23.476 KB)[[https://bafbal.de/downloads/bc3_v1_00.zip]]

Download Server (bs_v1_00.zip, 25.040 KB)[[https://bafbal.de/downloads/bs_v1_00.zip]]

==Version 0.99==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Vereinzelt wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier meist nicht aufgeführt sind)

*[[Modul_VAR_neu#.23text_act|#text_act]] Bearbeitet einen Text
*[[Modul_VAR_neu#.24FILEINFO.28.29|$FILEINFO()]] Liefert Infos zu einer Datei
*[[Modul_VAR_neu#.23zip_create|#zip_create]] Erzeugt eine ZIP-Datei
*[[Modul_VAR_neu#.24LEVENSHTEIN.28.29|$LEVENSHTEIN()]] Ermittelt die Levensthein-Distanz (Größe bei einem String-Vergleich)
*[[Modul_VAR_neu#.24RANDOM.28.29_2|$RANDOM()]] Erzeugt eine Zufalls-Zahl
* Bei Konsolen-Programmen kann nun auf den Bestätigungsdialog verzichtet werden, siehe [[Modul_Form#.23frm|#frm]]
* Bei [[Modul_Form#.23tree_sel|#tree_sel]] können nun auch Unterknoten durchsucht werden.
*[[Modul_Form#.23tree_fillthread|#tree_fillthread]] - Ergänzt den Baum in einem Thread (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23vl_thread|#vl_thread]] Ergänzt die Daten in einem VL-Segment (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23xgrd_calc|#xgrd_calc]] Berechnet einen Wert in einem XGrid-Segment
*[[Modul_Form#.24XGRD_CALC|$XGRD_CALC()]] Berechnet einen Wert in einem XGrid-Segment, aber als Funktion
*[[Modul_Form#XXGrid-Segmente|XX-Grid-Segmente]] (mehrere Prozeduren)
*[[Modul_XML#.23xml_gav|#xml_gav]] Holt die Array-Werte aus einem XML
* In [[Modul_JSON#.24JSON_DATA|$JSON_DATA()]] können nun auch Namen ausgelesen werden
* In [[Modul_XLS#.23xls_cell|#xls_cell]] kann nun auch die vertikale Ausrichtung in einer Zelle spezifiziert werden.

Download Client (bc3_v0_99.zip, 23.345 KB)[[https://bafbal.de/downloads/bc3_v0_99.zip]]

Download Server (bs_v0_99.zip, 24.935 KB)[[https://bafbal.de/downloads/bs_v0_99.zip]]

==Version 0.98==

* Im GridWizard funktioniert nun der Hint der Spaltenüberschriften
* Links funktionieren nun im VL-Segment
* #tree_sel erweitert
* #sql_opentvl
* #sql_line
* Lookups, Specials und Kommandos cachen nun
* XGrid und XXGrid stretchen nun
* grd_thread y=gridlist
* #grd_seg und #vl_seg - whs
* Werte werden nun nur vom Grid in den Baum zurück geschrieben, wenn sie tatsächlich geändert wurden
* #tree_fillthread
* Prozessabbruch beim Fortschrittsdialog wird nun resettet
* cmd no_crlf
* Verbesserung von dateMin und dateSek
* $INCP
* Pos1 und End im Grid
* Wizzard für csv und xlsx
* Beim Debug-Fenster Select werden nun nicht mehr die Selects angezeigt, die Commands holen

Download Client (bc3_v0_98.zip, 20.246 KB)[[https://bafbal.de/downloads/bc3_v0_98.zip]]

Download Server (bs_v0_98.zip, 24.577 KB)[[https://bafbal.de/downloads/bs_v0_98.zip]]

==Version 0.97==

* #grd_ac ergänzt
* $INCLUDE() ergänzt
* $ONLYNUM() ergänzt
* Fehler beim Parsen von XML behoben
* UserIni wird nun beim ServerProzess beim Ende gespeichert
* Cursor beim Login-Dialog

Download Client (bc3_v0_97.zip, 20.236 KB)[[https://bafbal.de/downloads/bc3_v0_97.zip]]

Download Server (bs_v0_97.zip, 24.572 KB)[[https://bafbal.de/downloads/bs_v0_97.zip]]

==Version 0.96==

* TBafTree Scrollbar bei langen Listen gleich
* #ftp_connect Parameter isc
* #email_init Parameter port, isc und to
* Menu scrollt nun richtig
* PDF Grid (#pdf_gdef, #pdf_grow, #pdf_gend)
* #upsert, y=c und n
* Performance Log
* Debug, Request and Response
* History Statement bei anderen DB
* PG, AlterTable, AlterHistory, Leerzeilen in CREATE TABLE kein Problem mehr bei Funktionen
* Vorbelegung Username aus INI beim Login-Dialog
* Baum kann mit Tasten gesteuert werden
* Page, kleinere Bugs behoben, TAB nun auch bei VL-Segment
* $ISDATE ergänzt

Download Client (bc3_v0_96.zip, 20.232 KB)[[https://bafbal.de/downloads/bc3_v0_96.zip]]

Download Server (bs_v0_96.zip, 24.569 KB)[[https://bafbal.de/downloads/bs_v0_96.zip]]

==Version 0.95==

* REST und JSON
* Bilder
* ein wenig XML
* tvl bei Nachschlagelisten

Download Client (bc3_v0_95.zip, 24.541 KB)[[https://bafbal.de/downloads/bc3_v0_95.zip]]

Download Server (bs_v0_95.zip, 24.518 KB)[[https://bafbal.de/downloads/bs_v0_95.zip]]

==Version 0.91==

* TBafTree
* uServer und uServer2
* Parameter isc bei #http_request

Download (bc3_v0_91.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_91.zip]]

==Version 0.9==

* Werden Texte in Nachschlagelisten geladen, werden nun Funktionen (z.B. Übersetzungen) ersetzt
* Werden nach einer Änderung im Tree Werte in den Baum zurückgeschrieben, wird nicht nur - wie bisher - c1 und c2 geschrieben, sondern auch k. Zudem werden nun Funktionen ersetzt
* Wurde bei VL-Wizard nachgebessert
* lookuptext
* Die Listen im Code-Dialog wurden erweitert
* Funktion $BASE64

Download (bc3_v0_9.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_9.zip]]

==Version 0.8==

* Grid- und VL-Wizard
* SQL-Creator
* Dialoge

Download (bc3_v0_8.zip, 19,87 MB)[[https://bafbal.de/downloads/bc3_v0_8.zip]]

==Version 0.7==

Download nicht mehr verfügbar

==Version 0.3 "Public Preview"==

Hinweise:

Download (copy_303.zip, 9,39 MB)[[https://bafbal.de/downloads/copy_303.zip]]

Versionen

2026-01-11T12:00:30Z

Michaelebner: /* Version 1.04 */

=BAF-Client Download=

* Einfach die ZIP-Datei entpacken und dann erst mal die beiliegenden Fonts installieren (recht Maustaste, "Installieren")
* Den BAF-Client einfach mit der Datei BafCLientFM.exe starten
* Username und Passwort (admin/admin) kommen aus der Ini-Datei. Vor dem Produktivbetrieb das Passwort dort löschen und in der Userverwaltung abändern.

==Version 1.04==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

Download Client (bc3_v1_04.zip, 25.971 KB)[[https://bafbal.de/downloads/bc3_v1_04.zip]]

Download Server (bs_v1_04.zip, 26.427 KB)[[https://bafbal.de/downloads/bs_v1_04.zip]]

==Version 1.03==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Die Suche kann nun auf die Kommandos in den Favoriten beschränkt werden.
* Int: $EMPTYVAL(), $NEMPTYVAL()
* Var: $CONVERT(), $DATECOMP(), $EMPTYVAR(), $NEMPTYVAR()
* DB: #sql_openval hat nun die Parameter af und de
* Form: #tree_node hat nun den Parameter iek, $GRD_REGEX(), S-Grid (#sgrd_seg, #sgrd_node, #sgrd_hf, #sgrd_data), #grd_data kennt nun auch q=text
* Web: #email_init hat nun den Parameter sasl, #email_send hat nun den Parameter fn_list
* JSON: $JSON_ARRAY_VALUE(), $JSON_LFR()
* PDF: #pdf_text hat nun den Parameter d

Download Client (bc3_v1_03.zip, 25.880 KB)[[https://bafbal.de/downloads/bc3_v1_03.zip]]

Download Server (bs_v1_03.zip, 26.420 KB)[[https://bafbal.de/downloads/bs_v1_03.zip]]

==Version 1.02==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Var: #file_wait, $BFMT(), $CFMT()
* Form: #dlg, #dlg_close
* XML: $XML_VALEX()
* Code-Dialog: Es wurde die Seite ''Fav'' und die entsprechende Checkbox auf der Seite ''Code'' hinzugefügt. Um dies nutzen zu können, muss die folgende Tabelle existieren:

create table sys_userfav(
name varchar(80) not null,
user_user_id varchar(40) not null
)

Download Client (bc3_v1_02.zip, 23.627 KB)[[https://bafbal.de/downloads/bc3_v1_02.zip]]

Download Server (bs_v1_02.zip, 25.071 KB)[[https://bafbal.de/downloads/bs_v1_02.zip]]

==Version 1.01==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Interpreter: Funktion $INCP() ergänzt (if not command parameter)
* DB: #sql_upsert2 (gibt es den Datensatz noch nicht, wird er angelegt, haben sich die Daten geändert, werden sie geschrieben)
* Form: $DLG_YESNO() (Dialog mit Yes/No)
* Form: #tree_clearnode (Entfernt einen Zweig, damit er neu aufgebaut werden kann)
* Form: #grd_dub (ermittelt Dubletten in einem Grid)
* XML: $XML_DATATEXT (ermittelt ein XML in einer Schleife)
* XML: $XML_LFR (loop first regex)
* XLS: #xls_load (öffnet eine XLS-Datei)
* XLS: #xls_looprows (loop über die Zeilen einer XLS-Datei)
* XLS: $XLS_COUNT() (ermittelt die Anzahl von Sheets, Zeilen oder Zellen)
* XLS: $XLS_CELL() (Gibt der Wert einer Zelle aus)

Download Client (bc3_v1_01.zip, 23.620 KB)[[https://bafbal.de/downloads/bc3_v1_01.zip]]

Download Server (bs_v1_01.zip, 25.067 KB)[[https://bafbal.de/downloads/bs_v1_01.zip]]

==Version 1.00==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Im Code-Dialog wurde die Seite ''Open SQL'' überarbeitet und auf drei solche Seiten erweitert
*[[Modul_VAR_neu#.23csv_check|#csv_check]] Prüft eine CSV-Datei
*[[Modul_VAR_neu#.24CSV_LINE.28.29|$CSV_LINE()]] Gibt eine ganze Zeile einer CSV-Datei zurück
*[[Modul_VAR_neu#.23tvl_add|#tvl_add]] Addiert einem Wert in einer Text-Value-Liste einen Wert hinzu
*[[Modul_VAR_neu#.23exit|#exit]] Bricht die Ausführung eines (Sub-)Kommandos ab
*[[Modul_VAR_neu#.24STROP.28.29|$STROP()]] Verschiedene String-Bearbeitungen wie Trim, Quote oder Unquote
*[[Modul_Form#.24CCI.28.29|$CCI()]] Ermittelt die zu setzende Zellen-Farbe
*[[Modul_Form#.23grd_sort|#grd_sort]] Sortiert ein Grid
*[[Modul_Form#.23grd_pos|#grd_pos]] Ermittelt das erste Vorkommen einer Zeile, deren Zelleninhalte den Kriterien entsprechen

Download Client (bc3_v1_00.zip, 23.476 KB)[[https://bafbal.de/downloads/bc3_v1_00.zip]]

Download Server (bs_v1_00.zip, 25.040 KB)[[https://bafbal.de/downloads/bs_v1_00.zip]]

==Version 0.99==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Vereinzelt wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier meist nicht aufgeführt sind)

*[[Modul_VAR_neu#.23text_act|#text_act]] Bearbeitet einen Text
*[[Modul_VAR_neu#.24FILEINFO.28.29|$FILEINFO()]] Liefert Infos zu einer Datei
*[[Modul_VAR_neu#.23zip_create|#zip_create]] Erzeugt eine ZIP-Datei
*[[Modul_VAR_neu#.24LEVENSHTEIN.28.29|$LEVENSHTEIN()]] Ermittelt die Levensthein-Distanz (Größe bei einem String-Vergleich)
*[[Modul_VAR_neu#.24RANDOM.28.29_2|$RANDOM()]] Erzeugt eine Zufalls-Zahl
* Bei Konsolen-Programmen kann nun auf den Bestätigungsdialog verzichtet werden, siehe [[Modul_Form#.23frm|#frm]]
* Bei [[Modul_Form#.23tree_sel|#tree_sel]] können nun auch Unterknoten durchsucht werden.
*[[Modul_Form#.23tree_fillthread|#tree_fillthread]] - Ergänzt den Baum in einem Thread (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23vl_thread|#vl_thread]] Ergänzt die Daten in einem VL-Segment (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23xgrd_calc|#xgrd_calc]] Berechnet einen Wert in einem XGrid-Segment
*[[Modul_Form#.24XGRD_CALC|$XGRD_CALC()]] Berechnet einen Wert in einem XGrid-Segment, aber als Funktion
*[[Modul_Form#XXGrid-Segmente|XX-Grid-Segmente]] (mehrere Prozeduren)
*[[Modul_XML#.23xml_gav|#xml_gav]] Holt die Array-Werte aus einem XML
* In [[Modul_JSON#.24JSON_DATA|$JSON_DATA()]] können nun auch Namen ausgelesen werden
* In [[Modul_XLS#.23xls_cell|#xls_cell]] kann nun auch die vertikale Ausrichtung in einer Zelle spezifiziert werden.

Download Client (bc3_v0_99.zip, 23.345 KB)[[https://bafbal.de/downloads/bc3_v0_99.zip]]

Download Server (bs_v0_99.zip, 24.935 KB)[[https://bafbal.de/downloads/bs_v0_99.zip]]

==Version 0.98==

* Im GridWizard funktioniert nun der Hint der Spaltenüberschriften
* Links funktionieren nun im VL-Segment
* #tree_sel erweitert
* #sql_opentvl
* #sql_line
* Lookups, Specials und Kommandos cachen nun
* XGrid und XXGrid stretchen nun
* grd_thread y=gridlist
* #grd_seg und #vl_seg - whs
* Werte werden nun nur vom Grid in den Baum zurück geschrieben, wenn sie tatsächlich geändert wurden
* #tree_fillthread
* Prozessabbruch beim Fortschrittsdialog wird nun resettet
* cmd no_crlf
* Verbesserung von dateMin und dateSek
* $INCP
* Pos1 und End im Grid
* Wizzard für csv und xlsx
* Beim Debug-Fenster Select werden nun nicht mehr die Selects angezeigt, die Commands holen

Download Client (bc3_v0_98.zip, 20.246 KB)[[https://bafbal.de/downloads/bc3_v0_98.zip]]

Download Server (bs_v0_98.zip, 24.577 KB)[[https://bafbal.de/downloads/bs_v0_98.zip]]

==Version 0.97==

* #grd_ac ergänzt
* $INCLUDE() ergänzt
* $ONLYNUM() ergänzt
* Fehler beim Parsen von XML behoben
* UserIni wird nun beim ServerProzess beim Ende gespeichert
* Cursor beim Login-Dialog

Download Client (bc3_v0_97.zip, 20.236 KB)[[https://bafbal.de/downloads/bc3_v0_97.zip]]

Download Server (bs_v0_97.zip, 24.572 KB)[[https://bafbal.de/downloads/bs_v0_97.zip]]

==Version 0.96==

* TBafTree Scrollbar bei langen Listen gleich
* #ftp_connect Parameter isc
* #email_init Parameter port, isc und to
* Menu scrollt nun richtig
* PDF Grid (#pdf_gdef, #pdf_grow, #pdf_gend)
* #upsert, y=c und n
* Performance Log
* Debug, Request and Response
* History Statement bei anderen DB
* PG, AlterTable, AlterHistory, Leerzeilen in CREATE TABLE kein Problem mehr bei Funktionen
* Vorbelegung Username aus INI beim Login-Dialog
* Baum kann mit Tasten gesteuert werden
* Page, kleinere Bugs behoben, TAB nun auch bei VL-Segment
* $ISDATE ergänzt

Download Client (bc3_v0_96.zip, 20.232 KB)[[https://bafbal.de/downloads/bc3_v0_96.zip]]

Download Server (bs_v0_96.zip, 24.569 KB)[[https://bafbal.de/downloads/bs_v0_96.zip]]

==Version 0.95==

* REST und JSON
* Bilder
* ein wenig XML
* tvl bei Nachschlagelisten

Download Client (bc3_v0_95.zip, 24.541 KB)[[https://bafbal.de/downloads/bc3_v0_95.zip]]

Download Server (bs_v0_95.zip, 24.518 KB)[[https://bafbal.de/downloads/bs_v0_95.zip]]

==Version 0.91==

* TBafTree
* uServer und uServer2
* Parameter isc bei #http_request

Download (bc3_v0_91.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_91.zip]]

==Version 0.9==

* Werden Texte in Nachschlagelisten geladen, werden nun Funktionen (z.B. Übersetzungen) ersetzt
* Werden nach einer Änderung im Tree Werte in den Baum zurückgeschrieben, wird nicht nur - wie bisher - c1 und c2 geschrieben, sondern auch k. Zudem werden nun Funktionen ersetzt
* Wurde bei VL-Wizard nachgebessert
* lookuptext
* Die Listen im Code-Dialog wurden erweitert
* Funktion $BASE64

Download (bc3_v0_9.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_9.zip]]

==Version 0.8==

* Grid- und VL-Wizard
* SQL-Creator
* Dialoge

Download (bc3_v0_8.zip, 19,87 MB)[[https://bafbal.de/downloads/bc3_v0_8.zip]]

==Version 0.7==

Download nicht mehr verfügbar

==Version 0.3 "Public Preview"==

Hinweise:

Download (copy_303.zip, 9,39 MB)[[https://bafbal.de/downloads/copy_303.zip]]

Versionen

2026-01-11T11:58:36Z

Michaelebner: /* Version 1.03 */

=BAF-Client Download=

* Einfach die ZIP-Datei entpacken und dann erst mal die beiliegenden Fonts installieren (recht Maustaste, "Installieren")
* Den BAF-Client einfach mit der Datei BafCLientFM.exe starten
* Username und Passwort (admin/admin) kommen aus der Ini-Datei. Vor dem Produktivbetrieb das Passwort dort löschen und in der Userverwaltung abändern.

==Version 1.04==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren sowie wesentliche Parameterergänzungen. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

Download Client (bc3_v1_04.zip, 25.971 KB)[[https://bafbal.de/downloads/bc3_v1_04.zip]]

Download Server (bs_v1_04.zip, 26.427 KB)[[https://bafbal.de/downloads/bs_v1_04.zip]]

==Version 1.02==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Var: #file_wait, $BFMT(), $CFMT()
* Form: #dlg, #dlg_close
* XML: $XML_VALEX()
* Code-Dialog: Es wurde die Seite ''Fav'' und die entsprechende Checkbox auf der Seite ''Code'' hinzugefügt. Um dies nutzen zu können, muss die folgende Tabelle existieren:

create table sys_userfav(
name varchar(80) not null,
user_user_id varchar(40) not null
)

Download Client (bc3_v1_02.zip, 23.627 KB)[[https://bafbal.de/downloads/bc3_v1_02.zip]]

Download Server (bs_v1_02.zip, 25.071 KB)[[https://bafbal.de/downloads/bs_v1_02.zip]]

==Version 1.01==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Interpreter: Funktion $INCP() ergänzt (if not command parameter)
* DB: #sql_upsert2 (gibt es den Datensatz noch nicht, wird er angelegt, haben sich die Daten geändert, werden sie geschrieben)
* Form: $DLG_YESNO() (Dialog mit Yes/No)
* Form: #tree_clearnode (Entfernt einen Zweig, damit er neu aufgebaut werden kann)
* Form: #grd_dub (ermittelt Dubletten in einem Grid)
* XML: $XML_DATATEXT (ermittelt ein XML in einer Schleife)
* XML: $XML_LFR (loop first regex)
* XLS: #xls_load (öffnet eine XLS-Datei)
* XLS: #xls_looprows (loop über die Zeilen einer XLS-Datei)
* XLS: $XLS_COUNT() (ermittelt die Anzahl von Sheets, Zeilen oder Zellen)
* XLS: $XLS_CELL() (Gibt der Wert einer Zelle aus)

Download Client (bc3_v1_01.zip, 23.620 KB)[[https://bafbal.de/downloads/bc3_v1_01.zip]]

Download Server (bs_v1_01.zip, 25.067 KB)[[https://bafbal.de/downloads/bs_v1_01.zip]]

==Version 1.00==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Es wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier nicht aufgeführt sind)

* Im Code-Dialog wurde die Seite ''Open SQL'' überarbeitet und auf drei solche Seiten erweitert
*[[Modul_VAR_neu#.23csv_check|#csv_check]] Prüft eine CSV-Datei
*[[Modul_VAR_neu#.24CSV_LINE.28.29|$CSV_LINE()]] Gibt eine ganze Zeile einer CSV-Datei zurück
*[[Modul_VAR_neu#.23tvl_add|#tvl_add]] Addiert einem Wert in einer Text-Value-Liste einen Wert hinzu
*[[Modul_VAR_neu#.23exit|#exit]] Bricht die Ausführung eines (Sub-)Kommandos ab
*[[Modul_VAR_neu#.24STROP.28.29|$STROP()]] Verschiedene String-Bearbeitungen wie Trim, Quote oder Unquote
*[[Modul_Form#.24CCI.28.29|$CCI()]] Ermittelt die zu setzende Zellen-Farbe
*[[Modul_Form#.23grd_sort|#grd_sort]] Sortiert ein Grid
*[[Modul_Form#.23grd_pos|#grd_pos]] Ermittelt das erste Vorkommen einer Zeile, deren Zelleninhalte den Kriterien entsprechen

Download Client (bc3_v1_00.zip, 23.476 KB)[[https://bafbal.de/downloads/bc3_v1_00.zip]]

Download Server (bs_v1_00.zip, 25.040 KB)[[https://bafbal.de/downloads/bs_v1_00.zip]]

==Version 0.99==

(In der Liste der Neuerungen sind nur ergänzte Funktionen und Prozeduren. Vereinzelt wurden auch bei bestehenden Prozeduren und Funktionen Parameter ergänzt, die hier meist nicht aufgeführt sind)

*[[Modul_VAR_neu#.23text_act|#text_act]] Bearbeitet einen Text
*[[Modul_VAR_neu#.24FILEINFO.28.29|$FILEINFO()]] Liefert Infos zu einer Datei
*[[Modul_VAR_neu#.23zip_create|#zip_create]] Erzeugt eine ZIP-Datei
*[[Modul_VAR_neu#.24LEVENSHTEIN.28.29|$LEVENSHTEIN()]] Ermittelt die Levensthein-Distanz (Größe bei einem String-Vergleich)
*[[Modul_VAR_neu#.24RANDOM.28.29_2|$RANDOM()]] Erzeugt eine Zufalls-Zahl
* Bei Konsolen-Programmen kann nun auf den Bestätigungsdialog verzichtet werden, siehe [[Modul_Form#.23frm|#frm]]
* Bei [[Modul_Form#.23tree_sel|#tree_sel]] können nun auch Unterknoten durchsucht werden.
*[[Modul_Form#.23tree_fillthread|#tree_fillthread]] - Ergänzt den Baum in einem Thread (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23vl_thread|#vl_thread]] Ergänzt die Daten in einem VL-Segment (meist, um Daten aus einer Datenbank zu ergänzen)
*[[Modul_Form#.23xgrd_calc|#xgrd_calc]] Berechnet einen Wert in einem XGrid-Segment
*[[Modul_Form#.24XGRD_CALC|$XGRD_CALC()]] Berechnet einen Wert in einem XGrid-Segment, aber als Funktion
*[[Modul_Form#XXGrid-Segmente|XX-Grid-Segmente]] (mehrere Prozeduren)
*[[Modul_XML#.23xml_gav|#xml_gav]] Holt die Array-Werte aus einem XML
* In [[Modul_JSON#.24JSON_DATA|$JSON_DATA()]] können nun auch Namen ausgelesen werden
* In [[Modul_XLS#.23xls_cell|#xls_cell]] kann nun auch die vertikale Ausrichtung in einer Zelle spezifiziert werden.

Download Client (bc3_v0_99.zip, 23.345 KB)[[https://bafbal.de/downloads/bc3_v0_99.zip]]

Download Server (bs_v0_99.zip, 24.935 KB)[[https://bafbal.de/downloads/bs_v0_99.zip]]

==Version 0.98==

* Im GridWizard funktioniert nun der Hint der Spaltenüberschriften
* Links funktionieren nun im VL-Segment
* #tree_sel erweitert
* #sql_opentvl
* #sql_line
* Lookups, Specials und Kommandos cachen nun
* XGrid und XXGrid stretchen nun
* grd_thread y=gridlist
* #grd_seg und #vl_seg - whs
* Werte werden nun nur vom Grid in den Baum zurück geschrieben, wenn sie tatsächlich geändert wurden
* #tree_fillthread
* Prozessabbruch beim Fortschrittsdialog wird nun resettet
* cmd no_crlf
* Verbesserung von dateMin und dateSek
* $INCP
* Pos1 und End im Grid
* Wizzard für csv und xlsx
* Beim Debug-Fenster Select werden nun nicht mehr die Selects angezeigt, die Commands holen

Download Client (bc3_v0_98.zip, 20.246 KB)[[https://bafbal.de/downloads/bc3_v0_98.zip]]

Download Server (bs_v0_98.zip, 24.577 KB)[[https://bafbal.de/downloads/bs_v0_98.zip]]

==Version 0.97==

* #grd_ac ergänzt
* $INCLUDE() ergänzt
* $ONLYNUM() ergänzt
* Fehler beim Parsen von XML behoben
* UserIni wird nun beim ServerProzess beim Ende gespeichert
* Cursor beim Login-Dialog

Download Client (bc3_v0_97.zip, 20.236 KB)[[https://bafbal.de/downloads/bc3_v0_97.zip]]

Download Server (bs_v0_97.zip, 24.572 KB)[[https://bafbal.de/downloads/bs_v0_97.zip]]

==Version 0.96==

* TBafTree Scrollbar bei langen Listen gleich
* #ftp_connect Parameter isc
* #email_init Parameter port, isc und to
* Menu scrollt nun richtig
* PDF Grid (#pdf_gdef, #pdf_grow, #pdf_gend)
* #upsert, y=c und n
* Performance Log
* Debug, Request and Response
* History Statement bei anderen DB
* PG, AlterTable, AlterHistory, Leerzeilen in CREATE TABLE kein Problem mehr bei Funktionen
* Vorbelegung Username aus INI beim Login-Dialog
* Baum kann mit Tasten gesteuert werden
* Page, kleinere Bugs behoben, TAB nun auch bei VL-Segment
* $ISDATE ergänzt

Download Client (bc3_v0_96.zip, 20.232 KB)[[https://bafbal.de/downloads/bc3_v0_96.zip]]

Download Server (bs_v0_96.zip, 24.569 KB)[[https://bafbal.de/downloads/bs_v0_96.zip]]

==Version 0.95==

* REST und JSON
* Bilder
* ein wenig XML
* tvl bei Nachschlagelisten

Download Client (bc3_v0_95.zip, 24.541 KB)[[https://bafbal.de/downloads/bc3_v0_95.zip]]

Download Server (bs_v0_95.zip, 24.518 KB)[[https://bafbal.de/downloads/bs_v0_95.zip]]

==Version 0.91==

* TBafTree
* uServer und uServer2
* Parameter isc bei #http_request

Download (bc3_v0_91.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_91.zip]]

==Version 0.9==

* Werden Texte in Nachschlagelisten geladen, werden nun Funktionen (z.B. Übersetzungen) ersetzt
* Werden nach einer Änderung im Tree Werte in den Baum zurückgeschrieben, wird nicht nur - wie bisher - c1 und c2 geschrieben, sondern auch k. Zudem werden nun Funktionen ersetzt
* Wurde bei VL-Wizard nachgebessert
* lookuptext
* Die Listen im Code-Dialog wurden erweitert
* Funktion $BASE64

Download (bc3_v0_9.zip, 19,7 MB)[[https://bafbal.de/downloads/bc3_v0_9.zip]]

==Version 0.8==

* Grid- und VL-Wizard
* SQL-Creator
* Dialoge

Download (bc3_v0_8.zip, 19,87 MB)[[https://bafbal.de/downloads/bc3_v0_8.zip]]

==Version 0.7==

Download nicht mehr verfügbar

==Version 0.3 "Public Preview"==

Hinweise:

Download (copy_303.zip, 9,39 MB)[[https://bafbal.de/downloads/copy_303.zip]]

Modul XLS

2026-01-09T10:26:06Z

Michaelebner: /* #xls_cell */

=XLS=

Im Modul XLS werden die Routinen zusammengefasst, die zur Erstellung von Dateien im Excel- oder OpenOffice Calc-Format verwendet werden. Es können auch Dateien geöffnet und ausgelesen werden.

==#xls_start==

Startet den Export einer Excel-Datei.

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiel'''

#frm c="c_sd_xls" y=console

#xls_start
#xls_sheet c="BAF Demo"
#xls_row
#xls_cell z=Text
#xls_cell z=Text w=200 fc=red
#xls_row
#xls_cell z=Datum
#xls_cell y=datemin z=$NOW()
#xls_row
#xls_cell z=Zahl
#xls_cell y=curr z=3,14

#xls_stop
#cout c="c_sd_xls executed"

==#xls_load==

Lädt eine Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname; wenn leer, wird ein Datei-Dialog geöffnet; Default leer, Funktionen werden ersetzt

'''Beispiel'''

#xls_load fn=c:\temp\$VAR(filename)

==#xls_stop==

Beendet den Export und speichert die Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname, unter dem die Datei gespeichert wird; Funktionen werden ersetzt. Aus der Endung ergibt sich dann der Typ der Datei. Wenn der Parameter leer bleibt, öffnet sich ein Dateiauswahldialog zum Speichern.
* o ("open") - Wenn Y, word wird nach der Erstellung gleich geöffnet; default Y, Funktionen werden ersetzt.

'''Beispiel'''

(siehe #xls_start)

==#xls_sheet==

Fügt der Datei ein (weiteres) Sheet hinzu oder selektiert ein Sheet. Alle weiteren #xls_row-Prozeduren fügen dann diesem Sheet Reihen hinzu.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* c ("caption") - Beschriftung des Tabs
* fc ("fixed cols") - Anzahl der Spalten, die links fixiert werden; default 0; Funktionen werden ersetzt
* fr ("fixed rows") - Anzahl der Zeilen, die oben fixiert werden; default 0; Funktionen werden ersetzt
* n ("number") - 0-relativer Index des Sheets, das selektiert werden soll

'''Beispiele'''

#xls_sheet c="Daten" fr=1
#xls_sheet n=0

==#xls_delete_sheet==

Löscht das aktuelle Sheet.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiele'''

#xls_delete_sheet cnd=$INVAR(zeilenzahl,0)

==#xls_row==

Fügt dem aktuellen Sheet eine weitere Reihe hinzu oder selektiert eine solche.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* h (height) - Höhe der Zelle; default 20, Funktionen werden ersetzt
* n ("number") - 0-relativer Index der Reihe, die selektiert werden soll

'''Beispiel'''

(siehe #xls_start)

==#xls_cell==

Fügt der aktuellen Reihe eine weitere Zelle hinzu oder schreibt den Wert der mit n spezifizierten.

'''Parameter'''
* a ("align") - Ausrichtung des Textes / des Wertes in der Zelle
** c ("center") - mittig
** d2 / d4 (decimal) - ausgerichtet am Komma für zwei oder vier Nachkommastellen
** l ("left") - linksbündig
** r ("right") - rechtsbündig
* bt, bl, br, bb ("border top", "border left", "border right", "border bottom") - Ränder der Zelle, default thin, Funktionen werden ersetzt (auto, none, thin, medium, dashed, dotted, thick, double, hair, mediumdashed, dashdotted, mediumdashdotted, dashdotdotted, mediumdashdotdotted, slanteddashdotted)
* cl ("color") - Farbe der Zelle; default weiß
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* cs ("ColSpan") - Anzahl der Spalten, die zusammengefasst werden; default 1, Funktionen werden ersetzt
* fc ("FontColor") - Farbe der Schrift; default schwarz
* frml ("Formula") - Formel, die berechnet werden soll. Wenn gesetzt, dann wird z ignoriert; default leer, Funktionen werden ersetzt. HINWEIS: Die Formel muss auf englisch formuliert werden, also z.B. SUM(C1:C11) statt SUMME(C1:C11); und: Parameter y muss gesetzt werden.
* n ("number") - 0-relativer Index der Spalte, die geschrieben werden soll; wenn leer, wird eine neue Zelle hinzugefügt; default leer, Funktionen werden ersetzt
* va ("vertivcal align") - vertikale Ausrichtung des Textes; default t, Funktionen werden ersetzt
** b ("bottom") - unten
** c ("center") - mittig
** t ("top") - oben
* fs ("FontStyle") - Style der Schrift, die einzelnen Optionen können kombiniert werden; default keine Option
** b - bold
** i - italic
** u - underline
** s - strikeout
* w ("width") - Breite der Zelle
* y - Typ der Zelle, default Text
** curr - Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum
** datemin - Datum und Uhrzeit ohne Sekunden
** datesek - Datum und Uhrzeit mit Sekunden
** int - Zahlen ohne Nachkommastellen
** text - Text
* z - Wert/Text, der in der Zelle eingefügt werden soll; Funktionen werden ersetzt

'''Beispiel'''

#xls_cell z=Text w=200 fc=red
#xls_cell y=datemin z=$NOW()

==#xls_looprows==

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y; Funktionen werden ersetzt
* db - ("database") Name der Datenbank, auf die sich die Transaktion bezieht; Funktionen werden ersetzt
* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen; Funktionen werden ersetzt
* m - ("maximum") Es wird maximal für die Anzahl der angegebenen Zeilen das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten; Funktionen werden ersetzt
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N; Funktionen werden ersetzt.
* n - Name der Variablen, in welche die aktuelle, 0-relative Schleifennummer geschrieben wird

'''Beispiel'''

#xls_looprows er=sof_7836_line m_=5

==#xls_page==

Exportiert alle VL-, Grid- und XGrid-Segmente der aktuellen Seite. Für jedes Segment wird eine neues Sheet angelegt.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=xls s=#xls_page se=b

==$XLS_COUNT()==

Ermittelt die Anzahl der Sheets, Zeilen oder Zellen

'''Parameter'''

# Von was wird die Anzahl ermittelt
## sheets - Sheets in einer Datei
## rows - Zeilen in einem Sheet
## cells - Zellen in einer Zeile

'''Beispiel'''

#cout c="Dieses Sheet hat $XLS_COUNT(rows) Zeilen"

==$XLS_CELL()==

Gibt den Wert einer Zelle aus

'''Parameter'''

# Index der Zelle

'''Beispiel'''

#val_set n=1 z=$XLS_CELL(0)

~ $INTLEN($VAL(1)) = 9
#var_add n=zeile z=1 y=int
#cout c="$VAL(1) - $VAR(datei) / $VAR(zeile)" m=20 md=10
#sql_upsert y=a t=neuland.sof_7836 k=adrnr f_adrnr=$VAL(1) hst=N

~~

==Beispiel: XLSX-Datei mit Daten anreichern==

===Kommando c_fp_lieferanten===

Öffnet die Datei c:\temp\lieferanten.xlsx und geht durch alle vorhandenen Zeilen mit Ausnahme der Titelzeile (darum lf=1). Danach öffnet sich ein Datei-Dialog, um die Datei abzuspeichern.

#frm c="c_fp_lieferanten" y=console

#xls_load fn=c:\temp\lieferanten.xlsx
#xls_sheet n=0

#loop lf=1 lt=$ICALC(-,$XLS_COUNT(rows),1) er=c_fp_lieferanten_line n=loopvar

#xls_stop

#cout c="c_fp_lieferanten executed"

===Sub-Kommando c_fp_lieferanten_line===

Zunächst wird die korrekte Zeile gesetzt, die ist 0-relativ anzugeben. Die Lieferantennummer ist in der zweiten Spalte, das wird mit $XLS_CELL(1) ausgelesen und auch gleich ausgegeben.

Die letzte Zeile im Ausgangs-Sheet ist eine Summenzeile und hat keine Lieferantennummer, darum wird darauf geprüft. Mit einer einfachen SQL-Abfrage werden Steuernummer, Umsatzsteuer-ID und IBAN abgefragt und in Values zwischengespeichert. Diese werden dann in die dafür vorgesehenen Zellen geschrieben.

#xls_row n=$VAR(loopvar)
#cout c=$XLS_CELL(1)

~ $NEMPTY($XLS_CELL(1))
#sql select iban, coast_steuernr, coast_ustid from cache_lieferant
#sql where lieferant_number = $XLS_CELL(1)
#sql_openval f_iban=1 f_coast_steuernr=2 f_coast_ustid=3

#xls_cell n=4 z=$VAL(3)
#xls_cell n=5 z=$VAL(2)
#xls_cell n=11 z=$VAL(1)

~~

Modul XLS

2026-01-09T10:25:13Z

Michaelebner: /* #xls_cell */

=XLS=

Im Modul XLS werden die Routinen zusammengefasst, die zur Erstellung von Dateien im Excel- oder OpenOffice Calc-Format verwendet werden. Es können auch Dateien geöffnet und ausgelesen werden.

==#xls_start==

Startet den Export einer Excel-Datei.

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiel'''

#frm c="c_sd_xls" y=console

#xls_start
#xls_sheet c="BAF Demo"
#xls_row
#xls_cell z=Text
#xls_cell z=Text w=200 fc=red
#xls_row
#xls_cell z=Datum
#xls_cell y=datemin z=$NOW()
#xls_row
#xls_cell z=Zahl
#xls_cell y=curr z=3,14

#xls_stop
#cout c="c_sd_xls executed"

==#xls_load==

Lädt eine Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname; wenn leer, wird ein Datei-Dialog geöffnet; Default leer, Funktionen werden ersetzt

'''Beispiel'''

#xls_load fn=c:\temp\$VAR(filename)

==#xls_stop==

Beendet den Export und speichert die Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname, unter dem die Datei gespeichert wird; Funktionen werden ersetzt. Aus der Endung ergibt sich dann der Typ der Datei. Wenn der Parameter leer bleibt, öffnet sich ein Dateiauswahldialog zum Speichern.
* o ("open") - Wenn Y, word wird nach der Erstellung gleich geöffnet; default Y, Funktionen werden ersetzt.

'''Beispiel'''

(siehe #xls_start)

==#xls_sheet==

Fügt der Datei ein (weiteres) Sheet hinzu oder selektiert ein Sheet. Alle weiteren #xls_row-Prozeduren fügen dann diesem Sheet Reihen hinzu.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* c ("caption") - Beschriftung des Tabs
* fc ("fixed cols") - Anzahl der Spalten, die links fixiert werden; default 0; Funktionen werden ersetzt
* fr ("fixed rows") - Anzahl der Zeilen, die oben fixiert werden; default 0; Funktionen werden ersetzt
* n ("number") - 0-relativer Index des Sheets, das selektiert werden soll

'''Beispiele'''

#xls_sheet c="Daten" fr=1
#xls_sheet n=0

==#xls_delete_sheet==

Löscht das aktuelle Sheet.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiele'''

#xls_delete_sheet cnd=$INVAR(zeilenzahl,0)

==#xls_row==

Fügt dem aktuellen Sheet eine weitere Reihe hinzu oder selektiert eine solche.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* h (height) - Höhe der Zelle; default 20, Funktionen werden ersetzt
* n ("number") - 0-relativer Index der Reihe, die selektiert werden soll

'''Beispiel'''

(siehe #xls_start)

==#xls_cell==

Fügt der aktuellen Reihe eine weitere Zelle hinzu oder schreibt den Wert der mit n spezifizierten.

'''Parameter'''
* a ("align") - Ausrichtung des Textes / des Wertes in der Zelle
** c ("center") - mittig
** d2 / d4 (decimal) - ausgerichtet am Komma für zwei oder vier Nachkommastellen
** l ("left") - linksbündig
** r ("right") - rechtsbündig
* bt, bl, br, bb ("border top", "border left", "border right", "border bottom") - Ränder der Zelle, default thin, Funktionen werden ersetzt (auto, none, thin, medium, dashed, dotted, thick, double, hair, mediumdashed, dashdotted, mediumdashdotted, dashdotdotted, mediumdashdotdotted, slanteddashdotted)
* cl ("color") - Farbe der Zelle; default weiß
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* cs ("ColSpan") - Anzahl der Spalten, die zusammengefasst werden; default 1, Funktionen werden ersetzt
* fc ("FontColor") - Farbe der Schrift; default schwarz
* frml ("Formula") - Formel, die berechnet werden soll. Wenn gesetzt, dann wird z ignoriert; default leer, Funktionen werden ersetzt. HINWEIS: Die Formel muss auf englisch formuliert werden, also z.B. SUM(C1:C11) statt SUMME(C1:C11)
* n ("number") - 0-relativer Index der Spalte, die geschrieben werden soll; wenn leer, wird eine neue Zelle hinzugefügt; default leer, Funktionen werden ersetzt
* va ("vertivcal align") - vertikale Ausrichtung des Textes; default t, Funktionen werden ersetzt
** b ("bottom") - unten
** c ("center") - mittig
** t ("top") - oben
* fs ("FontStyle") - Style der Schrift, die einzelnen Optionen können kombiniert werden; default keine Option
** b - bold
** i - italic
** u - underline
** s - strikeout
* w ("width") - Breite der Zelle
* y - Typ der Zelle, default Text
** curr - Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum
** datemin - Datum und Uhrzeit ohne Sekunden
** datesek - Datum und Uhrzeit mit Sekunden
** int - Zahlen ohne Nachkommastellen
** text - Text
* z - Wert/Text, der in der Zelle eingefügt werden soll; Funktionen werden ersetzt

'''Beispiel'''

#xls_cell z=Text w=200 fc=red
#xls_cell y=datemin z=$NOW()

==#xls_looprows==

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y; Funktionen werden ersetzt
* db - ("database") Name der Datenbank, auf die sich die Transaktion bezieht; Funktionen werden ersetzt
* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen; Funktionen werden ersetzt
* m - ("maximum") Es wird maximal für die Anzahl der angegebenen Zeilen das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten; Funktionen werden ersetzt
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N; Funktionen werden ersetzt.
* n - Name der Variablen, in welche die aktuelle, 0-relative Schleifennummer geschrieben wird

'''Beispiel'''

#xls_looprows er=sof_7836_line m_=5

==#xls_page==

Exportiert alle VL-, Grid- und XGrid-Segmente der aktuellen Seite. Für jedes Segment wird eine neues Sheet angelegt.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=xls s=#xls_page se=b

==$XLS_COUNT()==

Ermittelt die Anzahl der Sheets, Zeilen oder Zellen

'''Parameter'''

# Von was wird die Anzahl ermittelt
## sheets - Sheets in einer Datei
## rows - Zeilen in einem Sheet
## cells - Zellen in einer Zeile

'''Beispiel'''

#cout c="Dieses Sheet hat $XLS_COUNT(rows) Zeilen"

==$XLS_CELL()==

Gibt den Wert einer Zelle aus

'''Parameter'''

# Index der Zelle

'''Beispiel'''

#val_set n=1 z=$XLS_CELL(0)

~ $INTLEN($VAL(1)) = 9
#var_add n=zeile z=1 y=int
#cout c="$VAL(1) - $VAR(datei) / $VAR(zeile)" m=20 md=10
#sql_upsert y=a t=neuland.sof_7836 k=adrnr f_adrnr=$VAL(1) hst=N

~~

==Beispiel: XLSX-Datei mit Daten anreichern==

===Kommando c_fp_lieferanten===

Öffnet die Datei c:\temp\lieferanten.xlsx und geht durch alle vorhandenen Zeilen mit Ausnahme der Titelzeile (darum lf=1). Danach öffnet sich ein Datei-Dialog, um die Datei abzuspeichern.

#frm c="c_fp_lieferanten" y=console

#xls_load fn=c:\temp\lieferanten.xlsx
#xls_sheet n=0

#loop lf=1 lt=$ICALC(-,$XLS_COUNT(rows),1) er=c_fp_lieferanten_line n=loopvar

#xls_stop

#cout c="c_fp_lieferanten executed"

===Sub-Kommando c_fp_lieferanten_line===

Zunächst wird die korrekte Zeile gesetzt, die ist 0-relativ anzugeben. Die Lieferantennummer ist in der zweiten Spalte, das wird mit $XLS_CELL(1) ausgelesen und auch gleich ausgegeben.

Die letzte Zeile im Ausgangs-Sheet ist eine Summenzeile und hat keine Lieferantennummer, darum wird darauf geprüft. Mit einer einfachen SQL-Abfrage werden Steuernummer, Umsatzsteuer-ID und IBAN abgefragt und in Values zwischengespeichert. Diese werden dann in die dafür vorgesehenen Zellen geschrieben.

#xls_row n=$VAR(loopvar)
#cout c=$XLS_CELL(1)

~ $NEMPTY($XLS_CELL(1))
#sql select iban, coast_steuernr, coast_ustid from cache_lieferant
#sql where lieferant_number = $XLS_CELL(1)
#sql_openval f_iban=1 f_coast_steuernr=2 f_coast_ustid=3

#xls_cell n=4 z=$VAL(3)
#xls_cell n=5 z=$VAL(2)
#xls_cell n=11 z=$VAL(1)

~~

Modul Form

2025-12-29T09:00:11Z

Michaelebner: /* #cout */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I; HINWEIS: Für korrekte Zählung in Server-Kommandos bitte #log verwenden.

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.
* ?firstnempty - der erste Wert (in der entsprechenden Gruppe), der nicht leer ist.
* ?lasttnempty - der letzte Wert (in der entsprechenden Gruppe), der nicht leer ist.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ca1, ca2... (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ca (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* ca1, ca2 (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-12-28T16:59:16Z

Michaelebner: /* $PVAL() */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.
* ?firstnempty - der erste Wert (in der entsprechenden Gruppe), der nicht leer ist.
* ?lasttnempty - der letzte Wert (in der entsprechenden Gruppe), der nicht leer ist.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ca1, ca2... (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ca (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* ca1, ca2 (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Interpreter

2025-11-26T16:46:42Z

Michaelebner: /* #tab_new */

Im Interpreter sind nur wenige Prozeduren und Funktionen direkt implementiert. Die meisten Routinen finden sich in den Modulen.

=Values=

Im Gegensatz zu Variablen ist der Gültigkeitsbereich von Values auf das jeweilige (Primär- oder Sub-) Kommando beschränkt. Values haben Nummern, während Variable Namen haben.

==#val_set==

Setzt der Wert für einen Value.

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie (if empty) - Wenn der Wert von z leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei Oracle; Funktionen werden ersetzt
*n - Nummer des Values
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht vorliegt; default ist ''frm''
*rf (replace functions) - Wenn Y, dann werden nach der Zuweisung auf den Value nochmals die Funktionen ersetzt. Wird zum Beispiel benötigt, wenn Code mit Funktionen mittels $DATA() aus der Datenbank geladen wird; Funktionen werden ersetzt, default N; siehe Beispiel
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String

'''Beispiele'''

#val_set n=7 z=$GUID()
#val_set n=1 z=$GUID() r=admin

-- Zum Parameter rf: $NOW() in die Zwischenablage kopieren und dann ausführen
#val_set n=1 z=$CLIPBOARD() rf=N
#message c=$VAL(1)
#val_set n=1 z=$CLIPBOARD() rf=Y
#message c=$VAL(1)

==#val_add==

<nowiki>#val_add fügt einem Value einen Wert hinzu.</nowiki>

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*n - Nummer des Values; zwingend erforderlich
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''.
* y -Typ der Operation; default ''text''
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** text - Der Wert wird als Text hinzugefügt
*z - Wert, welcher dem Value hinzugefügt wird, Funktionen werden ersetzt, default ist ein leerer String oder eine 0

'''Beispiel'''

#val_set n=1 z=$NOW()
#val_add n=1 z=1 y=datetime
#cout c=$VAL(1)

==#val_clearall==

Löscht alle Values. Wird selten benötigt, da die Values mit Ende des (Primär- oder Sub-) Kommandos ohnehin ihre Gültigkeit verlieren.

'''Parameter'''

(keine)

'''Beispiel'''

#val_clearall

==$VAL()==

Gibt den Inhalt eines Values zurück

'''Parameter'''

# Nummer des Values

'''Beispiel'''

#cout c=$VAL(3)

==$EMPTYVAL()==

Gibt Y zurück, wenn der Value ein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $EMPTYVAL(1)

==$NEMPTYVAL()==

Gibt Y zurück, wenn der Value kein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $NEMPTYVAL(2)

=Log=

==#exception_info==

Tritt eine Exception auf, dann wird die entsprechende Fehlermeldung in das Log geschrieben. Mit #exception_info kann eine Information ergänzt werden, die vor diese Fehlermeldung gesetzt wird. Üblicherweise wird das dazu verwendet, um eine ID zu schreiben, damit der fehlerhafte Datensatz gefunden wird.

'''Parameter'''

* z - Wert, welcher vor die Fehlermeldung geschrieben wird.

'''Beispiel'''

#exception_info z=$DATA(dat,knd_nr)

==#log==

Schreibt einen Text in das Log.

'''Parameter'''

* c ("caption") - Text, der in das Log geschrieben wird; Funktionen werden ersetzt; default ist ''#log, Parameter c nicht gesetzt''
* y - Typ des Log-Eintrags; default I. Vorgesehen sind die folgenden Typen:
** E - Error
** I - Info
** W - Warning

'''Beispiel'''

#log y=W c="Ermittelte Summe untypisch gering"

==#logi==

Schreibt einen Text als Info in das Log.

'''Parameter'''

Die Prozedur #logi hat keine benannten Parameter. Der komplette Text nach dem #logi und dem folgenden Leerzeichen wird in das Log geschrieben; Funktionen werden ersetzt.

'''Beispiel'''

#logi Berechnung beendet

=Kommandos=

==#tab_new==

Öffnet einen neuen Tab im BAF-Client und führt dort ein Kommando aus.

'''Parameter'''

* c ("caption") - Beschriftung des neuen Tabs; Funktionen werden ersetzt
* cmd ("command") - Kommando, das im neuen Tab ausgeführt wird; Funktionen werden ersetzt
* debug - Wenn Y, wird für den neuen Tab das Debug-Log aktiviert; Default N, Funktionen werden ersetzt

'''Beispiel'''

#tab_new c=xuser cmd=xuser($PAGE(link))

==$CP()==

("command parameter") - Greift auf einen Parameter des Kommandos zu.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.

'''Beispiel'''

#page_fill d=$CP(1)

==$ICP()==

("is command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit einem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $ICP(0,ex)
~ $ICP(0,ex,im,new)

==$INCP()==

("is not command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit keinem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $INCP(0,ex)
~ $INCP(0,ex,im,new)

=Internes=

Die folgenden Funktionen werden für interne Zwecke verwendet:

* $INTER() - Name des Interpreters
* $HISTSQL() - SQL-Statement für den History-Dialog
* $HISTTABLE() - Tabellenname der History-Tabelle
* $HISTMEMOFIELD() - Feldname des Memo-Feldes für den History-Dialog

Interpreter

2025-11-26T16:27:04Z

Michaelebner: /* #tab_new */

Im Interpreter sind nur wenige Prozeduren und Funktionen direkt implementiert. Die meisten Routinen finden sich in den Modulen.

=Values=

Im Gegensatz zu Variablen ist der Gültigkeitsbereich von Values auf das jeweilige (Primär- oder Sub-) Kommando beschränkt. Values haben Nummern, während Variable Namen haben.

==#val_set==

Setzt der Wert für einen Value.

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*ie (if empty) - Wenn der Wert von z leer ist, dann wird ersatzweise der Wert von ie verwendet; ähnlich NVL bei Oracle; Funktionen werden ersetzt
*n - Nummer des Values
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht vorliegt; default ist ''frm''
*rf (replace functions) - Wenn Y, dann werden nach der Zuweisung auf den Value nochmals die Funktionen ersetzt. Wird zum Beispiel benötigt, wenn Code mit Funktionen mittels $DATA() aus der Datenbank geladen wird; Funktionen werden ersetzt, default N; siehe Beispiel
*z - Wert der Variablen, Funktionen werden ersetzt, default ist ein leerer String

'''Beispiele'''

#val_set n=7 z=$GUID()
#val_set n=1 z=$GUID() r=admin

-- Zum Parameter rf: $NOW() in die Zwischenablage kopieren und dann ausführen
#val_set n=1 z=$CLIPBOARD() rf=N
#message c=$VAL(1)
#val_set n=1 z=$CLIPBOARD() rf=Y
#message c=$VAL(1)

==#val_add==

<nowiki>#val_add fügt einem Value einen Wert hinzu.</nowiki>

'''Parameter'''

*cnd (condition) - Der Value wird nur dann gesetzt, wenn cnd=Y ist; Funktionen werden ersetzt
*n - Nummer des Values; zwingend erforderlich
*r (rights) - Der Value wird nur dann gesetzt, wenn das Recht ''write'' vorliegt; default ist ''frm''.
* y -Typ der Operation; default ''text''
** curr - Es wird eine Fixkomma-Addition vorgenommen
** date - Es wird dem Datum eine Anzahl von Tagen hinzugefügt
** datetime - Es wird dem Datum eine Anzahl von Tagen hinzugefügt, Ergebnis als datetime
** int - Es wird eine Ganzzahl-Addition vorgenommen
** text - Der Wert wird als Text hinzugefügt
*z - Wert, welcher dem Value hinzugefügt wird, Funktionen werden ersetzt, default ist ein leerer String oder eine 0

'''Beispiel'''

#val_set n=1 z=$NOW()
#val_add n=1 z=1 y=datetime
#cout c=$VAL(1)

==#val_clearall==

Löscht alle Values. Wird selten benötigt, da die Values mit Ende des (Primär- oder Sub-) Kommandos ohnehin ihre Gültigkeit verlieren.

'''Parameter'''

(keine)

'''Beispiel'''

#val_clearall

==$VAL()==

Gibt den Inhalt eines Values zurück

'''Parameter'''

# Nummer des Values

'''Beispiel'''

#cout c=$VAL(3)

==$EMPTYVAL()==

Gibt Y zurück, wenn der Value ein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $EMPTYVAL(1)

==$NEMPTYVAL()==

Gibt Y zurück, wenn der Value kein leerer String ist, dessen Nummer im Parameter ist. (Leerzeichen zählen auch als leerer String.)

'''Parameter'''

# Nummer des Values

'''Beispiel'''

~ $NEMPTYVAL(2)

=Log=

==#exception_info==

Tritt eine Exception auf, dann wird die entsprechende Fehlermeldung in das Log geschrieben. Mit #exception_info kann eine Information ergänzt werden, die vor diese Fehlermeldung gesetzt wird. Üblicherweise wird das dazu verwendet, um eine ID zu schreiben, damit der fehlerhafte Datensatz gefunden wird.

'''Parameter'''

* z - Wert, welcher vor die Fehlermeldung geschrieben wird.

'''Beispiel'''

#exception_info z=$DATA(dat,knd_nr)

==#log==

Schreibt einen Text in das Log.

'''Parameter'''

* c ("caption") - Text, der in das Log geschrieben wird; Funktionen werden ersetzt; default ist ''#log, Parameter c nicht gesetzt''
* y - Typ des Log-Eintrags; default I. Vorgesehen sind die folgenden Typen:
** E - Error
** I - Info
** W - Warning

'''Beispiel'''

#log y=W c="Ermittelte Summe untypisch gering"

==#logi==

Schreibt einen Text als Info in das Log.

'''Parameter'''

Die Prozedur #logi hat keine benannten Parameter. Der komplette Text nach dem #logi und dem folgenden Leerzeichen wird in das Log geschrieben; Funktionen werden ersetzt.

'''Beispiel'''

#logi Berechnung beendet

=Kommandos=

==#tab_new==

Öffnet einen neuen Tab im BAF-Client und führt dort ein Kommando aus.

'''Parameter'''

* c ("caption") - Beschriftung des neuen Tabs; Funktionen werden ersetzt
* cmd ("command") - Kommando, das im neuen Tab ausgeführt wird; Funktionen werden ersetzt

'''Beispiel'''

#tab_new c=xuser cmd=xuser($PAGE(link))

==$CP()==

("command parameter") - Greift auf einen Parameter des Kommandos zu.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.

'''Beispiel'''

#page_fill d=$CP(1)

==$ICP()==

("is command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit einem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $ICP(0,ex)
~ $ICP(0,ex,im,new)

==$INCP()==

("is not command parameter") - Vergleicht den Parameter des Kommandos mit dem im zweiten oder weiteren Parameter angegebenen Wert; Unterschiede in Groß- und Kleinschreibung werden dabei nicht berücksichtigt. Gibt Y zurück, wenn der Parameter mit keinem der Vergleichswerte übereinstimmt.

Wird fast immer in Verbindung mit Verzweigungsbedingungen verwendet.

'''Parameter'''

# Nummer des Parameters. 0-relativ, der erste Parameter hat somit die Nummer 0.
# und Folgende: Vergleichswerte

'''Beispiele'''

~ $INCP(0,ex)
~ $INCP(0,ex,im,new)

=Internes=

Die folgenden Funktionen werden für interne Zwecke verwendet:

* $INTER() - Name des Interpreters
* $HISTSQL() - SQL-Statement für den History-Dialog
* $HISTTABLE() - Tabellenname der History-Tabelle
* $HISTMEMOFIELD() - Feldname des Memo-Feldes für den History-Dialog

Modul Form

2025-11-14T13:49:24Z

Michaelebner: /* #sgrd_node */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ca1, ca2... (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ca (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* ca1, ca2 (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-11-14T13:48:45Z

Michaelebner: /* #vl_line */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ca1, ca2... (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ca (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-11-14T13:48:04Z

Michaelebner: /* #grd_col */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ca (characters allowed) - Zeichen, die bei der Eingabe über die Tastatur erlaubt sind; wenn leer, sind alle Zeichen erlaubt; default leer; Funktionen werden ersetzt
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul XLS

2025-11-14T11:07:43Z

Michaelebner: /* #xls_sheet */

=XLS=

Im Modul XLS werden die Routinen zusammengefasst, die zur Erstellung von Dateien im Excel- oder OpenOffice Calc-Format verwendet werden. Es können auch Dateien geöffnet und ausgelesen werden.

==#xls_start==

Startet den Export einer Excel-Datei.

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiel'''

#frm c="c_sd_xls" y=console

#xls_start
#xls_sheet c="BAF Demo"
#xls_row
#xls_cell z=Text
#xls_cell z=Text w=200 fc=red
#xls_row
#xls_cell z=Datum
#xls_cell y=datemin z=$NOW()
#xls_row
#xls_cell z=Zahl
#xls_cell y=curr z=3,14

#xls_stop
#cout c="c_sd_xls executed"

==#xls_load==

Lädt eine Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname; wenn leer, wird ein Datei-Dialog geöffnet; Default leer, Funktionen werden ersetzt

'''Beispiel'''

#xls_load fn=c:\temp\$VAR(filename)

==#xls_stop==

Beendet den Export und speichert die Datei

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* fn ("FileName") - Dateiname, unter dem die Datei gespeichert wird; Funktionen werden ersetzt. Aus der Endung ergibt sich dann der Typ der Datei. Wenn der Parameter leer bleibt, öffnet sich ein Dateiauswahldialog zum Speichern.
* o ("open") - Wenn Y, word wird nach der Erstellung gleich geöffnet; default Y, Funktionen werden ersetzt.

'''Beispiel'''

(siehe #xls_start)

==#xls_sheet==

Fügt der Datei ein (weiteres) Sheet hinzu oder selektiert ein Sheet. Alle weiteren #xls_row-Prozeduren fügen dann diesem Sheet Reihen hinzu.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* c ("caption") - Beschriftung des Tabs
* fc ("fixed cols") - Anzahl der Spalten, die links fixiert werden; default 0; Funktionen werden ersetzt
* fr ("fixed rows") - Anzahl der Zeilen, die oben fixiert werden; default 0; Funktionen werden ersetzt
* n ("number") - 0-relativer Index des Sheets, das selektiert werden soll

'''Beispiele'''

#xls_sheet c="Daten" fr=1
#xls_sheet n=0

==#xls_delete_sheet==

Löscht das aktuelle Sheet.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt

'''Beispiele'''

#xls_delete_sheet cnd=$INVAR(zeilenzahl,0)

==#xls_row==

Fügt dem aktuellen Sheet eine weitere Reihe hinzu oder selektiert eine solche.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* h (height) - Höhe der Zelle; default 20, Funktionen werden ersetzt
* n ("number") - 0-relativer Index der Reihe, die selektiert werden soll

'''Beispiel'''

(siehe #xls_start)

==#xls_cell==

Fügt der aktuellen Reihe eine weitere Zelle hinzu oder schreibt den Wert der mit n spezifizierten.

'''Parameter'''
* a ("align") - Ausrichtung des Textes / des Wertes in der Zelle
** c ("center") - mittig
** d2 / d4 (decimal) - ausgerichtet am Komma für zwei oder vier Nachkommastellen
** l ("left") - linksbündig
** r ("right") - rechtsbündig
* bt, bl, br, bb ("border top", "border left", "border right", "border bottom") - Ränder der Zelle, default thin, Funktionen werden ersetzt (auto, none, thin, medium, dashed, dotted, thick, double, hair, mediumdashed, dashdotted, mediumdashdotted, dashdotdotted, mediumdashdotdotted, slanteddashdotted)
* cl ("color") - Farbe der Zelle; default weiß
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* cs ("ColSpan") - Anzahl der Spalten, die zusammengefasst werden; default 1, Funktionen werden ersetzt
* fc ("FontColor") - Farbe der Schrift; default schwarz
n ("number") - 0-relativer Index der Spalte, die geschrieben werden soll; wenn leer, wird eine neue Zelle hinzugefügt; default leer, Funktionen werden ersetzt
* va ("vertivcal align") - vertikale Ausrichtung des Textes; default t, Funktionen werden ersetzt
** b ("bottom") - unten
** c ("center") - mittig
** t ("top") - oben
* fs ("FontStyle") - Style der Schrift, die einzelnen Optionen können kombiniert werden; default keine Option
** b - bold
** i - italic
** u - underline
** s - strikeout
* w ("width") - Breite der Zelle
* y - Typ der Zelle, default Text
** curr - Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum
** datemin - Datum und Uhrzeit ohne Sekunden
** datesek - Datum und Uhrzeit mit Sekunden
** int - Zahlen ohne Nachkommastellen
** text - Text
* z - Wert/Text, der in der Zelle eingefügt werden soll; Funktionen werden ersetzt

'''Beispiel'''

#xls_cell z=Text w=200 fc=red
#xls_cell y=datemin z=$NOW()

==#xls_looprows==

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y; Funktionen werden ersetzt
* db - ("database") Name der Datenbank, auf die sich die Transaktion bezieht; Funktionen werden ersetzt
* er - ("each row") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden ersetzt.
* ern - ("each row no") Das Kommando, das für jede Zeile der Datenmenge aufgerufen wird. Funktionen werden nicht ersetzt. Wenn ''ern'' einen Wert hat, bleibt ''er'' unberücksichtigt. Üblicherweise wird ''er'' verwendet.
* ert - ("each row transaction") Wenn Y, wird für jede Zeile der Datenmenge eine eigene Transaktion gestartet und nach der Abarbeitung des Kommandos wieder geschlossen; Funktionen werden ersetzt
* m - ("maximum") Es wird maximal für die Anzahl der angegebenen Zeilen das in er angegebene Kommando ausgeführt. Dieser Parameter wird häufig dazu verwendet, während der Entwicklung mit einer geringen Zahl von Datensätzen zu arbeiten; Funktionen werden ersetzt
* nex ("no exception") - Wenn Y, wird bei Exceptions in er nicht abgebrochen, sondern mit dem nächsten Datensatz fortgesetzt. Default N; Funktionen werden ersetzt.
* n - Name der Variablen, in welche die aktuelle, 0-relative Schleifennummer geschrieben wird

'''Beispiel'''

#xls_looprows er=sof_7836_line m_=5

==#xls_page==

Exportiert alle VL-, Grid- und XGrid-Segmente der aktuellen Seite. Für jedes Segment wird eine neues Sheet angelegt.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=xls s=#xls_page se=b

==$XLS_COUNT()==

Ermittelt die Anzahl der Sheets, Zeilen oder Zellen

'''Parameter'''

# Von was wird die Anzahl ermittelt
## sheets - Sheets in einer Datei
## rows - Zeilen in einem Sheet
## cells - Zellen in einer Zeile

'''Beispiel'''

#cout c="Dieses Sheet hat $XLS_COUNT(rows) Zeilen"

==$XLS_CELL()==

Gibt den Wert einer Zelle aus

'''Parameter'''

# Index der Zelle

'''Beispiel'''

#val_set n=1 z=$XLS_CELL(0)

~ $INTLEN($VAL(1)) = 9
#var_add n=zeile z=1 y=int
#cout c="$VAL(1) - $VAR(datei) / $VAR(zeile)" m=20 md=10
#sql_upsert y=a t=neuland.sof_7836 k=adrnr f_adrnr=$VAL(1) hst=N

~~

==Beispiel: XLSX-Datei mit Daten anreichern==

===Kommando c_fp_lieferanten===

Öffnet die Datei c:\temp\lieferanten.xlsx und geht durch alle vorhandenen Zeilen mit Ausnahme der Titelzeile (darum lf=1). Danach öffnet sich ein Datei-Dialog, um die Datei abzuspeichern.

#frm c="c_fp_lieferanten" y=console

#xls_load fn=c:\temp\lieferanten.xlsx
#xls_sheet n=0

#loop lf=1 lt=$ICALC(-,$XLS_COUNT(rows),1) er=c_fp_lieferanten_line n=loopvar

#xls_stop

#cout c="c_fp_lieferanten executed"

===Sub-Kommando c_fp_lieferanten_line===

Zunächst wird die korrekte Zeile gesetzt, die ist 0-relativ anzugeben. Die Lieferantennummer ist in der zweiten Spalte, das wird mit $XLS_CELL(1) ausgelesen und auch gleich ausgegeben.

Die letzte Zeile im Ausgangs-Sheet ist eine Summenzeile und hat keine Lieferantennummer, darum wird darauf geprüft. Mit einer einfachen SQL-Abfrage werden Steuernummer, Umsatzsteuer-ID und IBAN abgefragt und in Values zwischengespeichert. Diese werden dann in die dafür vorgesehenen Zellen geschrieben.

#xls_row n=$VAR(loopvar)
#cout c=$XLS_CELL(1)

~ $NEMPTY($XLS_CELL(1))
#sql select iban, coast_steuernr, coast_ustid from cache_lieferant
#sql where lieferant_number = $XLS_CELL(1)
#sql_openval f_iban=1 f_coast_steuernr=2 f_coast_ustid=3

#xls_cell n=4 z=$VAL(3)
#xls_cell n=5 z=$VAL(2)
#xls_cell n=11 z=$VAL(1)

~~

Modul Form

2025-11-13T11:16:41Z

Michaelebner: /* #grd_lookuplivefill */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_lookupliveclear==

Setzt das Flag, dass die LokupLive-Nachschlagelisten neu gefüllt werden müssen. Kann beim Einsatz von #page_val erforderlich werden.

'''Parameter'''

keine

'''Beispiel'''

#grd_lookupliveclear

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-11-10T08:10:00Z

Michaelebner: /* #grd_thread */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben. Bei y=gridcache nicht erforderlich
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-11-10T08:08:42Z

Michaelebner: /* #grd_thread */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben.
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = $VAR(jahr) or extract(year from letzter_fahrtag) = $VAR(jahr)
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-11-10T08:07:52Z

Michaelebner: /* #grd_thread */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cc ("condition count") - Anzahl der Bedingungen bei y=gridcache, Default 1, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnd1, cnd2 - Bedingungen bei y=gridcache. Die Bedingung besteht komma-separiert aus der Funktion und den Parametern
** eq ("equals") - Werte müssen übereinstimmen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge
** date_gdd - Datum im Grid muss zwischen den beiden Datumswerten in der Datenmenge liegen; Parameter 1: Spaltennamen im Grid; Parameter 2: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die obere Datumsgrenze
** date_ggd - Datum in der Datenmenge muss zwischen den beiden Datumswerten im Grid liegen; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge
** date_ggdd - Datumsbereich im Grid und Datumsbereich in der Datenmenge brauchen eine Schnittmenge; Parameter 1: Spaltennamen im Grid für die untere Datumsgrenze; Parameter 2: Spaltennamen im Grid für die obere Datumsgrenze; Parameter 3: Spaltennamen in der Datenmenge für die untere Datumsgrenze; Parameter 4: Spaltennamen in der Datenmenge für die obere Datumsgrenze
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben.
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** grdcache - Mit einem SQL-Statement wird ein Cache aufgebaut, aus dem dann mit den Konditions abgefragt wird; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiele'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

#sql select r.servicecode, r.servicedescription, case r.exttype when 'PBUS' then 'Bus' when 'PFLUG' then 'Flug' end as exttype, j.erster_fahrtag, j.letzter_fahrtag
#sql from xr_jahr j
#sql inner join cache_reisen r on r.cache_reisen_id = j.cache_reisen_id
#sql where extract(year from erster_fahrtag) = 2025 or extract(year from letzter_fahrtag) = 2025
#sql order by servicecode
#code cc=2 cnd1=eq,keycode,servicecode cnd2=date_ggdd,datum_ab,datum_bis,erster_fahrtag,letzter_fahrtag
#grd_thread y=gridcache ready=xrlt_page_stationmanager_get_reiseleiter $CODE$

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N

Modul Form

2025-10-29T09:03:41Z

Michaelebner: /* #grd_paste */

=Das Modul Form=

Im Modul Form werden die Routinen zur zur Formulargestaltung zusammengefasst.

=Das Formular=

==#frm==

Legt ein Formular an.

'''Parameter'''

* c ("Caption") - Überschrift des Formulars; Funktionen werden ersetzt
* flt ("Filter") - Setzt das Filter-Kommando des Formulars. Dieses Kommando wird aufgerufen, wenn in einer der edt- oder chk-Komponenten eine Eingabe gemacht wird. Kann auch mit #filter ausgelöst werden.
* lhc ("LogHideCommand") - Wenn Y, dann wird der Typ C ("Command") nicht geloggt. Das kann bei Massenverarbeitung den Vorgang beschleunigen; Default N, Funktionen werden ersetzt.
* ncd ("no confirmation dialog") - Wenn Y, dann wird beim Typ console kein Bestätigungsdialog verwendet. Das kann zum Beispiel dann sinnvoll sein, wenn ohnehin zu Beginn Daten per Dialog abgefragt werden und damit ggf. die Ausführung abgebrochen werden kann. Default N, Funktionen werden ersetzt.
* prc ("PageRefreshCommand") - Das Kommando, mit dem die Seite aktualisiert werden kann; nur bei Typ ''page''
* w ("Width") - Breite der Baum-Komponente beim Typ treegrid und Höhe der Baum-Komponente bei treeovergrid
* y - Typ des Formulars; default ist treepage
** console - Eine Konsolen-Anwendung, bei der nur Ausgaben in Textform gemacht werden
** live - Oben ein Eingabefeld zur Eingabe von Kommandos, unten ein Ausgabebereich; wird nur für xlive verwendet.
** page - Eine Page-Komponenten, darüber ein Filter-Bereich
** treeoverpage - Von oben nach unten: Filter-Bereich, Baum, Button-Bereich, Page
** treepage - Links eins Baum-Komponente, rechts eine Page-Komponente, darüber einer Filter- und ein Button-Bereich; ist er Default-Wert

'''Beispiel'''

#frm c=xlookup flt=xlookup_flt w=300

==#cout==

Gibt Text auf der Konsole aus. Wird bei den Form-Typen ''console'' und ''live'' verwendet.

'''Parameter'''

* c ("Caption") - Text der ausgegeben wird; Funktionen werden ersetzt; default ist ''#cout, Parameter c nicht gesetzt''
* cn ("Caption no double function") - beim Parameter c werden zweimal Funktionen ersetzt, das erlaubt Funktionen von Funktionen (also zum Beispiel eine Funktion, die mittels $DATA aus einer Datenbank geladen wird). Bisweilen führt dieses Verhalten zu unerwünschten Ergebnissen, siehe unten im Beispiel. Wird statt c der Parameter cn verwendet, werden Funktionen nur einmal ersetzt.
* clr ("Clear") - Y löscht vor der Ausgabe des Textes die Konsole; Funktionen werden ersetzt; default N
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* m ("max") - die maximale Anzahl der Zeilen; werden es mehr Zeilen, wird ab md gelöscht. Default MaxInt, Funktionen werden ersetzt
* md ("max delete") - wenn wegen Überschreitung der mit m vorgegebenen Grenze Zeilen gelöscht werden, werden sie aber dieser Position gelöscht. Auf diese Weise kann erreicht werden, dass der Anfang eines Logs stehen bleibt, zum Beispiel, damit man sieht, wann die Ausführung eines Kommandos begonnen wurde. Default 0, Funktionen werden ersetzt.
* wts ("WithoutTimeStamp") - Wenn Y, dann wird auf die Ausgabe der Datums- und Zeitangabe sowie des Typs verzichtet; Funktionen werden ersetzt; default N
* y - Typ der Ausgabe, üblicherweise ein einzelner Buchstabe (I "Info", W "Warning" E "Error"); default I

'''Beispiel'''

#cout c="Hello world"
#cout c=" " clr=Y wts=Y

#cout c=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf
#cout cn=DIR$CHR(dollar)RWC:2740_GFI_5555.pdf

==#coutl==

Fügt der Konsole eine Zeile ohne Datums- und Zeitangabe sowie ohne Typ hinzu.

'''Parameter'''

<nowiki>#coutl hat keine benannten Parameter. Die ganze Zeile nach dem #text und dem trennenden Leerzeichen wird der Konsole hinzugefügt.</nowiki>

Funktionen werden ersetzt.

'''Beispiel'''

#coutl Hello World

==#filter==

Ruft das Standard-Filter-Kommando des Formulars auf. #filter wird meist ohne Parameter aufgerufen.

'''Parameter'''

* f (Field) - Wenn hier der Name eines Feldes angegeben wird, dann wird vor der Ausführung des Filter-Statements der Wert dieses Feldes in der NodeIni ermittelt. Nach der Ausführung des Filter-Statements wird dann der erste Baumeintrag selektiert, dessen Feldinhalt übereinstimmt. Dieses Parameter wird dazu verwendet, nach der Aktualisierung des Baums an dieselbe Stelle zurückzukehren. Dazu sollte der betreffende Baumeintrag eine GUID haben, die auch in der NodeIni steht, und die vom Filter-Statement (und nicht erst durch ein Open-Statement) geladen wird. Funktionen werden ersetzt.
* o (Open) - Wenn Y, wird der über den Parameter f selektierte Baumeintrag geöffnet. Default N, Funktionen werden ersetzt.

'''Beispiel'''

#filter
#btns_btn c=Filter w=150 cmd="#filter f=data_list_id o=Y"

==#save==

Speichert alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''

#save

==#cancel==

Verwirft alle Änderungen auf der Page.

'''Parameter'''

(keine)

'''Beispiel'''
#cancel

=Dialoge=

==#msg / #message==

Gibt eine Meldung über ein Dialogfenster aus

'''Parameter'''

* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#msg c="Hello world"

==#progress_dlg==

Zeigt einen Fortschrittsdialog an, mit dem die Ausführung einer Schleife auch abgebrochen werden kann.

Die folgenden Prozeduren lassen sich über den Fortschrittsdialog abbrechen:
* #sql_open
* #loop
* #csv_paste
* #sepline
* #text_loop
* #xml_loop
* #grd_loop

'''Parameter'''
* acmd ("abort command") - Kommando, das im Falle eines Abbruchs dann noch ausgeführt wird
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cmd ("command") - Kommando, das ausgeführt wird
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* max - Die Gesamtzahl der Schleifendurchläufe (ohne Abbruch), Bezugspunkt (100%) für den Fortschrittsbalken; Funktionen werden ersetzt
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

[[file:progress.png|Fortschrittsdiakig]]

Ein einfaches Konsolen-Programm, das die Tabelle cache_buchungen ausliest und den Inhalt von zwei Spalten ausgibt. Zunächst wird die Gesamtzahl ermittelt, damit die nach max geschrieben werden kann. #cmd2 ist ein lokales Kommando, das im Falle des Abbruchs ausgeführt wird.

In #progress_dlg werden an die Caption c einige Leerzeichen angehängt, damit der Dialog breit genug dargestellt wird.

#frm c="c_test" y=console

#sql select count(*) as cnt from cache_buchungen
#sql_openval f_cnt=1

#cmd2 #coutl Vorgang abgebrochen

#progress_dlg cmd=c_test_cmd title=Fortschritt max=$VAL(1) acmd=2 c="Ausgeführte Datensätze: "

#cout c="c_test executed"

Die Routine c_test_cmd führt die SQL-Abfrage aus und führt für jeden Datensatz das lokale Kommando #cmd aus. Dieses gibt die Daten auf der Konsole aus und erhöht den Fortschrittdialog.

#cmd #coutl $DATA(dat,customernumber) - $DATA(dat,servicecode)
#cmd #progress c="Ausgeführte Datensätze: "

#sql select * from cache_buchungen
#sql_open n=dat er=1 m_=3

==#progress==

Erhöht den Wert des Fortschritt-Dialogs

'''Parameter'''
* c ("caption") - Beschriftung; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

siehe #progress_dlg

==#dlg==

Zeigt ein Kommando als Dialog an

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cmd ("command") - Kommando, das aufgerufen wird
* d ("definition") - Unter diesem Wert werden die Positionsdaten des Dialogs gespeichert (und wiederhergestellt); Funktionen werden ersetzt
* ini - Nummer der Ini-Datei, die an den Dialog übergeben und von dort wieder zurückgenommen wird. Über diese Ini-Datei können quasi beliebig viele Daten ausgetauscht werden. (Der Dialog läuft in einem anderen Interpreter, ein Zugriff auf die Daten des aufrufenden Interpreters ist nicht möglich.)
* n ("name" oder "number") - Name der Variable oder Nummer des Values, in dem das Ergebnis des Dialogs übergeben wird. Das Ergebnis des Dialogs ist üblicherweise Y oder N, abhängig davon, ob der Dialog mit einer Aktion geschlossen oder abgebrochen wird. Die eigentlichen Daten werden dann mittels der Ini-Datei übergeben.
* title - Titel des Dialogs, Funktionen werden ersetzt

'''Beispiel'''

#cmd_clear
#cmd #ini_val n=1 i=pnr_number z=$PVAL(vl,pnr_number)
#cmd #ini_val n=1 i=datum z=$PVAL(umbuchen,datum)
#cmd #ini_val n=1 i=preis z=$PVAL(vl,totalprice)
#cmd #dlg title="Umbuchungsanfrage" d=xverleg_dlg cmd=xverleg_dlg n=1 ini=1

#btns_seg
#btns_btn c="Umbuchungsanfrage stellen" w=210 cmd=1

==#dlg_close==

Schließt einen Dialog

'''Parameter'''
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* z - Wert, der als Ergebnis des Dialogs zurückgegeben wird.

'''Beispiel'''

#cmd #ini_val n=1 i=adrnr z=$PVAL(vl,adrnr)
#cmd #dlg_close z=Y

#segbuttons
#segbutton c="Kundennummer übernehmen und Dialog schließen" w=350 cmd=1

==$DLG_YESNO==

Zeigt einen Dialog an, der mit Yes (Funktionsergebnis Y) oder No (Funktionsergebnis N) beantwortet werden kann.

'''Parameter'''
# Titel des Dialogs
# Beschriftung des Dialogs

'''Beispiel'''

#cout c="$DLG_YESNO(frei gewählter Titel,da steht ein beliebiger Text)"

=Die einfachen Komponenten=

==#btn==

Fügt einen Button in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons
* cmd ("command") - Kommando des Buttons, wenn s nicht gesetzt ist
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Buttons
* p ("parent") - legt fest, in welchem Bereich der Button eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für den Button wird eine neue Zeile begonnen
* s ("select") - Kommando des Buttons
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* w ("width") - Breite des Buttons
* y ("type") - wenn einer der folgenden Standard-Werte verwendet wird, dann erhält der Button ein Standard-Verhalten und die Parameter c und w bleiben unberücksichtigt.
** back - Button mit Back-Symbol (Pfeil nach links)
** cancel - Button mit Cancel-Symbol (Daumen nach unten)
** export - Button mit Export-Symbol
** fwd - Button mit Forward-Symbol (Pfeil nach rechts)
** import - Button mit Import-Symbol
** pdf - Button mit PDF-Symbol
** save - Button mit Disketten-Symbol
** xls - (Schreibt den Seiteninhalt in eine Excel-Datei; noch nicht implementiert)

'''Beispiel'''

#btn y=save s=#save se=c
#btn y=cancel s=#cancel se=cf
#btn y=back s=#tree_back se=b
#btn y=backback s=#tree_fwd se=b
#btn y=export s=xlookup_eximport(ex) se=b
#btn y=import s=xlookup_eximport(im) se=b
#btn c=$T(Add_list) w=120 s=xlookup_add(list) se=b

==#chk==

Fügt eine Checkbox in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung der Checkbox
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text der Checkbox
* p ("parent") - legt fest, in welchem Bereich die Checkbox eingefügt wird.
** b - Button-Bereich
** f - Filter-Bereich
* n - Name der Checkbox, wird benötigt, um mit $EDT() auf den Check-Status zugreifen zu können
* nl ("new line") - Für die Checkbox wird eine neue Zeile begonnen
* z - Wert der Checkbox (Y oder N)

'''Beispiel'''

==#edt==

Fügt ein Edit-Feld in den Button- oder den Filterbereich ein.

'''Parameter'''

* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cy ("character type") - Groß- und Kleinschreibung, default n
** l - lower case
** n - normal
** u - upper case
* h ("hint") - Mouse-Over-Text des Edit-Felds
* p ("parent") - legt fest, in welchem Bereich das Edit-Feld eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* l ("length") - maximale Länge; default unbegrenzt, Funktionen werden ersetzt
* n - Name des Edit-Feldes, wird benötigt, um mit $EDT() auf den Inhalt zugreifen zu können
* nl ("NewLine") - Für das Edit-Feld wird eine neue Zeile begonnen
* sf ("SetFocus") - Wenn Y, wird der Eingabefokus auf dieses Edit-Feld gesetzt; default N, Funktionen werden ersetzt
* y - Typ, spezifiziert, welche Eingaben zulässig sind; default text,
** int
** curr, curr4
** date, datemin, datesec
** text
* z - Inhalt des Edit-Feldes

'''Beispiel'''

#lbl c=$T(lookup_filter) w=140
#edt n=edt1 w=135 h="Hier den Text eingeben, nach dem gesucht werden soll." z=$INI(usr,edt1,xlookup)

==#lbl==

Fügt ein Label in den Button- oder den Filterbereich ein.

'''Parameter'''

* c ("caption") - Beschriftung des Labels
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* h ("hint") - Mouse-Over-Text des Labels
* p ("parent") - legt fest, in welchem Bereich das Label eingefügt wird; default f
** b - Button-Bereich
** f - Filter-Bereich
* nl ("new line") - Für das Label wird eine neue Zeile begonnen

'''Beispiel'''

==$EDT()==

Gibt den Wert einer Edit- oder Checkbox-Komponente zurück. Eine Checkbox gibt Y oder N zurück.

'''Parameter'''

# Name der Edit- oder Checkbox-Komponente

'''Beispiele'''

~ $LEN($EDT(edt1)) = 4
#filltreesql k_kuerzel=$EDT(edt1)

=Tree=

Der Tree ist eine Baumansicht, in welcher die einzelnen Einträge hierarchisch gegliedert werden können.

Die Einträge können aus Tabelleninhalten und SQL-Statements gefüllt werden, es können auch einzelne Einträge hinzugefügt werden. Der Baum muss nicht von Anfang an komplett aufgebaut werden, sondern es können Inhalte beim Öffnen eines Eintrags dynamisch nachgeladen werden.

Der gängigste Weg, einen Baum zu füllen, ist #tree_fillsql. Siehe Beispiel dort.

==#tree_clear==

Macht den Tree leer. Wird üblicherweise eingesetzt, bevor der Baum (neu) gefüllt wird.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#tree_clear

==#tree_add==

Für dem Baum einen einzelnen Eintrag hinzu.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* tf ("tree focus") - wenn Y, wird der Eingabefokus nach Aufruf des Kommandos im Parameter s auf den Baum gesetzt. Default Y, Funktionen werden ersetzt. Muss auf N gesetzt werden, wenn im Kommando des Parameters s eine Seite gefüllt und dabei eine Zelle eines Grids selektiert werden soll. Siehe Beispiele
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

#addtree u=root c=$T(change_passwort) s="#page_fill d=xsettings_page_password"
#addtree u=root c=$T(Set_language) s="#page_fill d=xsettings_page_language"

#addtree u=sel c=$T(new_list) t=data_list s="#page_fill d=xlookup_page_list" si=Y f_category=$FND(category)

#tree_add u=o c=Angebote s="#page_fill d=xbus_page_angebote" tf=N

==#tree_fill==

Füllt den Baum aus den Werten einer Datenbanktabelle.

Mit Hilfe der Parameter qw und qo kann das Ergebnis gefiltert und sortiert werden, es ist aber stets nur eine Ebene im Baum. Sollen mehrere Ebenen im Baum gefüllt werden, so ist die Prozedur #tree_fillsql das Mittel der Wahl.

Üblicherweise wird das SQL-Statement aus den Parameters t, qw und qo zusammengesetzt. Dabei sind die Parameter qw und qo optional. Fehlen Sie, lautet das SQL-Statement SELECT * FROM tabllenname.

Alternativ kann auch mit #sql das Statement vorgegeben werden (zum Beispiel, wenn ein JOIN gebraucht wird). Dann werden die Parameter qw und qo nicht berücksichtigt.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird nach dem Füllen des Baums der erste Eintrag selektiert. Default N, Funktionen werden ersetzt.
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet.
* m ("max") - Maximale Anzahl der Baumeinträge, die erstellt werden
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* si ("select item") - der neue Eintrag soll nach Abschluss des Kommandos selektiert werden
* sii ("select item instantly") - der neue Eintrag soll sofort und nicht erst nach Abschluss des Kommandos selektiert werden
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#filltree u=exp t=test_test c1=zahl c2=test_1

==#tree_node==

Die Prozedur #tree_node legt für #tree_fillsql und #tree_fillpath eine Ebenen-Definition an.

'''Parameter'''

* c ("caption") - die Beschriftung des Eintrags
* c1, c2 ("caption") - die Feldnamen in der Datenmenge, aus welcher die erste und zweite Beschriftung geladen werden
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* iek ("ignore empty key") - wenn Y, dann wird kein Eintrag im Baum erzeugt, wenn die jeweilige Wert in der mit k bezeichneten Spalte (ggf. über t abgeleitet) leer ist. Siehe Beispiel
* k ("key") - das Schlüsselfeld für den Eintrag; wird dieser Parameter nicht gesetzt, dann wird das Schlüsselfeld aus dem Namen der Tabelle abgeleitet; Funktionen werden ersetzt
* ld1, ld2, ls1, ls2 - sind die Feldnamen in der Datenmenge Schlüsselwerte für Nachschlagelisten, so können für die Beschriftung die Klartexte genutzt werden. Dazu muss die Nachschlageliste (ld1, ld2) beziehungsweise das Special (ls1, ls2) angegeben werden.
* nc ("node clear") - Werden Einträge auf mehreren Ebenen angelegt, dann müssen meist bei einem Wechsel auf der übergeordneten Ebene die Werte der Ebenen darunter gelöscht werden. Mit nc=Y passiert eben dies.
* ne ("node expand") - der neue Eintrag soll gleich expandiert werden.
* o ("open") - Kommando, das ausgeführt wird, wenn der Eintrag expandiert wird; üblicherweise werden dabei Bauminhalte dynamisch nachgeladen.
* r ("rights") - Rechtedefinition für den Eintrag
* s ("select") - Kommando, das ausgeführt wird, wenn der Eintrag selektiert wird; üblicherweise wird dabei eine neue Seite geladen.
* sn ("special node") - wenn Y, wird der Eintrag gekennzeichnet und kann mit u=spec referenziert werden; Funktionen werden ersetzt
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle; Funktionen werden ersetzt
* u - Übergeordneter Eintrag. Unter diesem Eintrag wird der neue Eintrag eingefügt.
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiele'''

Siehe #tree_fillsql

Hier ein Beispiel für iek=Y. Sofern es keine Zubringer gibt, wird auch der entsprechende Eintrag sowie dessen beiden Untereinträge (''Passagierliste'' und ''Angebote und Aufträge'') nicht eingefügt. Es ist zu beachten, dass die Parameter iek=Y sowie k=zubringer auch bei den beiden Untereinträgen zu setzen sind.

#tree_node u=o t=bus_touren c1=tournr c2=c2 f_zielbus=! nc=Y s="#page_fill d=xbus_page_br_tour(hb)" nc=Y
#tree_node u=l c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(hb)"
#tree_node u=lp c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote"
#tree_node u=lp k=rueckbus c1=r_tournr c2=r2 nc=Y f_bus_touren_id=rueckbus f_tournr=r_tournr s="#page_fill d=xbus_page_br_tour(r)" cnd=$FND(o,bit_pendelreise)
#tree_node u=lp k=zubringer c1=z_tournr c2=z2 nc=Y f_bus_touren_id=zubringer f_tournr=z_tournr s="#page_fill d=xbus_page_br_tour(zu)" iek=Y
#tree_node u=l k=zubringer c=Passagierliste s="#page_fill d=xbus_page_br_tour_pl(zu)" iek=Y
#tree_node u=lp k=zubringer c="Angebote und Aufträge" s="#page_fill d=xbus_page_br_tour_angebote_zu" iek=Y
#tree_fillsql

==#tree_fillsql==

Füllt den Baum aus den Werten eines SQL-Statements. Es können dabei Einträge auf mehreren Ebenen angelegt werden. Die einzelnen Ebenen sind mit #tree_node zu definieren.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* q ("Quelle") - Quelle der Daten; default ist sql. (Relevant, wenn weitere Datenquellen hinzugefügt werden.)
** sql - Das mit #sql erstellte SQL-Statement.
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - Name der Tabelle. Wird benötigt, wenn Werte in den Baum zurück geschrieben werden sollen.

'''Beispiele'''

#sql select * from data_special order by category, name;
#tree_node u=root k=category c1=category nc=Y s="#fillgrid d=xspecial_page_category"
#tree_node u=last t=data_special c1=name s="#fillgrid d=xspecial_page_list"
#tree_fillsql mex=3

#sql select l.* from data_list l
#sql left outer join data_list_item i on l.data_list_id = i.data_list_id
#sql left outer join translate_list_item t on i.data_list_item_id = t.data_list_item_id
#sql where upper(l.name) like upper(:kedt)
#sql or upper(i.value) like upper(:kedt)
#sql or upper(t.value) like upper(:kedt)
#sql order by l.name;
#tree_node u=root t=data_list c1=name s="#fillgrid d=xlookup_page_list" o=xlookup_open(list)
#tree_fillsql kedt=$EDT(edt1)% mex=3

==#tree_fillpath==

Füllt den Baum aus der Pfad-Spalte eines SQL-Statements. Die Ebene ist mit #tree_node zu definieren.

Das SQL-Statement kann mit #sql definiert werden, aber auch mit t, qw und qo zusammengesetzt werden. Das SQL-Statement muss nach dem Pfad sortiert sein.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* fi ("first item") - Wenn Y, wird der erste hinzugefügte Eintrag anschließend selektiert. Default ist N, Funktionen werden ersetzt.
* k ("key") - Die Parameter im SQL-Statement beginnen nach den Konventionen mit :k. Da keine weitere Parameter mit k beginnen, werden so Namenskonflikte vermieden. Siehe auch das zweite Beispiel.
* m ("max") - Maximale Anzahl von Datensätzen in der Ergebnismenge, aus denen Baumeinträge erstellt werden
* mex ("max expand") - Wenn die Zahl der hinzugefügten Einträge der obersten Ebene unter dieser Zahl liegt, dann werden die Einträge expandiert. Default 0.
* pfx ("prefix") - Dem eigentlichen Pfad vorangehende Zeichenfolge.
* pn ("path name") - Name der Pfad-Spalte in der SQL-Abfrage
* qo ("query order") - ORDER-Klausel für das zu erstellende SQL-Statement
* qw ("query where") - WHERE-Klausel für das zu erstellende SQL-Statement
* r ("rights") - damit der Einträge dem Baum hinzu gefügt werden, muss zumindest das Leserecht vorliegen. Default sind die Rechte des Formulars.
* t ("table") - der Tabellenname der für den Eintrag maßgeblichen Tabelle

'''Beispiele'''

#sql select g.* from user_group g where g.type = 'G' order by path
#tree_node u=exp t=user_group c1=path s="#fillgrid d=xuser_page_group"
#tree_fillpath t=user_group pn=path

==#tree_fillthread==

Ergänzt den Baum durch Daten aus einem Thread. Wird üblicherweise dazu verwendet, Daten aus einer anderen Datenbank zu ergänzen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbank, default ist die Default-Datenbank
* k ("key") - Parameter im SQL-Statement; in der Ini des Baums (Sektion DATA) muss es einen Eintrag mit diesem Feldnamen geben.
* u - Der übergeordnete Knoten, unterhalb dessen der Thread den Baum ergänzt; default r, Funktionen werden ersetzt
** s ("selected") - der selektierte Baum-Eintrag
** sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
** spp
** sppp
** o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
** l ("last") - der zuletzt eingefügt Baum-Eintrag
** lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
** lpp
** lppp
** r ("root") - Der übergeordnete Eintrag der obersten Ebene
** spec ("special") - Der Eintrag wird unter denjenigen Eintrag gehängt, der mit sn=Y als ''special node'' gekennzeichnet wurde.

'''Beispiel'''

#sql select vorname || ' ' || nachname as kname from asd where adrnr = :adrnr
#tree_fillthread u=o k=adrnr db=ora_prod

==#tree_sel==

Selektiert einen Eintrag.

Bei den Typen rf, sf, rfa und sfa wird im Baum nach einem bestimmten Wert (oder zwei bestimmten Werten) durchsucht. An jedem Eintrag hängt eine Ini-Datei, in der verschiedene Werte gespeichert sind. Es wird dann der erste Eintrag selektiert, in dessen Ini-Feld f der Wert z steht. Die Groß- und Kleinschreibung wird dabei ignoriert.

Neben f und z können auch noch f2 und z2 gesetzt werden. Bei rf und sf sind diese beiden Suchkriterien (f/z und f2/z2) oder-verknüpft. Die Typen rf und sf werden auch bei nur einem Suchkriterium verwendet, da bei einer oder-Verknüpfung das Ergebnis und damit die Existenz eines zweiten Suchkriteriums egal ist. Mit rfa und sfa werden die Suchkriterien und-verknüpft.

'''Parameter'''

* cnd ("condition") - nur wenn true, wir die Anweisung ausgeführt. Default true, Funktionen werden ersetzt.
* f, f2 ("field") - der erste und zweite Feldname (nur für die Typen rf, sf, rfa und sfa)
* o ("open") - wenn Y, wird der nach der Selektierung selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* op ("open paretns") - wenn Y, werden nach der Selektierung alle übergeordneten Einträge des selektierten Eintrag expandiert; default N, Funktionen werden ersetzt
* sic ("search in children") - wnn Y, werden auch die Unterknoten durchsucht; default N, Funktionen werden ersetzt
* y - Typ der Prozedur
** c ("child") - geht zum ersten untergeordneten Eintrag
** cc ("childchild") - geht zum ersten untergeordneten Eintrag des ersten untergeordneten Eintrags
** ccc - geht in der Hierarchie drei Stufen nach unten
** cccc - geht in der Hierarchie vier Stufen nach unten
** ccccc - geht in der Hierarchie fünf Stufen nach unten
** p ("parent") - geht zum direkt übergeordneten Eintrag
** pp ("parentparent") - geht zum übergeordneten Eintrag des übergeordneten Eintrags
** ppp - geht in der Hierarchie drei Stufen nach oben
** pppp - geht in der Hierarchie vier Stufen nach oben
** ppppp - geht in der Hierarchie fünf Stufen nach oben
** rf ("rootfind") - Sucht im kompletten Baum, die Suchkriterien sind oder-verknüpft
** rfa ("rootfindand") - Sucht im kompletten Baum, die Suchkriterien sind und-verknüpft
** sf ("selectedfind") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft
** s ("selected") - Selektiert den selektierten Eintrag erneut, ruft damit das Selektionskommando erneut auf
** sas ("selected asynchronous") - wie y=s, nur dass die Prozedur leicht verzögert über einen Timer aufgerufen wird, damit aufrufende Funktionalität bereits abgearbeitet ist. Übernimmt o, op und wsc.
** sfa ("selectedfindand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft
** sfo ("selectedfindopen") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind oder-verknüpft; zuvor wird der Eintrag expandiert
** sfoa ("selectedfindopenand") - Sucht unterhalb des selektierten Eintrags, die Suchkriterien sind und-verknüpft; zuvor wird der Eintrag expandiert; funktioniert auch als sfao
* wsc ("without select command") - Wenn Y, wird der Eintrag selektiert, ohne das Selection-Kommando auszuführen; default N. Wird üblicherweise dann verwendet, wenn mit mehreren #tree_sel-Prozeduren durch den Baum navigiert wird und aus Gründen der Geschwindigkeit dazwischenliegende Seitenaufrufe vermieden werden sollen.
* z, z2 - der erste und zweite Wert (nur für die Typen rf, sf, rfa und sfa)

'''Beispiel'''

#btn c=test w=120 s="#tree_sel y=sf f=data_list_id z=7B0EC22C-8526-4FDB-8D10-0187ECF793C0 sic=Y" se=b

#cmdclear
#cmd #tree_sel y=c o=Y
#cmd #tree_sel y=c
#segbuttons
#segbutton c=Test w=150 cmd=1

Im zweiten Beispiel soll in der Hierarchie zwei Stufen nach unten gegangen werden. Eigentlich würde das mit dem Typ cc gehen. Allerdings wird die unterste Ebene hier dynamisch nachgeladen, so dass eine Suche mit dem Typ cc ins Leere laufen würde. Die Lösung ist, zunächst mit dem Typ c eine Stufe nach unten zu gehen, dabei mit o=Y den Node zu expandieren und dabei dynamisch nachzuladen und dann mit dem Typ c eine weitere Stufe nach unten zu gehen.

==#tree_back==

Geht in die Baum-Historie einen Schritt zurück, also zum davor selektierten Eintrag.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_fwd==

Geht in die Baum-Historie einen Schritt weiter. Kann zur aufgerufen werden, wenn zuvor zurück gegangen wurde.

'''Parameter'''

(keine)

'''Beispiel'''

#btn y=back s=#tree_back se=b
#btn y=fwd s=#tree_fwd se=b

==#tree_clearnode==

Entfernt als Unter-Einträge des aktuellen Baum-Eintrags. Kann dazu verwendet werden, um einen Zweig des Baums neu aufzubauen.

'''Parameter'''

* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt

'''Beispiel'''

#page asc="#tree_clearnode"

==$FND()==

Sucht in der Ini-Datei des mit dem ersten Parameter spezifizierten Baum-Eintrags nach dem im zweiten Parameter übergebenen Feld und gibt dessen Inhalt zurück. Wird in der Ini-Datei kein entsprechender Eintrag gefunden, dann wird der Vorgang in den übergeordneten Einträgen so lange wiederholt, bis ein Eintrag mit diesem Feldnamen gefunden wurde oder es keine übergeordneten Einträge mehr gibt.

'''Parameter'''
# Eintrag im Tree
## s ("selected") - der selektierte Baum-Eintrag
## sp ("selected parent") - Der übergeordnete Eintrag des selektierten Eintrags
## spp
## sppp
## o ("opening") - der Baum-Eintrag, der gerade expandiert wird.
## l ("last") - der zuletzt eingefügt Baum-Eintrag
## lp ("last parent") - Der übergeordnete Eintrag des zuletzt eingefügten Eintrags
## lpp
## lppp
## r ("root") - Der übergeordnete Eintrag der obersten Ebene
# Feldname (Name des Eintrags in der Ini-Datei)
# optional: NULL-Value-Wert, also Ergebniswert, wenn der Inhalt des Feldes leer sein sollte

'''Beispiel'''

#grddata q=sql t=data_list k_cat=$FND(s,category)

=Page=

==#page==

Das Kommando #page setzt einige Eigenschaften auf Seiten-Ebene.

'''Parameter'''
* asc ("after save command") - Kommando, das ausgeführt wird, nachdem die Seite gespeichert wurde; Funktionen werden ersetzt
* bsc ("before save command") - Kommando, das ausgeführt wird, bevor die Seite gespeichert wird; Funktionen werden ersetzt
* n - Name der Page; kann mit $PAGE() dann ermittelt werden
* rar ("refresh after return") - wenn von dem Tab auf einen anderen gesprungen wird, und dieser Tab wird geschlossen, dann wird die Page aktualisiert, sofern rar=Y. Beim Formulartyp ''treepage'' wird das Selektionskommando des selektierten Baumeintrags neu aufgerufen, beim Formulartyp ''page'' wird das Kommando im Parameter rar der Prozedur #frm angegeben.
* ras ("refresh after save") - wenn Y, wird die Seite nach dem Speichern erneut geladen; default N, Funktionen werden ersetzt
* tac ("tab caption") - setzt die Beschriftung des jeweiligen Tabs des BAF-Clients; Funktionen werden ersetzt
* y - Typ der Seite; default ist ''normal''
** dashhor
** dashvert
** normal

'''Beispiele'''

#page
#page ras=Y
#page asc="#tree_clearnode"

==#page_fill==

Füllt die Page neu.

'''Parameter'''

* cmd ("command") - Das Kommando, das ausgeführt wird, um die Seite aufzubauen. (Alternativ d)
* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''
#tree_fill u=root t=devtext c1=name f_parent=! s="#page_fill d=xdevtext_page_text" o=xdevtext_open fi=Y

==#page_prim / #prim==

Seiten werden zunächst in Primärregionen unterteilt (die keine sichtbaren Elemente haben), die Primärregionen wiederum in die Kategorien, und diese wiederum in die Sektionen.

'''Parameter'''
* as ("AutoSize") - Wenn Y, wird die Größe der Primärregion dem Inhalt angepasst; default Y, Funktionen werden ersetzt
* sz ("size") - Größe der Primärregion in Pixel; Funktionen werden ersetzt

'''Beispiele'''
#prim
#prim as=N sz=500

==#page_cat / #cat==

Legt eine Kategorie an. Zuvor muss eine Primärregion angelegt worden sein. #page_cat und #cat sind äquivalente Bezeichner für dieselbe Prozedur.

'''Parameter'''
* c ("Caption") - Beschriftung der Kategorie
* as ("AutoSize") - Die Größe der Primärregion wird dem Inhalt angepasst
* o ("opened") - wenn Y, dann wird die Kategorie geöffnet erzeugt; default Y; Funktionen werden ersetzt
* oci ("open close ini") - Wenn ein Wert gesetzt ist, wird der Open/Close-Status in der User-Ini gespeichert und beim nächsten Aufruf der Seite so wiederhergestellt. Dem Parameter oci wird der Name des Eintrags in der Ini-Datei zugewiesen; Funktionen werden ersetzt.
* sz ("size") - Größe der Primärregion in Pixel

'''Beispiel'''
#cat as=N sz=360 c=$T(Languages) oci=lamguages

==#page_val==

Schreibt einen Wert in die Page, genauer gesagt in das mit i bezeichnete Segment. Zusätzlich oder alternativ kann eine Zelle selektiert werden.

Bei Text-, Memo- und Picture-Segmenten werden nur die Parameter i und z benötigt und beachtet. Die VL, Grid- und XGrid-Segmenten muss die Spalte und die Reihe spezifiziert werden.

Bei Picture-Segmenten wird die Eigenschaft Filename geschrieben, sie sollten q=file haben.

'''Parameter'''
* c ("caption") - Verändert die Beschriftung des Segments
* chg ("change") - Wenn Y, wird mit der Änderung die Zelle auf Changed gesetzt; default Y; Funktionen werden ersetzt
* cnd ("Condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* col ("Column") - Index der Spalte, in welche der Wert geschrieben wird; wenn nicht gesetzt, dann wird der Parameter f verwendet
* f ("field") - Feldname der Zelle oder der Spalte, in welche der Wert geschrieben wird; wird nur verwendet, wenn col nicht gesetzt ost
* i ("item") - Name des Segments, in welches der Wert geschrieben wird
* ie ("if empty") - Wenn Y, wird der Wert nur in die Zelle geschrieben, wenn diese leer ist; default N; Funktionen werden ersetzt
* inr ("ignore next row") - Wenn über #page_val eine Zelle selektiert wird, die Prozedur aber über ein chg-Kommando desselben Grids aufgerufen wird, wird durch die Return-Taste die nächste Reihe selektiert und nicht diejenige, die über #page_val selektiert wurde. Um das zu vermeiden, wird inr auf Y gesetzt. Default N, Funktionen werden ersetzt.
* row - Index der Reihe, in die geschrieben wird. Alternativ sind bei Grid-Segmenten folgende Reihenbezeichnungen möglich:
** all - der Wert wird in alle Reihen geschrieben
** allsel ("all selected") - der Wert wird in alle Reihen geschrieben, die mit der in der Prozedur #grd_seg mit der Parameter sc ("selection column") spezifizierten Zelle selektiert wurden
** looprow - die in der Ausführung der Prozedur #grd_loop gerade aktive Reihe
** sel ("selected") - die aktuell selektierte Reihe
* sr ("segment refresh") - Wenn Y, wird ein Refresh des Segments durchgeführt; default N, Funktionen werden ersetzt
* y - Typ der Operation; Funktionen werden ersetzt, default val
** allcol - Es werden alle Spalten auf Übereinstimmung mit dem Parameter f geprüft; wird vor allem in einem X-Grid verwendet
** sel - Die Zelle wird selektiert und das Grid bekommt den Focus
** val - Ein Wert wird geschrieben
** valsel oder selval - Ein Wert wir geschrieben und die Zelle wird selektiert.
* z - Wert, der geschrieben wird

'''Beispiele'''
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
#page_val i=erfassen f=kuerzel z= y=valsel inr=Y

==#page_check==

Um Eingaben zu Validieren, können Checks definiert werden. Diese werden nach Benutzereingaben ausgeführt. Führen diese Checks zu Fehlern, so wird das Speichern der Daten verhindert. Die Fehlerliste wird statt des Trees angezeigt. Mit dem Beseitigen der Fehler oder dem verwerfen der Änderungen wird die Fehlerliste wieder ausgeblendet.

'''Parameter'''
* c ("caption") - Text, der beim Scheitern der Prüfung in die Fehlerliste aufgenommen wird.
* chk ("check") - Wenn nicht Y, dann gilt die Prüfung als gescheitert; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prüfung ausgeführt; Funktionen werden ersetzt
* y - Typ des Checks; default e
** e ("error") - Fehler
** n ("none") - Check wird geprüft, aber nicht angezeigt und verhindert auch nicht da Speichern
** w ("warning") - Warnung; wird angezeigt, aber verhindert nicht das Speichern

'''Beispiele'''

#page_check c="Das Passwort muss mindestens 6 Zeichen lang sein" chk="$BOOL($LEN($PVAL(vl,1,2)) > 5)"
#page_check c="Die Bestätigung stimmt nicht mit dem Paswort überein" chk="$BOOL($PVAL(vl,1,2) = $PVAL(vl,1,3))"

==#page_ready==

Wird eine Seite nicht über #page_fill erstellt, sondern dadurch, dass das Kommando direkt aufgerufen wird, so müssen die Routinen, welche nach Aufbau der Seite ausgeführt werden müssen, explizit aufgerufen werden; dazu dient #page_ready.

'''Parameter'''

* rs ("resize") - wenn Y, wird eine Größenänderungs-Nachricht an die Page gesendet, die bisweilen benötigt wird, damit die Seite korrekt aufgebaut wird; default N; Funktionen werden ersetzt.

'''Beispiel'''

#page_ready

==$PAGE()==

Ermittelt den Namen der aktuellen Page.

'''Parameter'''

# Art der Wertes; default ist name
* changecol - Der 0-relative Index der Spalte, in der gerade ein Wert geändert wird
* changerow - Der 0-relative Index der Reihe, in der gerade ein Wert geändert wird
* link - LinkValue
* debuginfos - Infos zum Debugging
* name - Name der Page

'''Beispiel'''

#btn c=test w=120 s="#message c=$PAGE()" se=b h="Dies ist ein Test"

==$PVAL()==

Ermittelt einen Wert aus der Page

'''Text- und Memo-Segmente'''

Es muss nur der Name des Segments angegeben werden, $PVAL() gibt den kompletten Text zurück.

'''Grid- und XGrid-Segmente'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter Parameter folgt entweder der Index der Spalte (0-relativ, die erste Spalte hat also den Index 0) oder der Feldname der Spalte.

Als dritter Parameter wird 0-relativ der Index der Zeile angegeben, alternativ eine Sonderzeile oder eine Aggregatfunktion.

'''Spaltenaggregate'''

Für Grid- und XGrid-Segmente können Spaltenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter Index der Spalte oder Feldname, als dritter Parameter der Name der Aggregatfunktion:
* count - Anzahl der Datensätze
* sum - Summe der Werte
* max - Maximum der Werte
* min - Minimum der Werte
* avg - Durchschnitt der Werte
* med - Median der Werte
* countsel - Anzahl der selektierten Datensätze
* sumsel - Summe der Werte der selektierten Datensätze
* maxsel - Maximum der Werte der selektierten Datensätze
* minsel - Minimum der Werte der selektierten Datensätze
* avgsel - Durchschnitt der Werte der selektierten Datensätze
* medsel - Median der Werte der selektierten Datensätze
* countvis - Anzahl der sichtbaren Datensätze
* sumvis - Summe der Werte der sichtbaren Datensätze
* maxvis - Maximum der Werte der sichtbaren Datensätze
* minvis - Minimum der Werte der sichtbaren Datensätze
* avgvis - Durchschnitt der Werte der sichtbaren Datensätze
* medvis - Median der Werte der sichtbaren Datensätze

'''Reihenaggregate'''

Für Grid- und XGrid-Segmente können Reihenaggreagte gebildet werden. Erste Parameter ist der Name des Segments, zweiter Parameter die Funktion, die mit einem Fragezeichen beginnen muss, als dritter Parameter der Index der Reihe beziehungsweise eine Sonderreihe:
* ?count - Anzahl der Spalten
* ?sum - Summe der Werte
* ?max - Maximum der Werte
* ?min - Minimum der Werte
* ?avg - Durchschnitt der Werte
* ?all - Alle Zellenwerte, getrennt durch das Trennzeichen bzw. die Trennzeichenfolge in Parameter vier.

In einem Grid sind üblicherweise Spalten, für welche die Aggregatfunktion gebildet werden soll, mit anderen Spalten kombiniert. Um diese Spalten unterscheiden zu können, kann der Parameter ''grp'' der Spalte gesetzt werden. Bei der Berechnung der Reihenaggregate wird dann geschaut, ob die Zeichenfolge im fünften Parameter im Parameter ''grp'' der Spalte vorkommt; nur dann wird die betreffende Spalte berücksichtigt. Hinweis: Der Parameter ''grp'' der Spalte kann mehrere Gruppenbezeichner enthalten, wenn die betreffende Spalte für verschiedene Reihenaggregate verwendet wird. Diese können durch frei gewählte Trennzeichen getrennt werden, müssen aber nicht, sofern sie hinreichend unterscheidbar sind. Groß- und Kleinschreibung wird unterschieden.

Im sechsten Parameter kann der Ergebnistyp angegeben werden:
* bool
* curr
* curr4
* date
* datemin
* datesek
* int

Die Funktion ?count wird jedoch immer als ganze Zahl dargestellt.

'''VL-Segment'''

Wie immer muss der Name des Segments als erster Parameter angegeben werden.

Als zweiter und dritter Parameter wird 0-relativ der Index der Spalte und der Zeile angegeben.

Alternativ kann als zweiter Parameter ein Feldname angegeben werden. $PVAL() durchsucht dann alle Reihen und Spalten des VL-Segments nach diesem Feldnamen.

'''Sonderzeilen'''

Statt der Bezeichnung über die Zeilennummer sind auch die folgenden Werte möglich:

* change - die Zeile, in der die gerade geänderte Zelle liegt
* checkrow - die aktuelle Zeile bei der Ausführung von $GRD_CHECK
* calcrow - die Zeile, die gerade bei grd_calc verwendet wird
* datarow - bezieht sich auf die aktuelle Zeile bei $PVAL
* data - dieselbe Zeile im Grid wie das Kommando, das in dieser Zeile ausgeführt wird
* linkrow - die Zeile eines ausgeführten Link-Kommandos
* lookuplive - die Zeile, die gerade in Lookup-Live verwendet wird
* looprow - die aktuelle Zeile bei der Ausführung von #grd_loop
* radio - die mit einem Radio-Button gewählte Zeile; sc des Grid-Segments muss auf diese Spalte zeigen
* saverow - beim Speichern des Grids die Zeile, die gerade gespeichert wird
* sel - die selektierte Zeile

'''Sonderwerte'''

Bei Grid-, XGrid- und VL-Segmenten können Sonderwerte ermittelt werden. Es ist als zweiter Parameter ein Ausrufezeichen und als dritter Parameter der Name des Sonderwertes einzugeben:
* calcrow - der 0-relative Index der aktuellen Reihe bei #grd_calc
* checkrow - der 0-relative Index der aktuellen Reihe bei Plausibilitätsprüfungen
* looprow - der 0-relative Index der aktuellen Reihe in #grd_loop

'''Parameter'''
# Name des Segments
# Spaltenindex (0-relativ) oder Feldname; bei Sonderwerten ein Ausrufezeichen, ''!col'' bezieht sich auf die aktuelle Spalte, Reihenaggregate beginnen mit einem Fragezeichen
# Reihenindex (0-relativ), alternativ eine Sonderreihe:
## looprow - aktuelle Reihe in #grd_loop
## all - es werden alle Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
## allsel - es werden alle selektierten Reihen zurückgegeben, als Trennzeichen wird der vierte Parameter verwendet
# Trennzeichen(folge), wenn mehrere Zeilen zurückgegeben werden
# Spaltengruppe, wird nur bei Reihenaggreagten gebraucht
# Ergebnistyp, wird nur bei Reihenaggreagten gebraucht
# wenn ''display'', dann wird der angezeigte Text (z.B. bei Nachschlagelisten) verwendet

'''Beispiele'''

#cmd #message c=$PVAL(item,value,1)
#text $PVAL(item,name,looprow) - $PVAL(item,description,looprow)
#clipboard t=$PVAL(grid,adrnr,all,$CHR(crlf))
#grdcol c1=Summe y=curr nd=Y cmdn=$PVAL(grid,?sum,data,,csum)
#xgrd_col c1="Gesamt" w=80 nd=Y ro=Y cmd=$PVAL(gridxy,?sum,datarow,,sumc,int) y=int a=r fc1=$PVAL(gridxy,!col,sum) fa1=r fy1=int

Wenn Spalten-Aggregate (zum Beispiel Spalten-Summen) von Spalten gebildet werden, die von einem Thread gefüllt werden, dann sind die Daten zu dem Zeitpunkt, zu dem die Summe gebildet wird, noch gar nicht vorhanden. In diesem Fall kann eine erneute Summenbildung angestoßen werden, indem man nach Beendigung des Threads #page_ready aufruft:

#grd_col f=provision y=curr w=60 a=d2 c1="Provision" q=thread fc1=$PVAL(grid,!col,sum) fy1=curr fa1=d2

...

#sql select provision from rzl where code = :iso_extra_code
#grd_thread k=iso_extra_code db=pg_prod ready=#page_ready

==$CCI()==

Ermittelt die Farbe für eine Zelle anhand eines ganzzahligen Wertes

'''Parameter'''

# Wert. Wenn !, dann der Wert der Zelle, deren Farbe gerade gesetzt werden soll.
# Wenn L (lower), dann muss der Wert gleich oder unterhalb des Vergleichswertes sein; andernfalls muss er gleich oder über dem vergleichswert
# Vergleichswert für die Farbe rot
# optional: Vergleichswert für die Farbe gelb - wird nur geprüft, wenn die Farbe nicht bereits rot
# optional: Vergleichswert für die Farbe grün - wird nur geprüft, wenn die Farbe nicht bereits rot oder gelb

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

Wenn die Anzahl der Dubletten 1 oder höher, wird die Farbe der Zelle auf rot gesetzt.

=Segmente=

Eine Page ist in Primär-Regionen, diese in Kategorien und diese wiederum in Segmente eingeteilt.

==Segment-Typen==

'''VL-Segment'''

Ein VL-Segment ist ein Grid zur Darstellung und Bearbeitung eines einzelnen Datensatzes.

Das Standard-VL-Segment (VL für "value list") ist zweispaltig: Links der Namen, rechts der Wert. Es können jedoch auch weitere Spalten ergänzt werden, so dass der zur Verfügung stehende Platz in der Horizontalen besser genutzt werden kann oder dass weitere Werte in unsichtbaren Spalten gespeichert werden können.

[[file:Ssht vl seg.png|VL-Segment]]

'''Grid-Segment'''

Ein Grid-Segment dient zur Darstellung und Bearbeitung mehrerer Datensätze.

Ein Standard-Grid hat eine Kopfzeile, kann jedoch mehrere Kopf- und Fußzeilen haben.

[[file:Ssht grd seg.png|Grid-Segment]]

'''XGrid-Segment'''

Ein XGrid-Segment ähnelt einem Grid-Segment. Allerdings besteht hier die Möglichkeit, Reihen einer Tabelle als Spalten zu ergänzen.

Im nachfolgenden Bild gehören alle Spalte bis einschließlich Status zur Tabelle todo_todo, während die folgenden Spalten (und auch die Anzahl der folgenden Spalten) davon abhängt, welche Gruppen dem jeweiligen ToDo-Typ zugeordnet sind.

[[file:Ssht xgrd seg.png|XGrid-Segment]]

'''XXGrid-Segment'''

Ein XXGrid-Segment ("Double-X-Grid") ähnelt einem XGrid-Segment. Allerdings haben wir hier zwei Abfragen, die Spalten liefern.

Im nachfolgenden Bild haben wir einerseits die Kategorien für die Stichworte, und dahinter jeweils alle Reisenummern, die bei der betreffenden Reklamation bemängelt wurden. Somit kann schnell und übersichtlich angehakt werden, welches Stichwort für welche Reisenummer zutrifft.

[[file:Xxgrid 2.png|XXGrid-Segment]]

'''Button-Segment'''

In ein Button-Segment können mehrere Buttons eingefügt werden.

[[file:Ssht_btns_seg.png|Button-Segment mit zwei Buttons]]

'''Memo-Segment'''

Das Memo-Segment dient zu Anzeige und Bearbeitung von mehrzeiligem Text.

[[file:Ssht_memo_seg.png|Memo-Segment]]

'''Text-Segment'''

Mit einem Text-Segment kann mehrzeiliger Text auf der Seite angezeigt werden. (Die zugrunde liegende Delphi-Komponente ist ein Memo, so dass der Text markiert und in die Zwischenablage kopiert werden kann.)

Text-Segmente werden bisweilen auch einfach dafür eingesetzt, den Abstand zwischen anderen Segmenten zu vergrößern.

[[file:Ssht_text_seg.png|Memo-Segment]]

'''Picture-Segment'''

Zeigt ein Bild an.

==Gemeinsame Parameter aller Segmente==

Die folgenden Parameter können in allen Segmenten genutzt werden:

'''Parameter'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Wenn Y, kann der Anwender die Daten im Segment nicht ändern; default N, Funktionen werden ersetzt

'''Beispiel'''
#grd_seg frc=1 fcc=1 clt=ss mhc=300 n=test c=" " b=HAI sc=0

==Nachschlagelisten==

Bei der Auswahl von Optionen werden häufig Nachschlagelisten eingesetzt.

[[file:Lookupliste.png|172px|Nachschlageliste]]

'''Definierte Nachschlagelisten'''

Mit xlookup können Nachschlagelisten definiert werden. Diese können in xlookup auch in die definierten Sprachen übersetzt werden.

Diese werden dann mit dem Parameter ld eingebunden:

#grd_col f=status c1="Status" w=80 y=lookup ld=srv_status

'''Nachschlagelisten aus SQL-Statements'''

Nachschlagelisten können auch mittels SQL-Statement erzeugt werden. Hier gibt es zwei Möglichkeiten.

Zum Einen können diese Statements in xspecial definiert werden. Sie werden dann mit dem Parameter ls eingebunden:

#grd_col f=user_group_id c1=$T(Group) w=300 y=lookup ls=system_groups_all

Zum Anderen kann das SQL-Statement auch im Quelltext stehen. Das ist insbesondere dann hilfreich, wenn einzelne Werte noch gesetzt werden müssen. Diese Statements müssen mit dem Parameter ld eingebunden werden, dem der Name des SQL-Statements übergeben wird (Statements, die - wie hier im Beispiel - mit #sql2 definiert wurden, werden mit ld=sql2 eingebunden).

#sql2 select ctype as ckey, name as cvalue from todo_type where ctype like '$CP(0)%'
...
xgrd_col f=ctype c1=$T(type) y=lookup ld=sql2 q=y2 w=150

Beiden Möglichkeiten ist gemeinsam, dass die beiden Spalten mit ckey und cvalue benannt werden müssen. Weitere Spalten sind unschädlich, werden aber ignoriert.

'''Nachschlagelisten aus Text-ValueLists'''

Eine Text-ValueList in eine Value-Liste, die in einem Text (text, text2, text3...) aufgebaut ist nach dem Muster key=value. Die Text-ValueList wird dem Parameter ld als tvl (text), tvl2 (text2), tvl3 (text3) und so weiter zugewiesen.

#vl_line c1=Lieferant f2=vendor_id ro2=Y nd2=Y c3=" " c4=Name f5=vendor_url y5=lookup ld5=tvl2

'''LookupLive'''

Den zuvor erwähnten Möglichkeiten ist gemeinsam, dass alle Nachschlagelisten in einer Spalte stets gleich aussehen. Es können zwar unterschiedliche Werte gewählt werden, aber die Optionen in der Liste sind stets dieselben.

Manchmal benötigt man jedoch unterschiedliche Listen. Als Beispiel sei ein Grid genannt, in dem in einer Spalte eine Reise angegeben oder ausgewählt wird, und in einer anderen Spalte sollen in einer Nachschlageliste die Ausflüge gelistet werden, die zu dieser Reise buchbar sind. Und da die Reisen unterschiedliche Ausflüge haben, und auch unterschiedliche Reisen eingegeben werden können, sieht die Nachschlageliste in jeder Zeile unterschiedlich aus.

So etwas zu bewerkstelligen ist in BAF nicht weiter schwer: Es wird der Typ y=lookuplive verwendet mit mit llc (LookupLiveCommand) ein Kommando (Name oder Nummer) angegeben, das immer dann ausgeführt wird, wenn die Liste geöffnet wird (sowie beim erstmaligen Anzeigen - damit der Wert im Grid korrekt dargestellt werden kann). Mit diesem Kommando wird dann die Nachschlageliste gefüllt.

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

Hier im Beispiel wird ein lokales Kommando verwendet, das mit #cmd definiert wird. Damit das sicher leer ist, wird es zuvor mit #cmd_clear geleert. Das Kommando ist im Prinzip ein SQL-Statement sowie die Prozedur #grd_lookuplivefill, welche die Nachschlageliste füllt.

LookupLive-Nachschlagelisten wird meist unter Berücksichtigung von anderen Werten in derselben Zeile des Grids gefüllt - also muss auf diese zugegriffen werden. Dafür wird die Funktion $PVAL verwendet, welcher als dritter Parameter - nach Name des Grid und Name oder Nummer der Spalte - der Reihensonderbezeichner ''lookuplive'' mitgegeben wird, so dass immer dieselbe Zeile wie die jeweilige Nachschlageliste verwendet wird.

Hinweis: Bei neu angelegten Zeilen ist die betreffende Zelle in der Regel leer. Von daher wird üblicherweise $NVL eingesetzt, um einen Ersatzwert zu verwenden, damit zumindest das SQL-Statement syntaktisch korrekt ist und auf keine Fehlermeldung läuft. (Hinweis zum Beispiel: Es handelt sich hier um keine kurze Demonstration der Funktionalität ohne praktischen Sinn.)

=Text-, Memo- und Button-Segmente=

==#text_seg==

Legt ein Text-Segment an.

'''Parameter'''

Text-Segmente haben nur die gemeinsamen Parameter aller Segmente.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#text_line==

Fügt einem Text-Segment eine Zeile hinzu. Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile hinzugefügt.

'''Parameter'''

Die komplette Zeile nach dem Prozedurennamen und dem folgenden Leerzeichen wird als neue Zeile dem Segment hinzugefügt.

'''Beispiel'''

#text_seg c=Test
#textline Erste Zeile
#textline Zweite Zeile

==#memo_seg==

Legt ein Memo-Segment an, also ein Segment, in dem mehrzeiliger Text bearbeitet werden kann.

'''Data'''

Mit q=data werden die Texte in der Tabelle data_memo gespiechert. Diese Tabelle ist dafür vorgesehen, mal schnell ein Bemerkungsfeld zu beliebigen Daten hinzuzufügen, ohne die jeweilige Datenbak-Tabelle erweitern zu müssen.

Der Datensatz in data_memo wird mit den Spalten item und ref referenziert. Item wird über den Parameter i gesetzt und ist zwingend. Für ref wird der Parameter k verwendet, der üblicherweise auf die ID-Spalte der Daten gesetzt wird, mit denen das Memo-Feld verbunden werden soll. Bleibt k leer, so wird none als Konstante eingefügt.

'''File'''

Mehrzeiliger Text kann auch einfach in einer Datei auf der Festplatte gespeichert werden. Dazu wird q=file und fn auf den gewünschten Dateinamen gesetzt. Möchte man für unterschiedliche Datensätze unterschiedliche Texte und damit unterschiedliche Dateinamen, so holt man einfach die ID oder eine andere eindeutige Spalte mit in den Dateinamen.

'''Link'''

Zellen in VL- und Grid-Segmente können problemlos mehrzeiligen Text speichern, sie können ihn aber nicht brauchbar anzeigen und bearbeiten. Mit q=link lässt sich ein Memo-Segment an ein VL- oder Grid-Segment hängen, so dass mehrzeiliger Text dort im Memo-Segment angezeigt und bearbeitet wird. Der Parameter i referenziert auf das VL- oder Grid-Segment, mit f wird die Datenbankspalte angegeben. Mit w=0 wird üblicherweise die entsprechende Spalte im VL- oder Grid-Segment ausgeblendet.

In einem Grid-Segment wird der Feldinhalt der gerade aktuellen Zeile angezeigt. Bei einem Zeilenwechsel ändert sich dann auch der Inhalt der Memo-Segments.

Datenänderungen werden über das VL- oder Grid-Segment gespeichert.

'''Parameter'''

* f ("field") - bei q=link der Feldname im verbundenen Segment
* fn ("file name") - Dateiname, wird für q=file verwendet; Funktionen werden ersetzt
* k ("key") - Wert für die Spalte ref in data_memo
* i ("item") - bei q=link Name des Segments, bei q=data der Item-Name; bei letzterem werden Funktionen ersetzt
* q ("Quelle") - Herkunft der Daten
** data - Daten werden in der Tabelle data_memo gespeichert; benötigt die Parameter i und meist auch k
** file - Daten werden in einer Datei gespeichert; benötigt den Parameter fn
** link - Daten werden in einem anderen Segment gespeichert; benötigt die Parameter i und vl
** none - Lädt und speichert keine Daten; der eingegebene Text kann mit $PVAL ermittelt oder mit #page_val gesetzt werden
* ww ("WordWrap") - Wenn Y, werden zu lange Zeilen automatisch umgebrochen; default Y, Funktionen werden ersetzt
* z - Text des Memo-Segments; Wird von den Daten in q gegebenenfalls überschrieben

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

Zusätzlich gibt es die Parameter aller Segmente.

'''Beispiele'''

#memo_seg q=link i=vl f=code c="Code" b=H
#memo_seg q=file fn=i:\temp\test.txt c=$T(Notes)
#memo_seg q=data i=memo_reise k=$PVAL(vl,reise_id) c=" " b=H

==#btns_seg==

Legt ein Button-Segment an.

'''Parameter'''

Button-Segmente haben nur die gemeinsamen Parameter aller Segmente. Meist werden überhaupt keine Parameter benötigt.

'''Beispiel'''

#btns_seg

==#btns_btn==

Legt einen Button in einem Button-Segment an.

'''Parameter'''

* c ("caption") - Beschriftung des Buttons; Funktionen werden ersetzt
* cmd ("command") -Kommando, das ausgeführt wird, wenn auf den Button geklickt wird (und ggf. die Bestätigungsabfrage mit Ja beantwortet wurde); Funktionen werden ersetzt (zum Zeitpunkt des Buttons-klicks)
* cnf ("confirmation") - Beim Mausklick auf den Button wird zunächst ein Bestätigungs-Dialog mit dem im Parameter cnf angegebenen Text angezeigt. Nur wenn dieser Bestätigungs-Dialog mit Ja geschlossen wird, wird cmd ausgeführt. Funktionen werden bei Anzeige des Bestätigungs-Dialogs ersetzt. Ist cnf leer, unterbleibt die Anzeige.
* h ("hint") - Hinweistext
* r ("rights") - Rechte-Definition des Buttons; zum Ausführen des Buttons werden Schreibrechte benötigt; default sind die Rechte des Formulars
* se ("status enabled") - Je nach Status des Formulars ist der Button enabled oder nicht (es können mehrere Status-Buchstaben in beliebiger Reihenfolge kombiniert werden); Funktionen werden ersetzt
** b ("browse") - Normalzustand des Formulars
** c ("changed") - Nachdem Daten geändert wurden
** e ("editing") - Während einer Editierung
** f ("failed") - Die Plausibilitätsprüfung wurde nicht bestanden
* ro ("read only") - Mit Y wird die Ausführung des Buttons gesperrt; Funktionen werden ersetzt
* w ("width") - Breite des Buttons

'''Beispiel'''

#btns_seg
#btns_btn c=$T(Test_special) w=150 cmd="#pagefill d=xspecial_page_list(test)"

=VL-Segmente=

VL-Segmente ("Value List") sind Gitter-Segmente zur Anzeige eines einzelnen Datensatzes.

Im Standard-Fall sind VL-Segmente zweispaltig: Auf der linken Seite wird die Beschriftung angezeigt, auf der rechten Seite der jeweilige Wert des Datensatzes.

VL-Segmente können aber auch mehr als zwei Spalten haben. Das können unsichtbare Spalten sein, um Daten für z.B. ein Memo-Segment zu beinhalten, das können aber auch sichtbare Spalten sein, um den Platz auf dem Bildschirm besser auszunutzen.

==#vl_seg==

Mit der Prozedur #vl_seg wird ein VL-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=200 n=vl c=" " b=H

==#vl_line==

Legt eine Zeile in einem VL-Segment an

'''Parameter'''

Die Parameter in #vl_line haben als Postfix die Nummer die Spalte, auf die sie sich beziehen.

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* arp1, arp2... (additional right pixels) - Anzahl der Pixel, um welche der Text bei Rechtsausrichtung nac links gerückt wird; default 0, Funktionen werden ersetzt.
* c1, c2... ("caption") - Beschriftung der Spalte; Wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc1, ccc2 ("cell color command") - Kommando, das die Zellenfarbe ermittelt
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cs1, cs2... ("col span") - Werte größer 1 fügen Zellen zusammen; default 1
* cy1, cy2... ("char type")
** l - LowerCase
** n - Normal
** u - UpperCase
* f1, f2... ("field") - Feldname in der Datenbank
* h1, h2... ("hint") - Feldname in der Datenbank für den Hinweistext, ersatzweise der Hinweistext selbst
* ld1, ld2... ("lookup data") - Name der Lookup-Liste, wenn der Datentyp lookup; Alternativ sql1, sql2..., um die Daten aus einem SQL-Statement zu ziehen
* ls1, ls2... ("lookup special") - Alternativ zu ld: Name des Specials, wenn die Daten aus einem Special gezogen werden sollen
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* nv1, nv2... ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc1, nvc2... ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi1, nvi2... ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic1, nvic2... ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* rof1, rof2... ("read only field") - Feldname der Spalte, aus dem die Read-Only-Funktion bezogen wird; Funktionen werden ersetzt
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiele'''

#vl_line c1="Name" f2=name
#vl_line c1="Type" f2=type ro=Y y2=lookup ld2=user_group_type nv2=$FND(s,type)
#vl_line c1="Data Special Id" f2=data_special_id ro2=Y nvic2=$GUID() f3=code

'''Beispiel für chg'''

#cmdclear
#cmd #page_val i=vl col=1 row=4 z=$HASH($PVAL(vl,1,2),SHA512)
...
vl_line c1=$T(new_password) nd2=Y chg2=1 pw2=Y

'''Beispiel für Datenquelle'''

Im Normalfall ist mit einem VL-Segment immer nur eine Tabelle verbunden. Mit Hilfe eines Joins können zwar Daten aus mehreren Tabellen angezeigt werden, aber üblicherweisen werden die Daten nur in eine Tabelle zurück geschrieben, die anderen Zellen sind mit nd=Y gekennzeichnet.

Sollen Daten jedoch in mehrere Tabellen zurückgeschrieben werden, dann ist das Vorgehen das Folgende:

* Die weiteren Tabellen benötigen eine Schlüsselspalte, welche denselben Inhalt wie die primäre Tabelle hat. Gegebenenfalls muss diese Spalte ergänzt werden. Bei der Benennung dieser Spalte gibt es zwei Möglichkeiten:
** Die Spalte heißt genau so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_test2 die ID test_test2_id, und die angehängte Tabelle test_test2_add hat auch die ID test_test2_id - und nicht test_test2_add_id).
** Die Spalte heißt nicht so wie die Schlüsselspalte in der primären Tabelle (hier im Beispiel hat die Tabelle test_add3 die Schlüsselspalte test_add3_id); die bei BAF "übliche" Benennung mit einem angehängten _id wie hier bei test_add3 ist zu bevorzugen.
* Es wird ein SQL-Statement erstellt, um diese Tabellen zusammenzufügen. Die angehängten Tabellen werden mit einem left outer join verbunden. Dort, wo die ID-Spalten der angehängten Tabellen gleich wie in der primären Tabelle heißen (im Beispiel test_test2_id), werden sie umbenannt (im Beispiel yid).
* In #vl_data werden die weiteren Tabellen als t2, t3... aufgezählt; hier im Beispiel t2=test_tes2_add und t3=test_add3. Wo sich der Name der Schlüsselspalte nicht auf dem Tabellennamen ableiten lässt, sind auch die Schlüsselspalten entsprechend anzugeben als k2, k3...; hier im Beispiel k2=yid
* Die Schlüsselspalten der ergänzten Tabellen sind im VL-Segment zu speichern. Üblicherweise wird dafür eine ausgeblendete Spalte verwendet.
* Bei jeder Zelle, die in einer der angehängten Tabellen gespeichert werden soll, ist mit dem Parameter q anzugeben, welches die angehängte Tabelle ist. y2 ist t2, y3 ist t3... (hier im Beispiel q2, weil die Daten in der zweiten Spalte der VL-Segments stehen).
* Dort, wo Schlüsselspalten gleich heißen wie in der primären Tabelle und deswegen im SQL-Statement umbenannt werden müssen (hier im Beispiel yid statt test_test2_id), muss der Spaltenname in der Tabelle mit yf angegeben werden, damit die Daten korrekt zurück geschrieben werden (hier im Beispiel yf3=test_test2_id - die Ziffer 3 bei yf3 bezieht sich auf die (unsichtbare) Spalte im VL-Segment, nicht auf die Nummer der Tabelle)
* Es ist sicherzustellen, dass alle beteiligten Tabellen dieselben Schlüsselwerte bekommen. Zu diesem Zweck wird im Beispiel die ID der primären Tabelle in den Value 1 geschrieben, ersatzweise wird eine neue GUID verwendet. Dieser Value wird dann mittels nvi in alle Schlüsselfelder geschrieben.

#setval n=1 z=$FND(s,test_test2_id) ie=$GUID()

#vl_seg cc=3 clt=ss w1=100 w2=200 wst2=200 w3=0 n=vl c=" " b=H
#vl_line c1="ID" f2=test_test2_id ro2=Y nvic2=$VAL(1) f3=yid yf3=test_test2_id q3=y2 nvi3=$VAL(1)
#vl_line c1="Zahl" f2=zahl f3=test_add3_id q3=y3 nvi3=$VAL(1)
#vl_line c1="Text" f2=text
#vl_line c1="Todo" f2=boolsch y2=todo
#vl_line c1="Add 1" f2=add_1 q2=y2
#vl_line c1="Add 2" f2=add_2 q2=y2
#vl_line c1="Add 3" f2=add_3 q2=y2
#vl_line c1="Add 31" f2=add31 q2=y3
#sql select t.test_test2_id, t.zahl, t.text, t.boolsch, a.test_test2_id as yid, a.add_1, a.add_2, a.add_3, b.test_add3_id, b.add31
#sql from test_test2 t
#sql left outer join test_test2_add a on a.test_test2_id = t.test_test2_id
#sql left outer join test_add3 b on b.test_add3_id = t.test_test2_id
#sql where t.test_test2_id = :kid
#vl_data q=sql t=test_test2 t2=test_test2_add k2=yid t3=test_add3 kid=$FND(s,test_test2_id)

==#vl_data==

Füllt ein VL-Segment mit Daten

'''Parameter'''
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* k ("key") - Als Prefix für alle SQL-Parameter; siehe Beispiel; Funktionen werden ersetzt
* kid ("key id") - bei q=t der Wert der Schlüsselspalte, damit der Datensatz lokalisiert werden kann
* q ("Quelle") - Datenherkunft
** sql - SQL-Statement
** t - Table
* t ("table") - Name der Tabelle; obligatorisch bei q=t und wenn bei q=sql die Daten zurückgeschrieben werden sollen; Funktionen werden ersetzt
* t2, t3... ("table") weitere Tabellen, in die Daten gespeichert werden sollen; siehe ''Beispiel für Datenquelle'' in #vl_line

'''Beispiele'''

#vl_data q=t t=data_list kid=$FND(s,data_list_id)

#sql select * from menu_category where menu_category_id = :k_menu_category_id
#vl_data q=sql t=menu_category k_menu_category_id=$FND(s,menu_category_id)

#sql select * from menu_category where menu_category_id = :kid
#vl_data q=sql t=menu_category kid=$FND(s,menu_category_id)

==#vl_hist==

Definiert die Rechte für ein Feld in der History-Ansicht. Funktioniert auch mit #grd_seg, #xgrs_seg und #xxgrd_seg

'''Parameter'''
* f ("field") - Name der Spalte in der Tabelle
* r ("rights") - Name der Rechtedefinition für diese Spalte

'''Beispiel'''

#vl_line c1=$T(Description) f2=description l2=80 r=admin
#vl_hist f=description r=admin

In diesem Beispiel wird durch r=admin in #vl_line dafür gesorgt, dass nur Administratoren die Beschreibung im VL-Segment sehen. Mit der Anweisung #vl_hist wird sichergestellt, dass andere als Administratoren den Spalteninhalt auch nicht über die Historie einsehen können.

==#vl_thread==

Ergänzt Daten mittels eines Thread. Wird üblicherweise dazu verwendet, Daten aus anderen Datenbanken zu ergänzen.

'''Parameter'''

* chg ("change") - Wenn Y, werden Zellen, die durch den Thread gefüllt werden, als geändert gekennzeichnet; default N, Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* i ("item") - Name des VL-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im VL-Segment muss es eine Spalte mit diesem Feldnamen geben.

'''Beispiel'''

#sql select bezeichnung from rsd where aktion = $PVAL(vl,aktion)
#vl_thread db=ora_prod i=vl

=Grid-Segmente=

Grid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer Datenbanktabelle oder einer SQL-Abfrage angezeigt werden. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#grd_seg==

Mit der Prozedur #grd_seg wird ein Grid-Segment angelegt.

'''Parameter'''

* acmd (add command) - Kommando, das ausgeführt wird, wenn auf den Button + geklickt wird.
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
** A ("active") setzt in der mit sc spezifizierten Spalten alle Zellen auf Y; ist das Grid gefiltert, werden nur die gefilterten Zellen gesetzt.
** F ("filter") öffnet den Filter-Dialog
** H ("history") öffnet den History-Dialog
** I ("inactive") setzt in der mit sc spezifizierten Spalten alle Zellen auf N; es werden immer alle Zellen auf N gesetzt, auch wenn sie ausgefiltert sind
** X ("xlsx") exportiert das Grid im xlsx-Format
** Y exportiert das Grid im pdf-Format
** + führt acmd aus (nur #grd_seg); wird üblicherweise dazu verwendet, einen Datensatz hinzuzufügen
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#grd_seg frc=0 fcc=1 clt=ss mhc=300 n=item

==#grd_col==

Mit der Prozedur #grd_col wird eine Spalte in einem Grid-Segment definiert.

'''Parameter'''
* a (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* a1, a2... (align) - [Header] Ausrichtung des Textes des Headers der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* arp (additopnal right pixels) - Anzahl der Pixel, welcher der Text bei Rechtsausrichtung weiter nach links gerückt wird; Default 0, Funktionen werden ersetzt
* c (caption) - Spalten-Titel im Filter-Formular; Funktionen werden ersetzt. Bleibt dieser Parameter leer, so wird ersatzweise c1 verwendet.
* c1, c2... (caption) - [Header] Spalten-Titel der ersten, zweiten... Zeile; Funktionen werden ersetzt.
* ccc (CellColorCommand) - Kommando, das die Farbe der Zelle setzt.
* ci (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* chg (change) - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird.
* cmd (command) - Kommando, zum Beispiel für Verlinkung oder die Formatierung; Funktionen werden sofort ersetzt.
** no_crlf - Zeilenumbüche werden durch Leerzeichen ersetzt
** conv_yyyy - Datum im Format yyyymmddhhmmss wird nach dd.mm.yyyy hh:mm:ss und yyyymmdd nach dd.mm.yyyy konvertiert
* cmdn (command no) - Kommando, zum Beispiel für Verlinkung; Funkionen werden erst bei Ausführung des Kommandos ersetzt; wird nur berücksichtigt, wenn cmd leer ist.
* cs1, cs2... (ColSpan) - [Header] Die Zelle des Spaltentitels der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* cy (character type) - Groß- und Kleinschreibung; default ist n
** l (lower case) - Spalte wird in Kleinbuchstaben dargestellt
** n (normal) - Groß- und Kleinschreibung wie eingegeben
** u (upper case) - Spalte wird in Großbuchstaben dargestellt
* f (fieldname) - Feldname der Spalte in der Datenmenge; Funktionen werden ersetzt.
* f1, f2... (fieldname) - [Header] Feldname des Spaltentitels der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter c1, c2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus c1, c2... vorangestellt wird.
* fa1, fa2... (footer align) - [Footer] Ausrichtung des Textes der Fußzeile der Spalte der ersten, zweiten... Zeile. Zulässige Werte siehe Parameter a.
* fc1, fc2... (footer caption) - [Footer] Spalten-Fußzeile der ersten, zweiten... Zeile. Ist im Text ein $-Zeichen enthalten, dann wird der Text als Zellen-Kommando interpretiert.
* fcs1, fcs2... (footer ColSpan) - [Footer] Die Zelle der Fußzeile der ersten, zweiten... Zeile überspannt die angegebene Anzahl an Spalten. Default ist 1; Funktionen werden ersetzt.
* ff1, ff2... (footer fieldname) - [Footer] Feldname des Fußzeile der ersten, zweiten... Zeile; Funktionen werden ersetzt. Sind auch die Parameter fc1, fc2... gesetzt, dann werden die Texte zusammengefügt, wobei der Text aus fc1, fc2... vorangestellt wird.
* fh1, fh2... (footer hint) - [Footer] Feldname des Hint-Textes der Spalte der ersten, zweiten... Fußeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* fy1, fy2... (footer Typ) - [Footer] Datentyp des Datentyps der ersten, zweiten... Fußzeile; default ist text. Zulässige Werte siehe y.
* h (hint) - Feldname des Hint-Textes in der Datenmenge; Funktionen werden ersetzt.
* h1, h2... (hint) - [Header] Feldname des Hint-Textes der Spalte der ersten, zweiten... Zeile; Funktionen werden ersetzt. Gibt es in der Datenmenge keine Spalte dieses Namens, dann wird der Wert als Konstante ausgegeben.
* jy (join type) - Im Standardfall werden bei Join-Gruppierung die Daten durch Kommata getrennt dargestellt. Sie können jedoch auch summiert werden, dafür ist jy=sum zu setzen.
* l (length) - Maximale Länge in Zeichen bei der Eingabe
* ld (LookupData) - Name der Nachschlageliste beim Spaltentyp y=lookup
* llc (LookupLiveCommand) - Name oder Nummer des Kommandos, das beim Spaltentyp y=lookuplive verwendet wird; ls und ls dürfen nicht gesetzt werden
* ls (LookupSpecial) - Name des Specials (hinterlegte SQL-Anweisung in xspecial), wird nur berücksichtigt, wenn ld nicht gesetzt ist
* nd (no data) - Spalte wird beim Speichern nicht berücksichtigt; Änderungen versetzen das Grid auch nicht in den Zustand changed.
* nv ("no value") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist
* nvc ("no value change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Changed-Modus gesetzt
* nvi ("no value insert") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment auch in den Insert-Modus gesetzt
* nvic ("no value insert change") - Wert, der eingefügt wird, wenn das Feld in der Datenmenge leer ist; dann wird das Segment in den Insert- und Changed-Modus gesetzt
* q (quelle) - Datenquelle für das Grid.
** j, join - Daten aus einem Datenbank-Join werden gruppiert dargestellt
** s, sql - SQL-Statement
** t, tbl, tab, table - Datenbanktabelle
* r (right) - Rechtedefinition der Spalte. Sofern nur ein Leserecht vorliegt, wird die Spalte ReadOnly. Sofern kein Recht vorliegt, wird die Spalte ausgeblendet und auch nicht in der Historie angezeigt.
* ro (ReadOnly) - Wenn Y, dann kann die Spalte nicht beschrieben werden.
* rof (ReadOnlyField) - Wenn der Inhalte der angegebenen Datenbankspalte Y ist, dann kann die betreffende Zelle nicht beschrieben werden.
* ss1, ss2... (SortSymbols) - [Header] Mit Mausklick auf den Spaltentitel kann nach dieser Spalte sortiert werden, mit einem weiteren Mausklick die Sortierrichtung umgekehrt werden. Es werden dabei entsprechend Symbole rechts im Spaltentitel angezeigt. Um eine Sortierung zu verhinden, kann ss1, ss2... auf N gesetzt werden. Funktionen werden ersetzt.
* w (width) - Breite der Spalte in Pixel; Funktionen werden ersetzt.
* wst (width stretch) - Anzahl von Pixel, welche die Spalte maximal verbreitert wird, wenn Platz dafür da ist. Voraussetzung dafür ist, dass der Parameter clt von #grd_seg den Wert ss oder ms hat. Funktionen werden ersetzt.
* y (typ) - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* xop (xlsx options) - unsortierte Reihenfolge von Optionen für den Excel-Export
** n (null) - Ist der Inhalt eines Zahlenfeldes leer, dann wird nicht 0 bzw. 0,00 exportiert, sondern das Feld bleibt auch im xlsx-Export leer
* xw (xlsx width) - Spaltenbreite, wenn das Segment im Excel-Format exportiert wird; wenn leer, wird statt dessen w verwendet; Funktionen werden ersetzt
* yf (Y fieldname) - Feldname der Spalte in einer zusätzlichen Datenmenge; Funktionen werden ersetzt.

'''Beispiele'''

#grd_col f=translate_list_item_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=user_group_id c1=$T(group) y=lookup ls=system_groups_all w=200 wst=200
#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

==#grd_data==

Füllt das Grid mit Daten aus der Dankenbank.

'''Parameter'''

* c ("Caption") - Beschriftung des Segments, wenn der Thread ausgeführt wurde; nur für thread und xmlthread; Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* gc (grid cache) - Erhält dieser Paremeter einen Wert, dann wird das SQL-Statement nur beim erstmaligen Aufruf von #grd_data ausgeführt. Die Daten werden dann in einem Cache gespeichert, so dass erneute Aufrufe weniger lange dauern. Der Inhalt das Parameters wird als Name für die Seite im Cache verwendet und muss eindeutig sein - im Zweifelsfall verwendet man eine GUID. Hinweise: Wenn weitere Spalten der Abfrage und dem Grid hinzugefügt werden, bleiben diese erste mal leer. Auch Veränderungen der Daten durch andere User bleiben erst mal unsichtbar. Ein erneuter Start der BAF-Clients führt zu einem leeren Cache und somit zur erneuten Ausführung des SQL-Statements.
* ior (insert one row) - Wenn Y, wird eine (leere) Zeile eingefügt, wenn die Datenmenge leer ist; default N; Funktionen werden ersetzt
* jk (join key) - Feldname der Spalte, nach der bei q=j gruppiert wird
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* mk ("merge key") - Die Spalte, die das Entscheidungskriterium bei q=merge beinhaltet.
* n ("number") - Nummer des Textes, aus dem die Daten bei q=text bezogen werden; default 1, Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* q (quelle) - Herkunft der Daten
** j - Join
** json - Das Grid wird mit einem geparsten JSON gefüllt
** sql - SQL-Statement
** sqladd / add - SQL-Statement, fügt Daten zu einem Grid hinzu; somit können die Daten aus zwei unterschiedlichen SQL-Statements kommen, die ggf. auch auf unterschiedlichen Datenbanken ausgeführt werden können
** sqlmerge / merge - SQL-Statement, fügt wie ''sqladd'' Daten zu einem Grid hinzu, hier aber unter Berücksichtigung der im Parameter mk spezifizierten Spalte: Ein Datensatz wird nur dann hinzugefügt, wenn es noch keine Zeile mit dem entsprechenden Wert gibt.
** t - Table
** text - die Daten werden aus dem mit dem Parameter n spezifizierten Text bezogen. Mögliche Werte für den Parameter f sind ''text'' (ganze Zeile), ''key'' (vor dem Gleichheitszeichen) und ''value'' (nach dem Gleichheitszeichen)
** thread - ein SQL-Statement wird in einem Hintergrund-Thread ausgeführt
** xml - Das Grid wird mit einem geparsten XML gefüllt
** xmlthread - In einem Hintergrundthread wird mit http(s) ein XML geholt, dieses geparst und damit das Grid gefüllt.
* sc (SaveCommand) - Kommando das ausgeführt wird, wenn das Grid gespeichert werden soll; nur für xml und xmlthread
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiele'''

#grddata q=sql t=translate_list_item kid=$FND(s,data_list_item_id)

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#http_request y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap

#text_clear
#text <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.xxxxxxxxxxxxxxxxxx.de/">
#text <soapenv:Header/>
#text <soapenv:Body>
#text <web:searchCustomer>
#text <searchCustomerRequest>
#text <postalCode>31582</postalCode>
#text </searchCustomerRequest>
#text </web:searchCustomer>
#text </soapenv:Body>
#text </soapenv:Envelope>
#code url=https://xxxxxxxxxxxxxxxxxx.de/ITAPIWebservice/xxxxxxxxxxInterface?doAgencyLogin
#code e_res=ansi
#code y=post cy="application/xml" request=$TEXT(1) response=resp se=Y acc=application/xml
#grd_data q=xmlthread pfx=customer path=soap:Envelope.soap:Body.ns2:searchCustomerResponse.searchCustomerResponse sc=xbaftest_save_soap $CODE$

'''Beispiel Daten aus XML-Array'''

Die Abfrage im folgenden Beispiel gibt ein XML nach dem folgenden Muster zurück:

<contacts>
<contact>
<email>michael.mustermann@gmail.com</email>
<created>2024-06-14 14:02:48.0</created>
<updated>2024-06-22 14:05:00.0</updated>
<id>123456</id>
<external_id>990000018</external_id>
<permission>5</permission>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Michael</value>
</field>
<field>
<name>LASTNAME</name>
<value>Mustermann</value>
</field>
<field>
<name>SALUTATION</name>
<value>Herr</value>
</field>
</standard_fields>
<custom_fields/>
</contact>
</contacts>

Anrede sowie Vor- und Nachname sind hier in den Standard-Feldern und können nicht direkt adressiert werden. Hier lautet dann die Syntax für den Spaltenbezeichner wie folgt:

f=standard_fields.field[name=SALUTATION].value

#prim as=Y
#cat as=Y c="Alle Maileon-Einträge der Kundennummer $FND(s,customernumber)"

#btns_seg
#btns_btn c="Gewählte Maileon-Einträge unsubscriben" w=350 cmd=xkudat_act(adrnr)

#grd_seg clt=ss hrc=1 n=adrnr sc=0
#grd_col c1=Sel w=30 y=bool nd=Y
#grd_col c1=ID f=id w=80 ro=Y q=xml
#grd_col c1="E-Mail" f=email w=200 wst=200 ro=Y q=xml
#grd_col c1="Adrnr" f=external_id w=80 ro=Y q=xml
#grd_col c1="Anrede" f=standard_fields.field[name=SALUTATION].value w=100 ro=Y q=xml
#grd_col c1="Vorname" f=standard_fields.field[name=FIRSTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1="Nachname" f=standard_fields.field[name=LASTNAME].value w=150 wst=100 ro=Y q=xml
#grd_col c1=E h1="Zusendung von E-Mails erlaubt" f=<permission> w=30 y=bool ro=Y

#code url=https://api.maileon.com/1.0/contacts/externalid/$FND(s,customernumber)?standard_field=FIRSTNAME&standard_field=LASTNAME&standard_field=SALUTATION
#code f_Authorization="Basic (je nach dem...)"
#code e_res=utf8
#http_request y=get cy="application/vnd.maileon.api+xml; charset=utf-8" response=resp se=N $CODE$
#xml_parse xml=$VAR(resp)
#grd_data q=xml pfx=contact path=contacts

==#grd_add==

Fügt einem Grid-Segment eine weitere Reihe hinzu.

Hinweis: Die Primärschlüsselspalte wird üblicherweise nicht in der Prozedur #grd_add gesetzt, sondern mit dem Parameter nvi in der Prozedur #grd_col.

'''Parameter'''

* chg ("change") - Wenn Y, wird die neue Reihe gleich in den Changed-Modus gesetzt; default N; Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen
* i ("item") - Name des Grid-Segments
* sc ("selected column") - Index oder Feldname der Spalte, deren Zelle im Anschluss an die Einfügeoperation selektiert werden soll. Wenn leer, wird die Selektierung nicht verändern. Funktionen werden ersetzt, default leer.
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#grd_add i=todo_add f_ref=$VAR(todo_id) f_ref_text=$VAR(todo_text) f_ref_hint=$VAR(todo_hint) f_status=1

==#grd_loop==

Die Prozedur #grd_loop führt eine Schleife über alle oder alle selektierten Reihen eines Grid-Segments durch.

'''Parameter'''

* er (each row) - Kommando, das für jede oder jede selektierte Zeile des Grids ausgeführt wird; Funktionen werden ersetzt.
* ert (each row transaction) - Wenn Y, dann wird jeder Aufruf des mit er festgelegten Kommandos in einer Transaktion gekapselt
* i (item) - Name des Grid-Segments
* nkomma - In eine Variable dieses Namens wird bei jedem Schleifendurchlauf mit Ausnahme des letzten Schleifendurchlaufs ein Komma geschrieben; default leer, Funktionen werden ersetzt. Wird üblicherweise dazu verwendet, um aus einem Grid eine Liste zu machen, bei der die einzelnen Elemente durch ein Komma getrennt sind, aber kein Komma hinter dem letzten Element stehen soll. Werden andere Trennzeichen benötigt, lässt sich diese mit $VT() bewerkstelligen.
* sc (selection column) - Index der Selection-Column; Wenn damit eine Spalte angegeben wird, dann wird das mit er festgelegte Kommando nur ausgeführt, wenn der Werte dieser Spalte in der betreffenden Reihe Y ist; default ist -1; Funktionen werden ersetzt.

'''Beispiel'''

#grd_loop i=grid er=1 sc=0

==#grd_calc==

Zählt die Zeilen in einem Grid oder berechnet eine Funktion. Es kann dabei eine Bedingung formuliert werden, welche Datensätze gezählt werden sollen.

Diese Prozedur kann auch dazu verwendet werden, um zu ermitteln, ob eine bestimmte Zeile schon im Grid vorhanden ist oder nicht. Davon lässt sich dann zum Beispiel abhängig machen, ob Daten in das Grid eingefügt werden sollen oder nicht.

'''Parameter'''

* ccnd ("CalcCondition") - Wenn Y, dann wird die Zeile berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* col - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet. Wird beim Typ cnt nicht benötigt.
* f ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist. Wird beim Typ cnt nicht benötigt.
* i ("item") - Name des Grid- oder XGrid-Segments
* n (name / number) - Name der Variable oder Nummer des Values, in die/den das Ergebnis geschrieben wird.
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N. Wird gerne in Kombination mit page_check verwendet, um zu prüfen, ob alle geänderten Zeilen den formulierten Anforderungen genügen. Siehe Beispiel.
* ry ("result type") - Ergebnistyp; default ist int, Funktionen werden ersetzt.
** curr - zwei Nachkommastellen
** curr4 - vier Nachkommastellen
** int - keine Nachkommastelle
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur gezählt, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet.
* y - Typ der Operation. Funktionen werden ersetzt, default ist cnt
** avg - Durchschnitt
** cnt - Anzahl
** min - Minimum
** max - Maximum
** sum - Summe

'''Beispiele'''

#grd_calc i=item n=1 ccnd="$BOOL($PVAL(item,key,cntrow) > 5)"

In Kombination mit #page_check

#page_check y=e chk="$EXEC(xm_konfiguration_check(partner_g))" c="Codes, die mit G beginnen, müssen der Channel Group 'Partner' zugeordnet werden."

-- in xm_konfiguration_check
~ $ICP(0,partner_g)
#grd_calc n=1 i=grid ocr=Y ccnd="$BOOL($COPY($PVAL(grid,code,calcrow),1,1) = G and $PVAL(grid,channel_group,calcrow) <> P)"
#var_set n=result z="$BOOL($VAL(1) = 0)"

~~

==#grd_lookuplivefill==

Füllt aus einem SQL-Statement eine LookupLive-Nachschlageliste

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Name der Variablen oder Nummer des Values, in die/den die Anzahl der erzeugten Zeilen geschrieben wird
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k ("key") - Wert für die Kategorie, Funktionen werden ersetzt. Nur bei y=kat
* n ("number") - Nummer der Kategorie-Valueliste; default 1, Funktionen werden ersetzt
* y - Type. Default sql, Funktionen werden ersetzt
** kat - die Werte kommen aus einer Kategorie-Valueliste.
** sql - die Werte kommen aus einem SQL-Statement

'''Beispiel'''

#cmd_clear
#cmd #sql select ckey, cvalue from data_list_item
#cmd #sql where data_list_id = '21DE9AF0-0C30-4222-A131-B855FAA85DEB'
#cmd #sql and (ckey = 1 or ckey <= $NVL($PVAL(grid,nummer,lookuplive),0)) order by csort
#cmd #grd_lookuplivefill

#grd_col f=lookup c1="Lookup" y=lookuplive llc=1

'''Beispiel für Kategorie-Valueliste'''

#sql select t.tournr as ckat, s.bus_haltestelle_id as ckey, s.land || ' ' || s.plz || ' ' || s.ort || ' - ' || s.beschreibung as cvalue, h.position
#sql from bus_touren t
#sql inner join bus_tour_hs h on h.bus_touren_id = t.bus_touren_id and h.status < 7 and (h.position < 99 or t.tournr between 30000 and 40000)
#sql inner join bus_haltestelle s on s.bus_haltestelle_id = h.haltestelle and s.status = 1 and s.land <>
#sql where t.kuerzel = '$FND(s,kuerzel)' and t.datum = to_date('$FND(s,datum)', 'dd.mm.yyyy')
#sql order by 1, 4
#sql_openkvl n=1

Für die Nachschlageliste wird dann wie folgt formuliert:

#grd_lookuplivefill y=kat n=1 k=$PVAL(pl,tournr,lookuplive)

==#grd_paste==

Fügt Daten aus der Zwischenablage in ein Grid-Segment ein.

'''Parameter'''

* add - Wenn Y, werden die über die Zwischenablage zugewiesenen Zeilen hinzugefügt, andernfalls ersetzt; Funktionen werden ersetzt, default N;
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f_ ("field") - Prefix für Spalten, denen im Anschluss ein Wert zugewiesen wird; beginnt der Wert mit ''row'' (zum Beispiel f_cvalue=row1), dann wird die folgende Zahl als 0-relativer Spaltenindex in den eingefügten Daten interpretiert, andernfalls wird der zugewiesene Wert direkt eingefügt, wobei Funktionen ersetzt werden.
* fr ("first row") - Als erste Zeile muss der angegebene String gepastet werden, sonst wird die Verarbeitung abgebrochen; wenn fr nicht gesetzt ist, wird die erste Zeile nicht geprüft und statt dessen wir eine normale Datenzeile behandelt;Funktionen werden ersetzt, default leer.
* frow - Index der Spalte in den eingefügten Daten, der in der Grid-Spalte fxrow gesucht wird. Wird nur bei y=r verwendet.
* frowpre, frowpost - Prefix und Postfix für frow, nur bei y=r. Wenn der mittels frow ermittelte Indexwert mit dem durch fxrow spezifizierten Wert im Grid verglichen wird, dann wird vor diesen Wert frowpre und nach diesem Wert frowpost eingefügt.
* fxrow - Feldname (f) der Spalte, mit deren Hilfe jeweilige Reihe identifiziert werden soll. Bei y=r muss dieser Parameter gesetzt werden.
* hhr ("has header row") - Wenn Y, dann wird die erste Zeile (die Zeile mit den Spaltenüberschriften) nicht eingelesen; default N, Funktionen werden ersetzt.
* ige ("ignore empty") - Wenn Y, werden leere Zeilen ignoriert; default N, Funktionen werden ersetzt.
* lat ("lookup as text") - Wenn Y, dann werden für Lookup-Spalten nicht die Schlüssel, sondern die Werte gepastet, der Import ermittelt daraus dann die Schlüssel; default N, Funktionen werden ersetzt.
* sep ("separator") - Trennzeichen, mit denen innerhalb einer Zeile die Spalten getrennt werden; Funktionen werden ersetzt, default ist ein Tab-Zeichen
* trim - Wenn Y, werden vor dem Einfügen alle Werte getrimmt, es werden also insbesondere führende oder anhängende Leerzeichen entfernt; default N, Funktionen werden ersetzt.
* y - Typ
** c ("column") - Die Spalten werden entsprechend der Definition zugeordnet
** d ("direct") - Spalten und Reihen werden so eingefügt, wie sie in der Zwischenablage sind; Link- und Button-Spalten werden ignoriert. Mit f_fieldname=wert definierte Werte werden anschließend den entsprechenden Spalten zugewiesen.
** r ("row") - Mittels fxrom und frow wird die Reihe im Grid-Segment ermittelt, welcher die Werte aus der aktuellen Zeile zugewiesen werden sollen. Sofern eine solche Reihe nicht gefunden wird und(!) add=Y ist, wird die Reihe neu angelegt und dann mit Werten befüllt.

'''Beispiele'''

#grd_paste y=c i=item ige=Y add=Y f_ckey=row0 f_cvalue=row1 f_csort=row2 f_status=1
#grd_paste y=r i=grid fxrow=datum frow=0 f_ft_sperren=row1 fr=$FND(aktion)
#grd_paste y=r ige=Y add=Y lat=Y i=grid frow=0 fxrow=code f_code=row0 f_target=row1 f_channel_type=row2 f_channel_group=row3 f_channel=row4

==#grd_ac==

Die Prozedur #grd_ac fügt einem Grid eine Zeile hinzu und setzt dort die Werte ("add") oder ändert nur die Werte ab ("change"), abhängig davon, ob der mit fnd_1 bis fnd_9 definierte Datensatz bereits vorhanden ist oder nicht.

'''Parameter'''

* chg ("change") - Wenn Y, werden die Zellen in den Changed-Modus gesetzt, auch wenn sich ihr Wert nicht ändert; default N; Funktionen werden ersetzt
* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f_ ("field) - Prefix für die Feldnamen der Spalten, deren Werte gesetzt werden sollen; Funktionen werden ersetzt
* fnd_1 bis fnd_9 - Namen der Spalten, anhand die Zeile identifiziert wird; es wird die erste Zeile verwendet, auf die diese Bedingung zutrifft; Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments
* ic ("IgnoreCase") - bei der Prüfung mit fnd_1 bis fnd_9 bleiben Groß- und Kleinschreibung unberücksichtigt
* y - Typ der Einfügeoperation; Funktionen werden ersetzt; default bottom
** asel ("after selected") - die neue Zeile wird nach der selektierten Zeile eingefügt
** bottom - die neue Zeile wird unten angehängt
** bsel ("before selected") - die neue Zeile wird vor der selektierten Zeile eingefügt
** top - die neue Zeile wird als erste Zeile eingefügt

'''Beispiel'''

#cmd_clear2 #grd_ac i=grid fnd_1=adrnr fnd_2=aktion f_adrnr=$SEPLINE(0) f_aktion=$SEPLINE(1) f_add_1=$SEPLINE(2) f_add_2=$SEPLINE(3)
#btns_btn c="Kunden aus Zwischenablage" w=200 cmd="#csv_paste er=2" se=bcp

==#grd_sort==

Sortiert das Grid nach der angegebenen Spalte. Das kann beispielsweise erforderlich sein, wenn ein Grid mit zwei #grd_data-Prozeduren gefüllt wird, so dass nicht mit einer ORDER BY-Klausel sortiert werden kann.

'''Parameter'''

* f (field) - Feldname der Spalte, nach der sortiert werden soll
* i (item) - Name des Grids, das sortiert werden soll
* y - Sortierreihenfolge (u oder d, entsprechend der Symbole an der Spalte, wenn manuell sortiert wird)

'''Beispiel'''

#grd_sort i=grid f=aktion y=d
#grd_sort i=grid f=adrnr y=d

Diese beiden Zeilen entsprechen einem ORDER BY adrnr, aktion

==#grd_pos==

Ermittelt die Zeilennummer der ersten Zeile, auf welche die Such-Kriterien zutreffen

'''Parameter'''

* f_ (field) - Prefix der Spaltenbezeichner, die das Suchkriterium bilden. Als Wert des Parameters wird dann der Wert übergeben, nach dem in dieser Spalte gesucht werden soll.
* i (item) - Name des Grids, in dem gesucht wird
* res (result) - Name der Variable oder Nummer des Values, in die das Suchergebnis (Y oder N) geschrieben wird
* row - Name der Variable oder Nummer des Values, in welche die Reihennummer geschrieben wird.

'''Beispiel'''

#grd_pos i=grid f_adrnr=$SEPLINE(0) f_isocode=$SEPLINE(1) f_status=1 res=1 row=2

==#grd_dub==

Ermittelt, ob in einer Spalte oder einer Spaltenkombination Duletten auftreten.

Mit ccnd, ocr und sc kann die Menge der Zeilen eingeschränkt werden, die geprüft wird. Dubletten werden nur innerhalb der Reihen gefunden, die geprüft werden. Üblicherweise werden die ocr und sc nicht verwendet.

Wenn auf mehrere Spalten geprüft wird, dann wird dieselbe Kombination alles Spalten als Dublette erkannt. (Die Zellenwerte werden zu einem langen String zusammengefügt und dabei mit ~@~ getrennt.)

'''Parameter'''

* ccnd ("CheckCondition") - Wenn Y, dann wird die Zeile bei der Prüfung berücksichtigt. Default Y, Funktionen werden ersetzt. Auf die aktuelle Zeile kann mit der Sonderzeile ''calcrow'' zugegriffen werden. Üblicherweise muss die Funktion $BOOL() verwendet werden, um eine Bedingung auszuwerten, siehe Beispiel.
* cnd ("condition") - wenn Y, dann wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* cnt ("count") - Anzahl der Spalten oder Feldnamen, die verwendet werden
* col1, col2... - Index der Spalte. Wenn nicht gesetzt, wird der Feldname verwendet; Funktionen werden ersetzt
* d1, d2... ("dublette") - Name der Variable oder Nummer des Values, in welche(n) die erste gefundene Dublette geschrieben wird; Funktionen werden ersetzt
* f1, f2... ("fieldname") - Feldname der Spalte. Wird nur verwendet, wenn col nicht gesetzt ist.
* i (item) - Name des Grids, in dem gesucht wird
* n - Name der Variable oder Nummer des Values, in welche(n) das Prüfungsergebnis geschrieben wird (Y - mindestens eine Dublette, N - keine Dublette); Funktionen werden ersetzt
* ocr (OnlyChangedRows) - Wenn Y, werden nur Zeilen bei der Berechnung berücksichtigt, die geändert wurden; default N.
* sc ("SelectionColumn") - Index der Spalte, die als Selection-Column verwendet wird. Eine Zeile wird dann nur geprüft, wenn sie auch selektiert ist. Default ist -1, dann wird keine SelectionColumn verwendet; Funktionen werden ersetzt

'''Beispiel'''

#code ccnd="$BOOL($PVAL(reisen,status,calcrow) = 1 and $IN($PVAL(reisen,reise_jahr_id,calcrow),30211BFC-A87D-4C07-9D7E-A92B07C52377) = N)"
#grd_dub i=reisen n=result cnt=2 f1=reise_jahr_id f2=kgr $CODE$

==#grd_thread==

Lädt Daten aus einem Hintergrund-Thread in ein Grid-Segment. Wird dazu verwendet, Daten aus unterschiedlichen Datenbank zusammen zu führen.

'''Parameter für alle Typen'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* i ("item") - Name des Grid-Segments; Funktionen werden ersetzt, default ist das zuletzt eingefügte Segment
* k ("key") - Parameter im SQL-Statement; im Grid-Segment muss es eine Spalte mit diesem Feldnamen geben.
* ready - Kommando, das ausgeführt wird, wenn der Thread fertig ist; lokale Kommandos können nicht verwendet werden; Funktionen werden ersetzt (zum Zeitpunkt des Kommandos #grd_thread)
* rni ("row no insert") - Wenn Y, dann wird bei Zellen, für die Daten ergänzt wurden, das Insert-Flag entfernt; default N, Funktionen werden ersetzt. Dieser Parameter wird in folgender Konstellation benötigt: Über einen Thread werden Daten aus einer Ergänzungstabelle ergänzt. Bei grd_data sind die Daten noch nicht vorhanden, für alle Zeilen wird dort mit nvi=$GUID() eine Guidergänzt und dabei das Insert-Flag gesetzt. Der Thread ergänzt nun bereits vorliegende Daten und überschreibt dabei die Guid mit dem Wert aus der SQL-Abfrage, so dass bei Änderungen diese in den korrekten Datensatz zurückgeschrieben werden. Allerdings würde dabei das noch gesetzte Insert-Flag dazu führen, dass ein INSERT-Statement versucht würde, was zu einer Primärschlüsselverletzung führt. Wird nun rni=Y gesetzt, dann wird bei diesen Zellen das Insert-Flag entfernt, so dass statt dessen ein UPDATE durchgeführt wird.
* to ("TimeOut") - Zeit in Sekunden, bis ein Request abgebrochen wird; Funktionen werden ersetzt, default 15
* y - Typ des Threads; Funktionen werden ersetzt, default grid
** grid - Grid wird mittels SQL-Statement gefüllt, das mit #sql definiert werden muss
** gridbulk - Die Daten werden mit nur einer Abfrage ermittelt; geht bisweilen deutlich schneller
** gridlist - im Gegensatz zu den anderen Typen wird nicht ein einzelner Wert abgefragt, sondern alle Zeilen, welche die SQL-Abfrage liefert; die einzelnen Zeilen werden mit dem Inhalt des Parameters sep getrennt.
** gridxml - Grid wird mittels xml gefüllt, das mittels http(s)-Abfrage beschafft wird

'''Parameter für SQL-Statements'''

* db ("DataBase") - Datenbank, in der das Statement ausgeführt wird.
* sep ("separator") - Zeichenfolge, mit der bei y=gridlist die einzelnen Zeilen getrennt werden; Funktionen werden ersetzt; um Zeilenumbrüche zu setzen, verwendet man sep=$CHR(crlf)

'''Parameter für XML'''
* acc - Akzeptierte Response-Formate
* cu8 ("convert UTF8") - wenn Y, werden die Zeichen von UTF8 nach ANSI konvertiert; default N, Funktionen werden ersetzt
* cy - Content-Typ der Anfrage
* e_req - Encoding des Requests, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* e_res - Encoding des Response, zulässig sind ansi, ascii, utf7, utf8, unicode und bigendianunicode. Funktionen werden ersetzt, default utf8.
* f_ - Prefix für Header-Einträge, zum Beispiel für die Authorisierung; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, werden bei den SSL-Options die Werte IgnoreServerCertificateConstraints, IgnoreServerCertificateInsecurity und IgnoreServerCertificateValidity gesetzt. Das ist zum Beispiel erforderlich, um auf REST-Server zuzugreifen, deren Zertifikat abgelaufen ist. Default N, Funktionen werden ersetzt.
* method - Methode des http(s)-Aufrufs (nicht y, da bereits belegt); Funktionen werden ersetzt
** delete
** get
** post
** put
* request - Text der Anfrage bei post und put; Funktionen werden ersetzt
* response - Nummer des Values oder Name der Variable, in die bzw. den das Ergebnis geschrieben wird
* url - Webadresse des aufgerufenen Services; Funktionen werden ersetzt
* wait - Zeit in Millisekunden, die auf die Antwort gewartet wird; Funktionen werden ersetzt; default 1000

'''Beispiel'''

Hier im Beispiel werden drei Spalten als q=thread definiert. Die Daten für diese Spalten werden mittels #grd_thread ermittelt, der das vorangehende SQL-Statement ausführt. Schlüssel ist dwversionid.

#grd_col f=dwversionid c1="Dwversionid"
#grd_col f=szlongname h=szlongname c1="Dateiname" w=100 q=thread
#grdcol c1=Tournr f=tournr w=50 st=gsj f=szlongname q=thread ss1=Y
#grdcol c1="Dok Time" h1="Dokumentendatum Uhrzeit" f=doctime q=thread w=80 ro=Y nd=Y ss1=Y st=gsj
...
#grd_data q=sql

#sql SELECT substring(xyz, 1, 2) + ':' + substring(xyz, 3, 2) AS doctime, dwinteger09 as tournr , szlongname FROM
#sql (SELECT format(b.dwCreation_time, '000000') AS xyz, dwinteger09, szlongname
#sql FROM dbo.baseattributes b WHERE b.dwVersionId = :dwversionid) q
#grd_thread k=dwversionid db=wd

==$GRD_CHECK==

Die Funktion $GRD_CHECK prüft ein Grid-Segment auf bestimmte Bedingungen und ist damit eine Alternative zu #grd_calc in bestimmten Konstellationen.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Prüf-Statement, der Inhalt der jeweiligen Zelle wird durch $CELL$ eingefügt, siehe Beispiel. Bitte beachten, dass Funktionen in diesem Parameter nicht verwendbar sind.

'''Beispiel'''

#page_check c="MWSt muss 7, 19 oder leer sein" chk="$GRD_CHECK(codes,kosten_mwst,all,$CELL$ = 7 or $CELL$ = 19 or $CELL$ =)"

==$GRD_REGEX==

Die Funktion $GRD_REGEX prüft ein Grid-Segment die die Einhaltung eines Regex-Staements in einer bestimmten Spalte. Eignet sich insbesondere für #page_check, siehe Beispiel.

'''Parameter'''

# Name des Grid-Segments
# Spaltenindex oder Feldname der Spalte, die untersucht wird
# Reihentyp
## all - es werden alle Reihen geprüft
## cellchanged - es werden nur die Reihen geprüft, wenn sie in der angegebenen Spalte geändert wurden
## rowchanged - es werden nur die Reihen geprüft, die (in einer beliebigen Spalte) geändert wurden
## rowselected - es wird nur die Reihe der selektierten Zelle geprüft
# Regex-Statement
# Optionen
## e ("allow empty") - $GRD_REGEX gibt auch Y zurück, wenn der Zellenwert leer ist.

'''Beispiel'''

#page_check c="Aktionscode entspricht nicht den Formatvorgaben" chk=$GRD_REGEX(reisen,aktionscode,all,[A-Z]{3}\d{4},e)

==$CCI==

Die Funktion $CCI ermittelt aus einem Integer-Wert die zu setzenden Zellen-Farbe

'''Parameter'''

# Der Wert, der die Zellen-Farbe bestimmt. Sofern der Wert der Zelle verwendet werden soll, deren Farbe gesetzt wird, reicht ein Ausrufezeichen.
# Wenn L, dann muss der Wert in Parameter 1 den Schwellwert erreichen oder unterschreiten, andernfalls muss er ihn erreichen oder überschreiten
# Schwellwert rot.
# optional: Schwellwert gelb; wird nur geprüft, wenn der Schwellwert rot nicht erreicht ist
# optional: Schwellwert grün; wird nur geprüft, wenn die Schwellwerte rot und gelb nicht erreicht sind

'''Beispiel'''

#grd_col f=dubletten y=int w=30 a=r c1="D" h1="Dubletten" ccc=$CCI(!,,1)

=XGrid-Segmente=

XGrid-Segmente sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch eine andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xgrd_seg==

Mit der Prozedur #xgrd_seg wird ein XGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

siehe unten

==#xgrd_col==

Die Prozedur #xgrid_col definiert die fixen Spalten des Grid, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xcol==

Die Prozedur #xgrd_xcol definiert die X-Spalten, also die Spalten, die für jeden Datensatz der #xgrd_xdata eingefügt werden.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xgrd_xdata==

Mit #xgrd_xdata werden die variablen Spalten des Grids angelegt. Für jede Zeile der mit #xgrd_xdata geöffneten SQL-Abfrage wird ein Satz von den mit #xgrd_xcol angelegten Spalten angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* Prefix k - Prefix für SQL-Parameter

'''Beispiel'''

siehe unten

==#xgrd_data==

Mit #xgrd_data werden Zeilen des Grids angelegt.

'''Parameter'''

* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* k (key) - Name der Schlüsselspalte; per default der Tabellennamen plus ein angehängtes _id; Funktionen werden ersetzt
* k2, k3... - Name der Schlüsselspalten weiterer Tabellen; per default der Tabellennamen plus ein angehängtes _id
* Prefix k - Prefix für SQL-Parameter
* m ("maximum") - Nach dieser Anzahl von Zeilen wird abgebrochen; default MaxInt (2 147 483 647), Funktionen werden ersetzt
* ocd (open cat on data) - Wenn Y, wird die übergeordnete Kategorie geöffnet, wenn das Grid Daten enthält; default N; Funktionen werden ersetzt
* t (table) - Name der Datenbanktabelle, in welche die Daten beim Speichern zurückgeschrieben werden; Funktionen werden ersetzt
* t2, t3... - Tabellennamen weiterer Tabellen

'''Beispiel'''

siehe unten

==#xgrd_calc==

Mit #grd_calc funktioniert grundsätzlich auf bei X-Grids. Allerdings gibt es Aufgabenstellungen, die mit #grd_calc nicht durchführbar sind.

Die Prozedur #xgrd_calc bildet erst eine Aggregatfunktion in der einen Richtung, und dann aus den Ergebnissen eine zweite Aggregatfunktion in der anderen. Nähre Erläuterungen siehe Beispiel.

'''Parameter'''

* cnd - ("condition") Die Prozedur wird nur dann ausgeführt, wenn das Statement in cnd Y ergibt. Default ist Y, Funktionen werden ersetzt
* f - ("FieldName") Feldname der Zelle im Grid, für welche die fnc1 ausgeführt wird; Funktionen werden ersetzt
* fnc1, fnc2 - ("Function") die erste und zweite Funktion, die ausgeführt wird; default sum, Funktionen werden ersetzt
** avg - Durchschnitt
** count - Anzahl
** max - Maximum
** min - Minimum
** sum - Summe
* nv0 - ("NullValue = 0") Wenn Y, werden leere Zellen sowie Spalten- beziehungsweise Reihen-Ergebnisse wie 0 behandelt; default N, Funktionen werden ersetzt
* ry - ("result type") Type des Ergebnisses; default curr
** curr - Festkommewert mit zwei Nachkommastellen
** curr 4 - Festkommawert mit vier Nachkommastellen
** date - Datum
** datemin - Datum mit Stunden und Minuten
** datesec / datesek - Datum mit Stunden, Minuten und Sekunden
** int - Ganzzahlen
* y - Typ; default xy, Funktionen werden ersetzt
** xy - Erst wird in X-Richtung (durch alle Spalten) die fnc1 ermittelt; jede Zeile hat dann ein Ergebnis. Danach wird über alle Zeilenergebnisse fnc2 ermittelt.
** yx - Erst wird in Y-Richtung (durch alle Zeilen) die fnc1 ermittelt. Jede Spalte hat dann ein Ergebnis. Danach wird über alle Spaltenergebnisse fnc2 ermittelt.
* z - Name der Variable oder Nummer des Values, in die das/den das Ergebnis geschrieben wird.
'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll geprüft werden, wie viele Reisen einem Code maximal zugewiesen sind. Dazu wird in X-Richtung die Summe der aktivierten Zellen in der Spalte aktiv gezählt, so dass für jede Zeile (hier jedem Werbecode) ein Anzahl ermittelt wird. fnc1 ist somit sum. Dann geht die Prozedur durch alle Zeilen und ermittelt das Maximum, fnc2 ist daher max.

#xgrd_calc i=jahr2code y=xy f=aktiv fnc1=sum fnc2=max nv0=Y ry=int n=result

==$XGRD_CALC==

Wie die Prozedur #xgrd_calc, kann aber direkter in #page_check verwendet werden, siehe Beispiel

'''Parameter'''

# Segment
# Typ; xy oder yx
# FieldName
# Func 1 (avg, count, max, min oder sum)
# Func 2 (avg, count, max, min oder sum)
# NV0 - wenn Y, werden leere Feldwerte oder Spalten- oder Zeilenergebnisse wie 0 gezählt
# Ergebnistyp (curr, curr4, date, datemin, datesek / datesec, int)

'''Beispiel'''

Im X-grid jahr2code werden Reisejahre Werbecodes zugeordnet. Es soll mittels #page_check sichergestellt werden, dass bei fertig angelegten und nicht stornierten Werbeaktionen (status zwischen 2 und 8, wird über cnd realisiert) jedem Code mindestens eine Reise und jeder Reise mindestens ein Code zugeordnet ist.

Zunächst wird für jede Spalte und jede Zeile die Anzahl der Zuordnungen (aktiv = Y) ermittelt (erste Funktion sum), von den Ergebnissen wird dann das Minimum gebildet; das Ergebnis wird dann darauf geprüft, ob es > 0 ist.

#code chk="$BOOL($XGRD_CALC(jahr2code,xy,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jeder aktive Code muss mindestens einer Reise zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$
#code chk="$BOOL($XGRD_CALC(jahr2code,yx,aktiv,sum,min,Y,int) > 0)"
#page_check c="Jede aktive Reise muss mindestens einem Code zugeordnet sein" cnd=$NUMBETWEEN($PVAL(vl,status),2,8) $CODE$

==Beispiel==

Für das Beispiel werden die folgenden drei Tabellen verwendet, zwei Detail-Tabellen und eine Verknüpfungstabelle:

create table sd_cross_x (
sd_cross_x_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_y (
sd_cross_y_id varchar(40) not null primary key,
name varchar(40) not null,
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

create table sd_cross_xy (
sd_cross_xy_id varchar(40) not null primary key,
sd_cross_x_id varchar(40) not null,
sd_cross_y_id varchar(40) not null,
active char(1),
remarks varchar(40),
datechg date,
usrchg varchar(40),
progchg varchar(40)
);

Damit wollen wir das folgende Formular erstellen:

[[file:demo xgrid.png|1000px|Demo XGrid]]

Damit die Änderungen in den Detail-Tabellen gleich nach dem Speichern im XGrid sichtbar werden, wird bei der Page der Parameter ras ("RefreshAfterSave") gesetzt.

#page ras=Y

Wir verwenden hier in einer Primär-Region zwei Kategorien, links für die Spalten (X), rechts für die Reihen (Y). Die beiden Kategorien werden also nebeneinander angezeigt.

Jede Kategorie hat ein Button-Segment mit einem Button, mit dem jeweils ein neuer Datensatz angelegt werden kann. Dazu muss lediglich die Prozedur #grd_add aufgerufen werden.

Die Tabellen hier im Beispiel haben (neben den Standard-Spalten _id, datechg, usrchg und progchg) lediglich einen Namen. Damit die ID-Spalte mit einer GUID versorgt wird, wird diese für den Parameter nvi ("NullValue Insert") erzeugt; bei der Gelegenheit wird die Zeile dann gleich als neu eingefügt gekennzeichnet.

#prim as=Y
#cat as=Y c=X
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridx"

#grd_seg frc=0 fcc=1 clt=ss n=gridx c=" " b=XYH
#grd_col f=sd_cross_x_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_x order by name
#grd_data q=sql t=sd_cross_x

#cat as=Y c=Y
#btns_seg
#btns_btn c="$T(Add item)" w=150 cmd="#grd_add i=gridy"

#grd_seg frc=0 fcc=1 clt=ss n=gridy c=" " b=xYH
#grd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y nvi=$GUID()
#grd_col f=name c1="Name" l=40 w=100 wst=500 xw=400
#sql select * from sd_cross_y order by name
#grd_data q=sql t=sd_cross_y

Die zweite Primärregion beinhaltet das XGrid, mit dem die Verknüpfung angezeigt wird. Nach der Prozedur #xgrd_seg werden mit #xgrd_col erst mal die beiden fixen Spalten definiert, die ID und der Name (der Reihe).

Danach werden die variablen Spalten mit #xgrd_xcol definiert und mit #xgrd_xdata angelegt. Als erste Spalte in einem solchen Spaltensatz wird eine Spalte für die IDs eingefügt. Diese hat üblicherweise die Breite w=0, da die IDs nicht interessieren. Zum Debuggen kann diese Spalte jedoch breiter gemacht werden. Diese "unsichtbare" Spalte hat als Feld f die ID der Verknüpfungstabelle, hier also f=sd_cross_xy_id. Als Feld für die erste Headerzeile f1 muss die ID der X-Datenmenge, hier also f1=sd_cross_x_id.

Bei den weiteren Spalten besteht die Freiheit des Programmierers. Hier im Beispiel wird eine bool'sche Spalte für die Verknüpfung sowie eine Anmerkungsspalte eingefügt. Mit cs1=2 bei der bool'schen Spalte wird die Überschrift über beide Spalten gezogen.

#prim as=Y
#cat as=Y c=XY

#xgrd_seg frc=0 fcc=1 clt=ss n=gridxy c=" " b=XYH
#xgrd_col f=sd_cross_y_id c1=ID w=30 y=guid ro=Y
#xgrd_col f=yname c1="name" w=80 nd=Y ro=Y

#xgrd_xcol f1=sd_cross_x_id f=sd_cross_xy_id w=0 y=guid ro=Y
#xgrd_xcol f1=name cs1=2 f=active y=bool w=30 xcs1=2
#xgrd_xcol f=remarks l=40
#sql select * from sd_cross_x order by name
#xgrd_xdata

Für die Daten im XGrid brauchen wir zunächst ein SQL-Statement, das aus den beiden Detail-Datenmengen ein kartesisches Produkt (Mengenprodukt) erstellt; dafür sehen wir im Statement die Verknüpfungsbedingung 1=1 (die nur deswegen eingefügt ist, damit formal eine Verknüpfungsbedingung vorhanden und das SQL-Statement syntaktisch korrekt ist). Mit einem left outer join wird die Verknüpfungstabelle hinzugefügt (kein inner join, da anfangs ja die Datensätze noch nicht vorhanden sind).

Mit der Prozedur #xgrd_data werden die Daten dann aus der Ergebnismenge geladen. Wir müssen hier die Tabellen t angeben, in welche die Daten zurückgeschrieben werden (also in die Verknüpfungstabelle, hier t=sd_cross_xy), welches die ID für die Spalten ist (hier fcol=sd_cross_x_id, das muss übereinstimmen mit f1=sd_cross_x_id in der 0-breiten ersten Spalte des Spalten-Sets), und wann eine neue Zeile begonnen wird (frow=sd_cross_y_id). Damit Letzteres korrekt funktioniert, muss die erste Sortierung im Statement nach den Reihen sein (hier order by y.name)

#sql select y.sd_cross_y_id, y.name as yname, x.sd_cross_x_id, x.name as xname, c.sd_cross_xy_id, c.active, c.remarks
#sql from sd_cross_y y
#sql inner join sd_cross_x x on 1=1
#sql left outer join sd_cross_xy c on c.sd_cross_y_id = y.sd_cross_y_id and c.sd_cross_x_id = x.sd_cross_x_id
#sql order by y.name, x.name
#xgrd_data q=sql t=sd_cross_xy fcol=sd_cross_x_id frow=sd_cross_y_id

==Tipps==

Das Erstellen des Codes für ein XGrid ist am Anfang ein wenig komplex und fehleranfällig. Von daher sollen hier noch die folgenden Tipps gegeben werden:

'''Vorlage kopieren'''

Nehmen Sie sich ein bestehendes XGrid-Segment, kopieren es und ändern es entsprechend ab.

'''Schrittweise vorgehen'''

Legen Sie erst die Spalten an, dann den Code für die Daten. Wenn Sie eine Vorlage kopiert haben, dann setzen Sie nach #xgrd_xdata erst mal vier Minuszeichen (der Rest das Codes ist dann Kommentar) und schauen erst mal, dass die Spalten korrekt angezeigt werden.

'''Gern gemachte Fehler'''

* In der ersten Spalte das variablen Spaltensatzes ist f oder f1 nicht oder nicht korrekt gesetzt. Oder f1 stimmt nicht mit fcol aus #xgrd_data überein.
* Das Statement für die Daten ist kein kartesisches Produkt als Spalten und Reihen
* Die Verknüpfungtabelle ist nicht mit einem left outer join hinzugefügt.
* Das Statement für die Daten ist nicht nach den Reihen sortiert.

'''In mehrere Tabellen schreiben'''

Müssen die Daten in mehrere Tabellen geschrieben werden, so ist die Verknüpfungstabelle immer die Tabelle t, alle anderen Tabellen werden mit t2, t3... hinzugefügt.

Schauen Sie sich als Beispiel xtodo_page_add an.

=XXGrid-Segmente=

XXGrid-Segmente ("Double-X-Grid-Segmente") sind Segmente, in denen in Tabellenform mehrere Datensätze einer SQL-Abfrage angezeigt werden. Dabei werden die Spalten durch zwei andere SQL-Abfrage gebildet. Grid-Segmente können Kopf- und Fußzeilen haben (default 1 Kopfzeile, 0 Fußzeilen)

==#xxgrd_seg==

Mit der Prozedur #xxgrd_seg wird ein XXGrid-Segment angelegt.

'''Parameter'''

* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; default 0; Funktionen werden ersetzt
* frc (footer row count) - Anzahl der Fußzeilen; default 0; Funktionen werden ersetzt
* hrc (header row count) - Anzahl der Kopfzeilen; default 0; Funktionen werden ersetzt
* sc (selection column) - Spaltenindex der Selection-Zeile. Ein Grid-Segment kann eine Selection-Spalte haben, also eine Spalte vom Typ bool, mit deren Hilfe einzelne Zeilen ausgewählt werden können. Default ist -1, Funktionen werden ersetzt.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

==#xxgrd_col==

Die Prozedur #xxgrid_col definiert die fixen Spalten des Grids, die an der linken Seite stehen.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xcol==

Die Prozedur #xxgrid_xcol definiert die vorderen variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==#xxgrd_xxcol==

Die Prozedur #xxgrid_xxcol definiert die hinteren variablen Spalten des Grids.

'''Parameter'''

Diese Prozedur gleich #grid_col, die Parameter sind dort beschrieben.

'''Beispiel'''

siehe unten

==Beispiel==

Das folgende Beispiel ist aus der Reklamationsbearbeitung eines Reiseveranstalters. Die einzelnen Stichworte (hier nur ausschnittsweise) sind in Kategorien zusammengefasst. Diese Kategorien bilden die vorderen Spaltenüberschriften, die Reisenummern die hinteren (in einer Reklamation können mehrere Reisen bemängelt werden, die Stichworte müssen von daher den Reisen zugeordnet werden).

[[file:Xxgrid 2.png|XXGrid-Segment]]

Um die Stichworte positionieren zu können, wird mit Zeilennummern gearbeitet, diese werden in der ersten Spalte angezeigt. Da die gesetzten Stichworte dem Vorgang zugeordnet werden müssen, muss die Vorgangs-ID gespeichert werden, dies passiert in einer Spalte mit der Breit 0.

#xxgrd_seg n=cross fcc=1 c=" " b=H
#xxgrd_col c1=Nr w=30 ro=Y f=zahl st=gsj nd=Y
#xxgrd_col w=0 ro=Y f=ks_vorgang_id

Hier werden nun die variablen Spalten definiert. Vorne (xxgrid_xcol) haben wir das Stichwort, für die IDs, auch der Kategorie, haben wir davor eine Spalte mit der Breite 0. Hinten (xxgrid_xxcol) haben wir dann die Möglichkeit, einen Haken zu setzen (y=bool2), darüber muss die Reisenummer (f1=aktion), davor gibt es wieder eine Spalte mit der Breite 0 mit der ID des Stichworts. Da der Platz begrenzt ist, wird die Bezeichnung der Reise nur als Hint-Text der Reisenummer angezeigt.

#xxgrd_xcol w=0 f1=rekla_tbs_kat_id f=rekla_tbs_id
#xxgrd_xcol w=170 f1=name f=stiwo ro=Y st=gsf nd=Y
#xxgrd_xxcol w=0 f=rekla_stiwo_id
#xxgrd_xxcol w=36 f1=aktion f=aktiv h1=bezeichnung y=bool2

Mit #xxgrd_xdata werden die Spalten ermittelt. Das SQL-Statement muss ein kartesisches Produkt aus den Kategorien und denjenigen Reisenummern bilden, die beim Vorgang beteiligt sind (Tabelle neuland.ks_vorgang_reise). (Am Rande: Es handelt sich hier um einen Test auf einem System, das auf einer Postgres-Datenbank läuft, die Datenbank aber aus einem Oracle-System holt. Entsprechend ist db=ora_prod gesetzt und die GUID des Vorgangs hart codiert.)

#sql select k.rekla_tbs_kat_id, k.name, r.aktion, d.bezeichnung
#sql from neuland.rekla_tbs_kat k
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join rsd d on d.aktion = r.aktion
#sql where k.status = 1 and k.az = :kaz
#sql order by k.sort, r.aktion;
#xxgrd_xdata k=rekla_tbs_kat_id kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R db=ora_prod

Die Tabelle, in welche die gesetzten Stichworte geschrieben werden, ist neuland.rekla_stiwo. Eine solche Tabelle muss stets mit einem left outer join der restlichen Abfrage hinzugefügt werden. Das restliche Statement liefert die Stichworte, Kategorien und Reisenummern. Der Parameter kaz ist ein Parameter aus dem SQL-Statement, in den die Abteilungszugehörigkeit (hier R für Reklamationsabteilung) geschrieben wird.

Wenn das Statement korrekt ist, müssen dann nur noch die Spaltenbezeichner für die Überschrift der vordere Variable Spalte (Kategorie, also fcol=rekla_tbs_kat_id), die vordere variable Spalte (Stichwort, also fxcol=rekla_tbs_id) und die hintere variable Spalte (Reisenummer, also fxxcol=aktion) sowie der Reihen (frow=zahl) gesetzt werden.

#sql select r.ks_vorgang_id, t.zahl, k.rekla_tbs_kat_id, k.name as kat, r.aktion, b.rekla_tbs_id, b.name as stiwo, s.rekla_stiwo_id, s.aktiv
#sql from neuland.stamm_tage t
#sql inner join neuland.rekla_tbs_kat k on k.status = 1 and k.az = :kaz
#sql inner join neuland.ks_vorgang_reise r on r.ks_vorgang_id = :kid and r.status < 7
#sql inner join neuland.rekla_tbs b on b.rekla_tbs_kat_id = k.rekla_tbs_kat_id and b.sort = t.zahl
#sql left outer join neuland.rekla_stiwo s on s.ks_vorgang_id = r.ks_vorgang_id and s.rekla_tbs_id = b.rekla_tbs_id and s.aktion = r.aktion
#sql where t.zahl between 1 and 20
#sql order by t.zahl, k.sort, r.aktion;
#code fcol=rekla_tbs_kat_id fxcol=rekla_tbs_id fxxcol=aktion
#xxgrd_data t=neuland.rekla_stiwo kid=FFACF140-151F-412C-8EE7-A872B1DCA7EB kaz=R $CODE$ frow=zahl db=ora_prod

=SGrid-Segmente=
Bei einem SGrid sind die Zeilen durch so genannte Segmente gruppiert.

[[file:sgrid.png|788px|SGrid]]

==#sgrd_seg==

Mit der Prozedur #sgrd_seg wird ein SGrid-Segment angelegt.

'''Parameter'''

* cc ("ColumnCount") - Anzahl der Spalten; default 2; Funktionen werden ersetzt
* clt (column line type) - Spezifiziert, ob Spalten verbreitert oder umgebrochen werden; default sf; Funktionen werden ersetzt
** mf - multi line fixed
** ms - multi line stretch
** sf - single line fixed
** ss - single line stretch
* fcc (fixed columns count) - Spalten, die auch beim Scrollen links angezeigt werden; Wird bei #vl_seg sehr selten verwendet; default 0
* w ("width") - Breite der Spalte (w1, w2, w3...); Funktionen werden ersetzt
* wst ("width stretch") - Anzahl der Pixel, um welche die Spalte maximale verbreitert wird (wst1, wst2, wst3...); Funktionen werden ersetzt; findet nur bei clt=ss und clt=ms Verwendung
* whs (without horizontal scrollbar) - Blendet einen horizontalen Scrollbalken komplett aus, das Grid wird dadurch 20 Pixel weniger hoch.

'''gemeinsame Parameter aller Segmenttypen'''

* b ("Buttons") - Buttons für das Segment; benötigt eine Überschrift (zur Not ein Leerzeichen), weil die Buttons rechts oben in der Überschriftszeile untergebracht werden; Funktionen werden ersetzt
* c ("Caption") - Überschrift für das Segment; Funktionen werden ersetzt
* hp ("help path") - noch ohne Funtion
* n ("name") - Name des Segments, wird benötigt, wenn auf das Segment zugegriffen werden soll
* mhc ("max height closed") - maximale Höhe im geschlossenen Zustand
* mho ("max height opened") - maximale Höhe im geöffneten Zustand
* oc ("open close") - Spezifiziert, ob das Segment im geöffneten und/oder geschlossenen Zustand der Kategorie angezeigt wird; Funktionen werden ersetzt; default o
** c - Segment wird nur in geschlossenem Zustand angezeigt
** o - Segment wird nur in geöffnetem Zustand angezeigt
** oc - Segment wird in geöffnetem und geschlossenen Zustand angezeigt
* r ("rights") - Rechtedefinition
* ro ("read only") - Der Anwender kann die Daten im Segment nicht ändern

'''Beispiel'''

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80

==#sgrd_node==

Die Prozedur #sgrd_node legt eine Ebene des SGrids an und definiert dort die Spalten. Im einfachsten Fall hat ein SGrid eine Zeile für eine übergeordnete und eine Zeile für die untergeordnete Ebene. Es können jedoch mehr als zwei Ebenen angelegt werden. Es ist auch möglich, dass eine Ebene mehrere Zeilen hat - das ist besonders dann hilfreich, wenn viele Spalten untergebracht werden müssen.

'''Parameter'''

* a1, a2... (align) - Ausrichtung des Textes in der Spalte; default ist l.
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c1, c2... ("caption") - Beschriftung der Zelle; wird die Beschriftung ersetzt, wird die Zelle auf ReadOnly gesetzt; Funktionen werden ersetzt
* ccc ("cell color command") - Kommando für die Zellenfarbe der Zeile, default leer, Funktionen werden ersetzt. Wird primär für ccc=header verwendet.
* chg1, chg2... ("change") - Kommando, das ausgeführt wird, wenn der Inhalt der Zelle geändert wird; siehe auch ''Beispiel für chg''
* ci1, ci2... (characters ignore) - Zeichen, die bei der Eingabe über die Tastatur ignoriert werden; default leer; Funktionen werden ersetzt
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* f1, f2... ("field") - Feldname in der Datenmenge, aus der die Zelle ihre Daten bezieht; Funktionen werden ersetzt
* k ("key") - Name der Schlüsselspalte; default ist der Tabellenname mit einem angehängten _id
* l1, l2... ("length") - Zeichenlänge der Zelle
* nd1, nd2... ("no data") - Daten werden beim Speichern nicht zurück in die Datenbank geschrieben; Änderungen an den Daten versetzen das VL-Segment und somit die Page nicht in den Changed-Status
* pw1, pw2... ("password") - Wenn Y, dann werden statt des Inhalts Punkte angezeigt; Funktionen werden ersetzt
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* q1, q2... ("Quelle") - Datenquelle für die Zelle; siehe auch ''Beispiel für Datenquelle''
* r1, r2... ("rights") - Rechtedefinition der Zelle
* ro ("read only") - Wenn Y, kann die Zeile nicht bearbeitet werden; default N, Funktionen werden ersetzt
* ro1, ro2... ("read only") - Zelle kann nicht bearbeitet werden
* t ("table") -Name der Tabelle, in der die Daten zurück geschrieben werden.
* u - Typ der Ebene. Der Typ hat eher deklaratorischen Charakter, lediglich a und w haben eine Funktion. Ansonsten müssen die Ebenen in der Reihenfolge angelegt werden, wie sie kommen, also zuerst die oberste Ebene.
** a / w ("additional", "weitere") - deklariert eine weitere Zeile auf derselben Ebene.
** l ("last") - untergeordnet unter der zuletzt deklarierten Ebene
** r ("root") - oberste Ebene
* y1, y2... ("type") - Datentyp der Spalte; default ist text
** bool - bool'sche Felder mit Y und N; wird als Checkbox dargestellt
** bool2 - bool'sche Felder, Y wird als angehakte Checkbox dargestellt, N als leeres Feld
** curr - Currency, also Zahlen mit zwei Nachkommastellen
** curr4 - Zahlen mit vier Nachkommastellen
** date - Datum im Format dd.mm.yyyy
** datemin - Datum im Format dd.mm.yyyy hh:mm
** datesec / datesek - Datum im Format dd.mm.yyyy hh:mm:ss
** guid - Inhalt wird als drei Punkte dargestellt; wird für GUIDs verwendet, die sich dann aber kopieren lassen
** iban - noch nicht implementiert
** int - Integer, also ganze Zahlen
** link - Link-Symbol
** lookup - Nachschlageliste
** lookuplive - Nachschlageliste, die beim Öffnen neu und auch für jede Zelle individuell geladen wird
** text - normaler Text
** todo - Symbole für ToDo-Listen
** triex - drei Symbole: 0, ? und !
** triplus - drei Symbole: 0, - und +
* z1, z2... - Wert der Zelle; im Unterschied zur Caption wird der Wert von #vl_data überschrieben, die Zelle wird auch nicht auf ReadOnly gesetzt.

'''Beispiel'''

#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y

==#sgrd_hf==

Die Prozedur #sgrd_hf legt Kopf- und Fußzeilen an.

Die Zahl zur Benennung ist die Kombination aus der Header/Footer-Zeile und der Spaltennummer. Da es quasi nie mehr als 9 Header- oder Footer-Zeilen gibt, funktioniert das in der Praxis.

'''Parameter'''

* a11, a12, a21... ("hint") - Alignment des Headers
** c (center) - Text wird zentriert ausgerichetet
** d2 (decimal 2) - Text wird rechtsbündig für zwei Nachkommastellen ausgerichtet
** d4 (decimal 4) - Text wird rechtsbündig für vier Nachkommastellen ausgerichtet
** l (left) - Text wird linksbündig ausgerichtet
** r (right) - Text wird rechtsbündig ausgerichtet
* c11, c12, c21... ("caption") - Header Spalten-Titel; Funktionen werden ersetzt.
* cs11, cs12, cs21... ("column span") - Spalten-Zusammenfassung im Header, default 1; Funktionen werden ersetzt.
* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* fa11, fa12, fa21... ("hint") - Alignment des Footers; fültige Werte siehe a11...
* fc11, fc12, fc21... ("caption") - FooterSpalten-Titel; Funktionen werden ersetzt.
* fcs11, fcs12, fcs21... ("column span") - Spalten-Zusammenfassung im Footer, default 1; Funktionen werden ersetzt.
* fy11, fy12, fy21... - Type der Footer-Zelle
* h11, h12, h21... ("hint") - Hint-Text des Headers; Funktionen werden ersetzt

'''Beispiel'''

#sgrd_hf c11=ID c12=Sort c13=Schlüssel c14=Wert c15=Status

==#sgrd_data==

Die Prozedur #sgrd_data lädt die Werte für das SGrid aus der Datenbank

'''Parameter'''

* cnd ("condition") - Wenn Y, wird die Prozedur ausgeführt; default Y, Funktionen werden ersetzt
* db ("DataBase") - Name der Datenbankverbindung, aus der die Daten bezogen werden; Funktionen werden ersetzt, default ist die Standard-Datenbankverbindung
* q (quelle) - Herkunft der Daten; default sql
** sql - SQL-Statement

'''Beispiel'''

#sgrd_data q=sql

==Beispiel==

#prim as=Y
#cat as=Y c=$T(Items_of_the_category)

#sgrd_seg hrc=1 cc=5 w1=30 w2=40 w3=80 w4=200 wst4=200 w5=80
#sgrd_hf c1=ID c12=Sort c13=Schlüssel c14=Wert c15=Status
#sgrd_node u=r ro=Y ccc=header t=data_list f1=data_list_id y1=guid f2=name cs2=2 f4=description cs4=2 nc=Y
#sgrd_node u=l t=data_list_item f1=data_list_item_id y1=guid f2=csort f3=ckey f4=cvalue f5=status y5=lookup ld5=general_status

#sql select l.data_list_id, l.name, l.description , i.data_list_item_id, i.csort, i.ckey, i.cvalue, i.status
#sql from data_list l
#sql inner join data_list_item i on i.data_list_id = l.data_list_id
#sql where l.category = 'General'
#sql order by l.name, i.csort, i.ckey
#sgrd_data q=sql

=Picture-Segmente=

Picture-Segmente dienen dazu, Bilder anzuzeigen.

==#pic_seg==

Die Prozedur #pic_seg fügt ein Bild ein. Mit dem Parameter y wird spezifiziert, wo das Bild her kommt.

'''Parameter'''
* f ("Field") - Feldname, in dem der Dateiname des Bildes steht, wenn Parameter q=link; Funktionen werden ersetzt
* fn ("FileName") - Dateiname des Bildes, wenn Parameter q=file; Funktionen werden ersetzt
* ho ("height closed") - Die Höhe des Segments bei geschlossener Kategorie, wenn nicht AutoSize verwendet wird.
* ho ("height open") - Die Höhe des Segments bei geöffneter Kategorie, wenn nicht AutoSize verwendet wird.
* i ("Item") - Name des Grid-Segmentes, wenn Parameter q=link; Funktionen werden ersetzt
* isc ("ignore server certificate") - Wenn Y, wird das Zertifikat des Servers bei q=http ignoriert; Funktionen werden ersetzt, default N
* q - Datenquelle des Bildes
** file - Der Dateiname des Bildes wird mit dem Parameter fn angegeben.
** link - Der Dateiname des Bildes steht in einem verbundenen Grid-Segment, dessen Namen mit dem Parameter i und dessen Feldname mit dem Parameter f angegeben wird.
** http - Das Bild wird aus dem Netz geladen, siehe Parameter url und isc
* sh ("scroll horizontal") - Wenn Y, wird ein waagerechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y
* sv ("scroll vertical") - Wenn Y, wird ein senkrechter Scrollbalken eingefügt; Funktionen werden ersetzt, default Y

'''Beispiele'''

#pic_seg aso=Y q=file fn="T:\Tools Gruppenrechte\BafClient2\pics\gutschein_a4.png" c=Gutschein sv=N sh=N
#pic_seg aso=Y q=link i=grid f=filename c=Gutschein sv=N sh=N
#pic_seg ho=300 q=http url="https://api.predic8.de/shop/products/$FND(s,id)/photo" isc=Y sv=N sh=N