Objektkonfiguration

Für eine einheitliche Konfiguration der Felder in den angezeigten Objekten, nutzen neuere Erweiterungen die Raptor Objektkonfiguration. Diese Konfiguration ist eine festgelegte Struktur, welche 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. Jede Erweiterung kann aber zusätzliche Werte zu der hier beschriebenen Konfiguration hinzufügen - um beispielsweise betroffene Objekte noch spezifischer und nicht nur nach dem Typ zu selektieren.

In der Dokumentation der einzelnen Erweiterungen wird auf dieses Kapitel verwiesen, wenn es um die Objektkonfiguration geht. Daher sind die folgenden Beschreibungen allgemein gehalten und nicht auf eine spezifische Erweiterung bezogen. Detaillierte Informationen, wie beispielsweise welche Felder Konfiguriert werden können, findest du in der jeweiligen Erweiterungsdokumentation.

Funktionen

  • Auswahl welche Felder in einem Objekt angezeigt werden.

  • Konfigurierbare Reihenfolge und Abschnitte für jedes Feld.

  • Konfigurierbare Aktionsknöpfe hinter Textfeldern.

  • Aktionsknöpfe können Argumente aus allen Feldern eines Objekts beziehen.

Konfiguration

Die Objektkonfiguration besteht aus der Liste ObjectFields in der jeder einzelne Eintrag die Felder für einen bestimmten Objekttyp konfiguriert. Üblicherweise besteht ein solcher Eintrag mindestens aus dem Wert ObjektType, der definiert für welchen Objekttyp die Konfiguration gilt, und der Liste Fields mit den eigentlichen Definitionen der Felder.

Beispiel eines Konfigurationsschemas

Das folgende Konfigurationsschema zeigt die verschiedenen Werte, die für ein Objekt konfiguriert werden können:

Module

TableConfigurationExample

Complex list definition

Value

ObjectType

String

  • Must be one of this: User, Computer, All

Default Value:

All

List

Fields

Optional

Complex list definition

Value

Identifier

String

  • Maximum length: 64

  • Must match this regular expression: [A-Z][A-Za-z0-9]+

Value

Title

Optional

String

  • Must not be empty.

  • Maximum length: 64

  • Must match this regular expression: [^\p{Zl}\p{Zp}\p{C}]+

Value

Section

Optional

Integer

  • Must not be empty.

  • Minimum value: 1

  • Maximum value: 64

  • Must match this regular expression: [a-z]+

Value

OrderIndex

Optional

Integer

  • Minimum value: 1

  • Maximum value: 1000

Value

IsVisible

Optional

Boolean

Default Value:

Yes

List

Actions

Optional

Complex list definition

Value

Label

String

  • Must not be empty.

  • Maximum length: 64

Value

Arguments

StringList

Value

ProgramPath

Optional

String

Die Liste ObjectFields

Die Liste ObjectFields enthält die definitionen für verschiedene Objekttypen. Dabei funktionieren die Erweiterungen üblicherweise so, dass jeder Eintrag für einen Objekttyp die jeweilige Standardkonfiguration überschreibt. Lässt du also diese Liste leer, wird die Standardkonfiguration für alle Objekttypen verwendet.

Neben dem Wert ObjectType kann ein Eintrag in der Konfiguration der Erweiterung weitere Werte enthalten, welche beispielsweise den Typ des Objekts noch weiter einschränken.

Der Wert ObjectType

Mit dem Wert ObjectType definierst du in der Regel für welchen Objekttyp diese Konfiguration gilt. Neben den Objekttypen wie User und Computer, kann eine Erweiterung z.B. auch All unterstützen - womit du die gleichen Felder für alle Objekttypen definieren kannst.

Welche Objekttypen die spezifische Erweiterung unterstützt, siehst du in der Dokumentation dieser Erweiterung.

Die Liste Fields

Mit der Liste Fields definierst du welche Felder für das Objekt angezeigt werden, und in welcher Reihenfolge und in welchem Abschnitt das Feld sichtbar ist. Zudem kannst du für Textwerte Aktionsknöpfe definieren, die hinter dem Wert in dem Feld platziert werden.

Der Wert Identifier

Mit dem Wert Identifier wählst du das Feld aus, das mit den folgenden Werten konfiguriert wird. Jede Erweiterung bietet eine Liste von Feldern an die du Konfigurieren kannst. Diese Liste findest du in der Dokumentation der Erweiterung.

Der Wert Title

Der optionale Wert Title überschreibt den Titel des Feldes mit einem eigenen Text. Dabei darf der neue Titel maximal 64 Zeichen enthalten und darf keine Kontrollsequenzen oder Zeilenumbrüche enthalten.

Der Wert Section

Mit dem optionalen Wert Section platzierst du ein Feld in einem anderen Abschnitt. Hier darfst du maximal 64 Gross- oder Kleinbuchstaben verwenden ([a-zA-Z]+). Weitere Informationen wie dieser Abschnittsname im Client angezeigt wird, findest du im Abschnitt Der Wert SectionOrder der Konfiguration des Daten Moduls.

Der Wert OrderIndex

Mit dem optionalen Wert OrderIndex überschreibst du den Wert für die Reihenfolge in der dieses Feld angezeigt wird. Dabei musst du eine Zahl zwischen eins und 1000 angeben. Je kleiner diese Zahl, um so weiter oben wird das Feld angezeigt. Lässt du diesen Wert weg, wird die aktuelle Zahl der Standardreihenfolge verwendet.

Für die Standartreihenfolge wird für den ersten Eintrag 100 verwendet und dieser für jedes weitere konfigurierte Feld um eins erhöht. Setzt du mit OrderIndex einen eigenen Reihenfolgenindex, ändert dies nichts an der Standardnummerierung der anderen Felder.

Die folgende Illustration zeigt ein Beispiel wie die Reihenfolgeindex der Felder die Reihenfolge innerhalb jedes Abschnitts definieren.

../../_images/raptor-client-value-order.jpg

Die Reihenfolgeindexe definieren die Reihenfolge der Felder im Client

Der Wert IsVisible

Mit dem optionalen Wert IsVisible kannst du einzelne Felder ausblenden. Lässt du diesen Wert weg, wird ein Konfiguriertes Feld angezeigt.

Erweiterungen können Standardfelder definieren, welche in jeder Konfiguration angezeigt werden. Mit diesem Wert kannst du diese zwar nicht entfernen, aber ausblenden.

In gewissen Erweiterungen ist es auch so, dass Felder welche nicht konfiguriert werden, auch nicht zu den internen Daten hinzugefügt werden und du diese so auch nicht in Aktionsknöpfen verwenden kannst. In solchen Erweiterungen kann es daher Sinn machen, ein Feld zu konfigurieren, dieses aber auszublenden, so dass die Daten trotzdem verfügbar sind.

Die Liste Actions

Mit der optionalen Liste Actions definierst du Aktionsknöpfe, welche hinter Textwerten im Client angezeigt werden. Falls du Aktionsknöpfe für Tabellen oder Datum/Zeitwerte konfigurierst, führt dies zu einem Konfigurationsfehler. Jeder Eintrag in dieser Liste fügt einen einzelnen Aktionsknopf dem Feld hinzu.

Der Wert Label

Mit dem Wert Label Konfigurierst du den Text der auf dem Aktionsknopf angezeigt wird. Dieser Text darf aus Maximal 64 Zeichen bestehen und keine Kontrollsequenzen oder Zeilenumbrüche enthalten.

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. Verwendest du nur einen namen, wie arg1 ohne ein Gleichzeichen, wird daraus ein Flag in der form --arg1 erstellt.

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.

Innerhalb dieser Argumentliste kannst du Platzhalter verwenden:

  • {obj:name} wird durch den Namen des aktuellen Objekts ersetzt.

  • {obj:type} wird durch den Typ des aktuellen Objekts ersetzt.

  • {obj:context} wird durch den Kontext des aktuellen Objekts ersetzt.

  • {value} wird durch den Wert des Feldes ersetzt für dass du diese Aktion definierst. Der Text in diesem Feld wird dabei von Sonderzeichen befreit und Leerzeichen durch den Unterstrich _ ersetzt.

  • {value:[name]} wird durch den Wert [name] der Daten der aktuellen Erweiterung ersetzt. Genau wie bei {value} werden Sonderzeichen und Leerzeichen entfernt.

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.