Allgemeine Konfigurationseigenschaften
Einige Konfigurationseigenschaften können an mehreren Stellen in der Konfiguration mit gleichen Werteausprägungen oder gleicher Objektstruktur verwendet werden. Diese Konfigurationseigenschaften sind in diesem Abschnitt zentral dokumentiert.
Folgende Konventionen gelten für alle Konfigurationseigenschaften, die in dieser Dokumentation aufgeführt sind:
Wenn nicht explizit ein konkreter Datentyp wie "Wahrheitswert" oder "Zahlenwert" im Beschreibungstext aufgeführt ist, sind String-Werte für die Eigenschaften anzugeben. Das gilt auch für Aufzählungswerte aus einem fest vorgegebenen Satz alphanumerischer Werteausprägungen.
Bei Eigenschaften, deren Wert sich aus mehreren kommaseparierten Einzelparametern zusammensetzt, sind diese Parameter in genau der Reihenfolge beschrieben, in der diese angegeben werden müssen. Zusätzlich ist deren optional verwendbarer Name aufgeführt. Wenn Einzelparameter verpflichtend anzugeben sind, ist dies durch ein Stern (*) am Parameternamen gekennzeichnet.
Die folgenden Symbole werden verwendet, um die Merkmale von Eigenschaften zu kennzeichnen:
Symbol
Beschreibung
*
(*)
Stern
Für Werte, die verpflichtend anzugeben sind, ist die Eigenschaft mit einem abschließenden * gekennzeichnet.
Die Eigenschaft ist mit einem (*) gekennzeichnet, wenn die Verpflichtung nur bedingt gilt, z. B. in Abhängigkeit von einer anderen Eigenschaft. Bei untergeordneten Eigenschaften ist die Pflichtangabe nur relevant, wenn die übergeordnete Eigenschaft überhaupt gesetzt ist.
Hinweis
Ein Großteil der Eigenschaften, die zwingend einen Wert benötigen, ist mit einem Standardwert vorbelegt. Der Standardwert wird im Beschreibungstext genannt. Für solche Eigenschaften entfällt die explizite Kennzeichnung als Pflichtwert.
(§)
Paragrafenzeichen
Wenn eine Eigenschaft die Verwendung eines verschlüsselten Wertes oder Teilwertes in der Syntax
<§>…</§>unterstützt, ist dies durch ein der Eigenschaft angefügtes (§) gekennzeichnet.(#)
Rautezeichen
Wenn eine Eigenschaft die Verwendung einer hexadezimalen Zeichenfolge in der Syntax
<#>…</#>unterstützt, ist dies durch ein der Eigenschaft angefügtes (#) gekennzeichnet.(%)
Prozentzeichen
Einige Eigenschaften in Szenariokonfigurationen erlauben die Verwendung dynamischer Werte oder dynamischer Teilwerte in Form von Variablen mit dem Platzhalter
%Variablenname%. Der Platzhalter wird zur Laufzeit durch den Wert der betreffenden Variable ersetzt. Das gilt nicht pauschal für alle Eigenschaften, sondern nur, wenn eine Eigenschaft durch ein angefügtes (%) gekennzeichnet ist.Bei Eigenschaftswerten, die einen Makroausdruck darstellen, der im Kontext eines Dokumentes ausgeführt wird, ist bereits standardmäßig die Verwendung dokumentbezogener Variablen vorgesehen. Dort entfällt daher die explizite Kennzeichnung.
.
Punkt
Der Pfad einer Konfigurationseigenschaft wird nicht immer vollständig genannt. In einigen Fällen wird nur der hintere Teil des Pfades genannt. In diesem Fall wird dem Pfad ein Punkt vorangestellt, um zu kennzeichnen, dass dies ein Unterpfad ist, dem im konkreten Anwendungsfall noch ein übergeordneter Pfadanteil vorangestellt werden muss.
Dieses kommt bei der Beschreibung allgemeiner Eigenschaften vor, die in verschiedenen Kontexten mit unterschiedlichen Namen übergeordneter Eigenschaften zum Einsatz kommen können. Außerdem wird dieses als abkürzende Schreibweise genutzt, wenn aus dem Kontext hervorgeht, auf welche übergeordnete Eigenschaft sich eine untergeordnete Eigenschaft bezieht.
{}
geschweifte Klammern
Wenn in der Syntaxbeschreibung eines Konfigurationswertes ein Ausdruck oder ein Teil-Ausdruck in geschweiften Klammern enthalten ist, d.h. in der Form
{Wert}, kennzeichnen diese Klammern einen kontextabhängig variierenden Wert.Die geschweiften Klammern sind nicht als Teil des konkreten Konfigurationswertes mit anzugeben.
""
Anführungszeichen
Anführungszeichen, die Teil der Syntax eines Wertes sind, werden immer in der Form
"…"geschrieben. Diese Art des Anführungszeichens mit dem Dezimalcode 34 (oder hexadezimal 22) ist auch in den Konfigurationsdaten zu verwenden.