Anwenderhandbuch › Berichte › Berichtstypen › Booklets-Übersicht › Erstellen eines Booklets › Erstellen von Booklets im Format "RTF" › Tags für Booklets und Vertragsexport › Parametrierte Booklets › Syntax der Booklet-Parameter
Syntax der Booklet-Parameter
Die Syntax der Booklet-Vorlage gleicht der für die Parameterübergabe an Freiform-Berichte.
Hinweise zur Syntax:
- Der Parametername kann nicht beliebig festgelegt werden, sondern wird aus einer Liste vordefinierter Namen (in GROSSBUCHSTABEN) ausgewählt (Ausnahme: Freiformparameter können beliebig benannt werden).
- Der Parameterwert ist entweder Freitext (Schlüsselwort VALUE) oder ein Kontextwert (Schlüsselwort CONTEXT_VALUE). Wenn kein Vertragskontext vorliegt, werden Kontextwerte nicht übergeben.
- Beim Wert werden Groß- und Kleinschreibung berücksichtigt.
- Wenn für einen Parameter mehrere Werte übergeben werden und der Parameter nicht als Mehrfachauswahl definiert ist, oder wenn ein Parameter mehrmals übergeben wird, wird der in der Vorlage zuletzt genannte Wert übergeben.
- Wenn kein Wert übergeben wird (weil das Schlüsselwort VALUE oder <<VALUE=>> fehlt), übergibt das Booklet einen Nullwert. Dadurch wird der ursprüngliche Filterwert entfernt, als sei er im bevorzugten Bericht nicht enthalten (ähnlich wie "Alle").
- Die Übergabe eines nicht vorhandenen Parameternamens hat keinerlei Auswirkungen (dies ist bei Freiformparametern in einer Gruppe wichtig).
- Wenn die Booklet-Parameter Vorrang gegenüber dem ursprünglichen Filter haben, werden die Parameterwerte mit dem ursprünglichen bevorzugten Filter zusammengeführt. Wenn also ein Parameter an einen im Bericht bereits vorhandenen Filter übergeben wird, verwendet der Filter den Parameter aus dem Booklet.
- Wenn eine Mehrfachauswahl oder ein Platzhalter angegeben wird, muss das Schlüsselwort SELECT_TYPE in der Deklaration verwendet werden. Mögliche Werte: MULTI, WILDCARD und SINGLE (bei fehlender Definition ist der Standardwert SINGLE)
- Mehrfachauswahl von Ressourcen und Ressourcengruppen: Derzeit können Sie nur einen Typ auswählen, also entweder Ressourcen oder Ressourcengruppen. Dabei müssen Sie mit dem Schlüsselbegriff IS_GROUP angeben, welchen Typ Sie im Parameter verwendet haben. Mögliche Werte sind YES und NO (bei fehlender Definition ist der Standardwert NO).
- Beim Definieren einer Mehrfachauswahl müssen Sie den vollständigen Pfad der Einheit angeben, wobei Sie als Trennzeichen Schrägstriche verwenden (siehe nachstehendes Syntaxbeispiel Booklet-Parameter). Wenn Sie mehrere Metriken auswählen und einen Vertragskontext definiert haben, können Sie die Pfadangabe überspringen. Die relevanten Informationen werden dann dem Vertragskontext entnommen.
- Kombinierte und Gruppenfavoriten haben dieselbe Syntax wie normale. Bei Kombiberichten werden die Parameterwerte an alle Reihen übergeben. In Gruppenberichten wird jedem Gruppenelement ein Wert übergeben (ebenso in Freiform-Berichten). Wenn die Gruppe Kombiberichte enthält, werden die Parameter an alle Reihen in allen Elementen übergeben.
Beispiel für die Syntax von Booklet-Parametern
<<BEGIN_FAVORITE=Normal favorite name>>
<<BEGIN_PARAMETER>>
<<NAME=AGGREGATION>><<VALUE=Sum>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=CONTRACT>><<CONTEXT_VALUE=SLA_NAME>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=SERVICE>><<VALUE=Service 1>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=RESOURCE>><<IS_GROUP=NO>><<VALUE=Resource 1>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=metric >>
<<SELECT_TYPE=MULTI>>
<<VALUE=Contract Party/Contract/metric 1>>
<<VALUE=Contract Party/Contract/metric 2>>
<<VALUE=Contract Party/Contract/metric 3>>
<<END_PARAMETER>>
<<NAME>>
<<CHART>>
<<DATA>>
<< END_FAVORITE>>