2.4.2 MultiData

Um einen Export zu erstellen, welcher später über die Rest API abgerufen werden soll, muss man einen Export in CPL24 anlegen. Hierzu klickt man in der Menü Bar auf Systemdaten > Export > Exporte. In dieser CPL24 Maske kann man zusätzlich zu den Exporten über die API auch die MultiData Standard Exporte bereitstellen. Hierzu wird auf die Doku von MultiData Mulaidate Dokumentation. Nun öffnet sich die Eingabe Maske von CPL 24. Hier können Sie die Parameter für Ihren Export eingeben. Die URL der Rest API besitzt folgende Pflicht und Optionale Parameter:

[yourhostname]/api/export/[connection]/[username]/[password]/[mandator]/[exportname]
/[format]/[parameter1]/[parameter2]/[parameter3]/[parameter4]/[parameter5]/

  • connection: Hier muss man den Connectioname, wie oben beschrieben, angeben.
  • username: Der CPL24 Username für den Login. Verwende Username "Basic"für den Basic Login
  • password: Das CPL24 Passwort des Users. Verwende das Passwort "Basic"für den Basic Login
  • mandator: Die Mandanten ID der CPL24 Instanz, aus der man abfragen möchte
  • exportname: die Exp_id wie im folgenden beschrieben.
  • format: Das Format in dem der Export ausgegeben werden soll. Zur Verfügung stehen xml, json, xsd, csv und plain
  • parameter1-5: Die Parameter sind optional und müssen in der selben Reihenfolge wie sie in der SQL Abfrage benötigt werden gesetzt werden.

Die Exp_id in der View2.16 ist der exportname in der URL. Mit der Checkbox anzeigen, hat man die Möglichkeit den Export zur Verfügung zu stellen (checked) oder noch im Designmodus zu halten. Die Felder Bezeichnung1 und 2 sind freie Textfelder deinen Export genauer zu beschreiben. Die restlichen Felder im Parent Bereich sind für den API Export nicht relevant (jedoch für den Multidata Standard Export).


PIC

Abbildung 2.16: MultiData Export View


Im Child Bereich hast du die Möglichkeiten den SQL Code einzugeben, Berechtigungen für deinen Export zu setzen und in den Notizen verschiedene Parameter (Key Value) anzugeben. Um ein dynamisches SQL Statement, welches eines oder mehrere Parameter aus der URL verwendet, zu erstellen ist die Syntax (<$Pm([DATENTYPE[:VALUE]]):[PARAMETERTEXT]$>) wie im Beispiel angegeben zu beachten. Hierzu noch ein Verweis auf die Multidata Dokumentation.

Unter dem Reiter Berechtigungen kannst du Usergruppen oder einzelnen Usern Berechtigungen setzen. Es ist nur eine Leseberechtigung möglich. Mit der Checkbox entziehen kann man die Rechte wieder entfernen. Per Default ist es allen Usern erlaubt den Export auszuführen.

Unter dem Reiter Notiz2.17 kannst du verschiedene Key Value Pairs angeben, welche von der API ausgelesen und interpretiert werden.


PIC

Abbildung 2.17: MultiData Export View Notizen


Verfügbare Keys und Datentypen:

  • RESTAPI: [bool]
  • ENCODING: [string]
  • MIMETYPE: [string]
  • ROW: [string]
  • ROOT: [string]

ACHTUNG: pro Key Value eine Zeile verwenden. Nicht mehrere Values auf einen Key binden.