Tabellenkonfiguration¶
Um eine einheitliche Konfiguration von Tabellen sicherzustellen, nutzen alle neueren Erweiterungen die Raptor Tabellenkonfiguration. Diese Konfiguration ist eine festgelegte Struktur, die von den Erweiterungen verwendet wird und bleibt integraler Bestandteil ihrer jeweiligen Konfiguration. Sie orientiert sich an der in diesem Kapitel beschriebenen Struktur und folgt den angegebenen Namen der Werte.
In der Dokumentation der einzelnen Erweiterungen wird auf dieses Kapitel verwiesen, wenn es um die Tabellenkonfiguration geht. Deshalb sind die Beschreibungen hier allgemein gehalten und nicht auf eine spezifische Erweiterung bezogen. Detaillierte Informationen, wie z. B. die spezifischen Spalten einer Tabelle, findest du in der jeweiligen Erweiterungsdokumentation.
Funktionen¶
Auswahl der anzuzeigenden Spalten in der Tabelle.
Konfigurierbare Reihenfolge der Spalten.
Definierbare Aktionsknöpfe für jede Zeile in einer speziellen Spalte.
Anpassbare Werte, die an Aktionen weitergegeben werden.
Konfiguration¶
Die Tabellenkonfiguration besteht aus den Listen TableColumns und TableActions, die je nach Erweiterung Teil der Grundkonfiguration sind oder mehrfach für unterschiedliche Aspekte der Daten vorkommen können.
Einfachere Erweiterungen nutzen meist nur die Listen TableColumns und TableActions zur Konfiguration aller von der Erweiterung erstellten Tabellen. In komplexeren Erweiterungen können diese Listen jedoch mehrfach eingebettet in andere Elemente vorkommen, um die Konfiguration für verschiedene Tabellen anzupassen.
Das Prinzip der Konfiguration bleibt dabei stets gleich. Auf welche Tabellen sich die jeweilige Konfiguration auswirkt, entnimmst du der Dokumentation der spezifischen Erweiterung.
Beispiel eines Konfigurationsschemas¶
Das folgende Konfigurationsschema zeigt die verschiedenen Werte, die für eine Tabelle konfiguriert werden können:
Module
TableConfigurationExample
Complex list definition
Must be one of this:
Path,Limit,Size,Usage,Actions
Must not be empty.
Maximum length:
64Must match this regular expression:
[^\p{Zl}\p{Zp}\p{C}]+
Default Value:
Yes
Default Value:
No
Must not be empty.
Maximum length:
64Must match this regular expression:
[a-z0-9]+
List
Complex list definition
Must not be empty.
Maximum length:
64
Die Liste TableColumns¶
Die Liste TableColumns legt die Reihenfolge und das Format der angezeigten Spalten in der Tabelle fest.
Der Wert Identifier¶
Der Wert Identifier bestimmt den Bezeichner für die jeweilige Spalte in der Tabelle. Jede Erweiterung bietet eine spezifische Liste von verfügbaren Bezeichnern, die du nach Bedarf konfigurieren kannst. Diese Liste findest du in der Dokumentation der jeweiligen Erweiterung.
Jeder Bezeichner darf nur einmal pro Tabelle verwendet werden.
Der besondere Bezeichner Actions steht für jede Tabelle zur Verfügung, auch wenn er nicht explizit in der Dokumentation aufgeführt ist. Diese Spalte enthält die Aktionsknöpfe, die du in der Liste TableActions definierst.
Der Wert Title¶
Mit dem optionalen Wert Title kannst du den Spaltentitel anpassen. Der Titel sollte kurz, prägnant und frei von Sonderzeichen sein.
Wird dieser Wert nicht angegeben, wird der standardmäßig in der Erweiterung definierte Titel verwendet.
Es wird empfohlen, diesen Wert nur dann zu setzen, wenn der voreingestellte Titel zu Missverständnissen führt.
Der Wert IsVisible¶
Mit dem optionalen Wert IsVisible kannst du festlegen, ob eine Spalte sichtbar ist. Dies ist nützlich, wenn du eine Spalte als Parameter für eine Aktion verwenden möchtest (siehe IsActionParameter), diese aber vor den Nutzern verbergen willst.
Setzt du den Wert auf
No, wird die Spalte verborgen.Lässt du den Wert weg oder setzt ihn auf
Yes, wird die Spalte angezeigt.
Die Spalte Actions kann nicht verborgen werden.
Der Wert IsActionParameter¶
Der optionale Wert IsActionParameter legt fest, ob die Werte der Spalte als Parameter für Aktionen genutzt werden sollen.
Setzt du den Wert auf
Yes, werden die Werte der Spalte als Parameter für die Aktionsknöpfe verwendet.Lässt du den Wert weg oder setzt ihn auf
No, werden die Werte der Spalte nicht als Parameter verwendet.
Die Spalte Actions kann nicht als Aktionsparameter genutzt werden.
Der Wert ActionParameterName¶
Mit dem optionalen Wert ActionParameterName kannst du einen benutzerdefinierten Namen für den Aktionsparameter festlegen. Der Name sollte kurz sein und darf nur Buchstaben, Zahlen sowie Bindestriche und Unterstriche enthalten.
Lässt du diesen Wert weg, wird der Bezeichner, den du bei Identifier angegeben hast, als Name für den Parameter verwendet.
Die Liste TableActions¶
Mit der Liste TableActions konfigurierst du einen oder mehrere Aktionsknöpfe, die in der Spalte Actions angezeigt werden.
Der Wert Label¶
Der Wert Label legt den Text fest, der auf dem Aktionsknopf angezeigt wird. Der Text sollte kurz und ohne Sonderzeichen sein.
Der Wert Arguments¶
Mit dem Wert Arguments definierst du zusätzliche Parameter, die bei der Ausführung der Aktion an das Programm übergeben werden. Die Parameter werden dabei durch Whitespace getrennt angegeben.
<Value name="Arguments">
arg1=value1
arg2=value2
arg3=value3
</Value>
Jeder Parameter wird durch ein Gleichzeichen (=) in Name und Wert aufgeteilt. Wichtig ist, dass innerhalb der Parameterdefinition keine Leerzeichen vorkommen dürfen.
Die Namen der Parameter dürfen die Buchstaben a-z, die Ziffern 0-9 sowie den Bindestrich - enthalten. Die Werte nach dem Gleichzeichen = dürfen ebenfalls keine Leerzeichen enthalten.
Obwohl zusätzliche Parameter optional sind, ist die Angabe des Wertes Arguments immer erforderlich. Falls du keine zusätzlichen Parameter verwenden möchtest, kannst du einfach einen leeren Wert Arguments konfigurieren.
Der Wert ProgramPath¶
Mit dem optionalen Wert ProgramPath kannst du ein alternatives Programm für den Aktionsknopf festlegen. Lässt du diesen Wert weg, wird das Programm verwendet, das du im Data Modul des Servers konfiguriert hast. Siehe dazu Das Daten Modul.
Trage hier immer den vollständigen Pfad zum Programm ein, ohne Anführungszeichen und ohne zusätzliche Parameter. Möchtest du dem Programm Parameter übergeben, konfigurierst du diese über den Wert Arguments.
Beachte, dass dieses Programm vom Raptor Client auf dem Computer des Anwenders gestartet wird. Daher muss der Pfad auf dem jeweiligen Computer zugänglich sein und der Anwender muss die erforderlichen Berechtigungen haben, um das Programm zu starten.
Tabellen im Raptor System¶
Im Raptor System gibt es zwei Formate für Tabellen: das interne Format und das Anzeigeformat. Während die Internen Tabellen alle Daten im Rohformat enthalten, ist die Tabellenansicht für die benutzerfreundliche Darstellung optimiert.
Interne Tabellen¶
Die Internen Tabellen dienen als Basis für automatische Systeme wie Filter, Skripte und das Expertensystem. Diese Systeme verlassen sich auf die festgelegten Strukturen und Rohdaten dieser Tabellen. Häufig enthalten die internen Tabellen auch redundante Spalten, die identische Daten in verschiedenen Formaten speichern, um unterschiedliche Anforderungen zu erfüllen.
Beim Export eines Objekts mit dem Raptor Client erhältst du einen Datensatz, der die internen Tabellen einschließt. Wenn du Skripte für Erweiterungen schreibst, bietet sich hier eine ideale Möglichkeit, die Struktur dieser internen Tabellen im Detail zu analysieren.
Tabellenansicht¶
Die Tabellenansicht wird speziell für die Darstellung im Raptor Client generiert. Diese Ansicht enthält ausschließlich die für den Benutzer relevanten Daten in einem übersichtlichen und lesbaren Format.
Die Tabellenansicht kann verlinkte Daten und Spalten mit Aktionsknöpfen enthalten, was die Interaktion für den Benutzer erleichtert. Aufgrund der dynamischen und benutzerorientierten Gestaltung ist dieses Format jedoch nicht für die Nutzung in Skripten oder Filtern geeignet.
Konvertierung der Daten¶
Die Tabellenansichten werden im Raptor System nicht dauerhaft gespeichert, sondern bei jeder Abfrage eines Objekts durch den Raptor Client automatisch erzeugt.
Die Konvertierung erfolgt durch eine „View“-Komponente innerhalb der jeweiligen Erweiterung. Bei jeder Abfrage wandelt diese Komponente die Rohdaten in ein lesbares Format für den Client um, einschließlich der Tabellen. Die Konvertierung kann durch die Erweiterung flexibel angepasst werden, um spezifische Anforderungen zu erfüllen.
Das folgende Beispiel zeigt die Konvertierung der Spalten einer internen Tabelle:
In diesem Beispiel bleibt die Spalte C unverändert, während Spalte A in ein anderes Format umgewandelt wird. Die Informationen aus den Spalten D, E und G werden kombiniert, um Parameter für den Aktionsknopf in der Spalte Actions zu erzeugen.
