Im Abfrageeditor wird durch Erfassen von einem oder mehr Abfrageknoten ein Abfragebaum erstellt. Dieser muss in einem eindeutigen Zielknoten enden.
Jeder Knoten liefert eine Ergebnistabelle, die in den nachfolgenden Knoten verwendet werden kann.

 

 

 

Übersicht

Folgende Abfrageknoten können definiert werden:

• SapQuery
• SapFunction
• ClientQuery
• Call
• Cache
• FirstWithResult
• TransformXML

Jedem Knoten muss dabei immer eine eindeutige ID vergeben werden.

 

Eingabeformat

Die Eingabe im Abfrageeditor muss im YAML-Format erfolgen.
YAML ist eine maschinell lesbare Auszeichnungssprache, die aber mit Schwerpunkt auf menschliche Lesbarkeit konzipiert wurde. Sie ist aber auch gleichzeitig eine Übermenge von JSON und akzeptiert somit auch dieses Format.

 

Knotentyp:

Zur Abgrenzung von verschiedenen Knoten und zur Spezifikation ihres Typs wird der Dokumententrenner  ‘– – –’ gefolgt von einem primären Tag (beginnend mit einem Ausrufezeichen “!”).
In diesem Beispiel wird angezeigt, dass die nachfolgenden Zeilen einen SapQuery -Knoten definieren.

--- !SapQuery

 

Eigenschaften:

Die Eigenschaften eines Knotens werden als Mapping definiert. Ein Mapping besteht aus Schlüssel-Wertpaaren getrennt durch einen Doppelpunkt “:”.

Key: Value

 

Werte können Texte (Zeichenketten), andere Skalare aber auch Listen bzw. weitere Mappings sein. Textwerte können auch über mehrere Zeilen definiert werden. Die nachfolgenden Zeilen müssen dann durch Leerzeichen eingerückt sein. Zeilenumbrüche werden dabei nicht als Teil des Wertes interpretiert.

Key: Value
  defined over
  multiple lines
List:
  - Value1
  - Value2
BaseKey:
  SubKey:
    Key1: Value
    Key2: Value

 

Da YAML eine Übermenge von JSON ist, können Listen und Unterstrukturen auch in JSON-Notation angegeben werden. Das obige Beispiel lässt sich alternativ somit auch folgendermaßen formulieren.

List: [Value1, Value2]
BaseKey: {SubKey: {Key1: Value, Key2: Value}}

 

Texte können auch mit doppelten und einfachen Anführungszeichen angegeben werden, wenn diese YAML-Sonderzeichen beinhalten.

Path1: 'c:FolderFile'
Path2: "c:\Folder\File"

Die YAML-Dokumentation hat eine Auflistung an Steuerungszeichen, die in Zitatform verwendet werden sollten oder nur, wenn in einem Textwert verwendet, eindeutig Teil des Textes sind. Insbesondere beim Sternchen “*” ist dies zu beachten:

Select: *
Note: Die Datei ist auf c: zu finden

Der Teil “c:” könnte als Mapping interpretiert werden und ist deshalb nicht gültig.

 

Select: '*'
Note: 'Die Datei ist auf c: zu finden'
Statement: SELECT * FROM Table

Da das Sternchen im Wert von Statement in der Mitte vorkommt, wird es hier korrekt als Teil des Textes erkannt.

 

Kommentare können durch eine Raute “#” gekennzeichnet werden. Diese werden von einem Schlüssel oder Wert durch Leerzeichen getrennt.

# Gültiger Kommentar
Key: # Kommentar vor dem Wert
  Value
  # Kommentar nach dem Wert

Ein Kommentar kann somit am Anfang oder am Ende eines Wertes stehen, nicht jedoch dazwischen.

InvalidComment: A value
  containing a # character
  is invalid