Konfiguration

Die JSON-Ausgabe kann über das Systemobjekt #global.json konfiguriert werden.

formatVersion

$CMS_SET(#global.json.formatVersion, "1.1")$

Die zu verwendende Formatversion wird auf den angegebenen Wert gesetzt. Eine Formatversion legt die Struktur und die Attribute des erzeugten JSON fest. Wenn über FirstSpirit-Updates hinweg eine unveränderte JSON-Ausgabe benötigt wird, sollte die Format-Version explizit in den Projekteinstellungen unter „Globale Einstellungen“ gesetzt werden (siehe Projekteinstellungen (→Handbuch FirstSpirit SiteArchitect)).

Wenn die Formatversion nicht explizit eingestellt wird, dann wird immer die aktuelle JSON-Formatversion verwendet. Die Definition einer nicht unterstützten Formatversion führt zu einem Fehler.

prettyPrinting

$CMS_SET(#global.json.prettyPrinting, true)$

Schaltet das PrettyPrinting ein oder aus (Standard), wenn für den JSON-Ausgabekanal der JSON-Validator verwendet wird.

Wenn der Wert auf „false“ gesetzt ist, werden keine Leerzeichen verwendet, was es zur besten Option für den Datentransfer macht.

Wenn der Wert auf „true“ gesetzt ist, wird die Ausgabe für Menschen lesbarer gemacht, indem Einrückungen und andere Leerzeichen für die JSON-Ausgabe verwendet werden.

Die Einstellung kann auch mit JSON genutzt werden, das ohne die json() Funktion erzeugt wurde.

PrettyPrinting wird nur unterstützt, wenn für die Ausgabe von JSON der JSON-Validator genutzt wird.

sectionTemplateRendering

$CMS_SET(#global.json.sectionTemplateRendering, true)$

Schaltet das Template-Rendering für Absatzelemente ein oder aus (Standard).

Wenn der Wert auf „true“ gesetzt ist, wird die Vorlage jedes Absatzes ausgewertet und das Ergebnis der Vorlage ist die JSON-Ausgabe.

Wenn der Wert auf „false“ gesetzt ist, dann werden die Inhalte der Absätze automatisch zusammen mit den Inhalten der Seite ausgegeben. Die einzelnen Absatzvorlagen werden hierbei nicht ausgewertet.

metadataRendering: Metadaten ausgeben (Standardeinstellung: true)

Die JSON-Ausgabe von Metadaten kann über den Schalter $CMS_SET(#global.json.metaDataRendering, <BOOLEAN>)$ (Standardeinstellung: true) aktiviert bzw. deaktiviert werden.

$CMS_SET(#global.json.metaDataRendering, true)$

Mit der Einstellung $CMS_SET(#global.json.metaDataRendering, true)$ (Standardeinstellung) werden die Metadaten aller Objekte ausgegeben. Sind keine Metadaten gesetzt, so wird ein leeres Element ausgegeben.

$CMS_SET(#global.json.metaDataRendering, false)$

Mit der Einstellung $CMS_SET(#global.json.metaDataRendering, false)$ wird die JSON-Ausgabe von Metadaten explizit ausgeschaltet.

Weiterführende Informationen: siehe Dokumentation zur

• JSON-Ausgabe von Metadaten und
• JSON-Ausgabe von Benutzerrechten.

metaInheritanceRendering: Geerbte Metadaten ausgeben (Standardeinstellung: false)

Die JSON-Ausgabe von geerbten Metadaten kann über den Schalter $CMS_SET(#global.json.metaInheritanceRendering, <BOOLEAN>)$ (Standardeinstellung: false) aktiviert bzw. deaktiviert werden.

$CMS_SET(#global.json.metaInheritanceRendering, false)$

In der Standardeinstellung $CMS_SET(#global.json.metaInheritanceRendering, false)$ werden nur Metadaten ausgegeben, die auf dem Objekt selbst definiert wurden. Sind auf dem Objekt selber keine Metadaten definiert, wird über das Attribut metaFormData ein leerer Wert ausgegeben, auch dann, wenn das Objekt über geerbte Metadaten verfügt.

$CMS_SET(#global.json.metaInheritanceRendering, true)$

In der Einstellung $CMS_SET(#global.json.metaInheritanceRendering, true)$ werden Metadaten ausgegeben, die nicht auf dem FirstSpirit-Objekt selbst definiert wurden, sondern auf einem hierarchisch übergeordneten Objekt. Die geerbten Metadaten werden in eine JSON-Objektstruktur überführt. Dabei werden die zum jeweiligen Zeitpunkt gültigen Werte des nächsthöheren Objektes verwendet, für das die entsprechenden Metadaten definiert wurden (bis hin zum Wurzelknoten des Verwaltungsbereichs).

Änderungen an einem vererbenden Knoten führen nicht dazu, dass die erbenden Knoten als geändert angesehen werden. Wird die Vererbung der Metadaten aktiviert, so muss mit einem geeigneten Mechanismus dafür gesorgt werden, dass die Daten entsprechend aktualisiert werden.

Weiterführende Informationen: siehe Dokumentation zur

• JSON-Ausgabe von Metadaten und
• JSON-Ausgabe von Benutzerrechten.

dataRenderDepth

$CMS_SET(#global.json.dataRenderDepth, 1)$

Definiert, wieviele Ebenen bei der Ausgabe von Datensätzen ausgegeben werden sollen. Als Wert muss eine ganze Zahl übergeben werden.

Wert < 1 : Es wird nur eine Referenz auf den Datensatz ausgegeben.

Wert = 1 : Es wird der Datensatz ausgegeben und verknüpfte Datensätze werden als Referenz ausgegeben (Standard).

Wert >= 2 : Es wird der entsprechenden Anzahl an Fremdschlüsselbeziehungen gefolgt und die referenzierten Datensätze werden mit ausgegeben.
Hierbei ist zu beachten, dass die letzte Ebene nur als Referenz auf den entsprechenden Datensatz ausgegeben wird, für die darüberliegenden Ebenen wird auch der Inhalt der entsprechenden Datensätze ausgegeben.

Beispiel für eine entsprechende Referenz:

value": { 
    "fsType": "DatasetReference", 
    "target": { 
        "fsType": "Dataset", 
        "schema": "Referenzketten", 
        "entityType": "Target1", 
        "identifier": "b9aa57bd-9561-4667-ac7c-3b98510c9e57", 
    } 
}   

nonDisplayedSectionsRendering

$CMS_SET(#global.json.nonDisplayedSectionsRendering, true)$

Schaltet die Ausgabe von ausgeblendeten Absätzen ein oder aus (Standard).

Wenn der Wert auf „true“ gesetzt ist, werden auch ausgeblendete Absätze mit ausgegeben. Außerdem wird dann für jeden Absatz ein Attribut „displayed“ erzeugt, in dem die sprachabhängige Einstellung bezüglich der Ausgabe abgebildet wird.

Wenn der Wert auf „false“ gesetzt ist, dann werden ausgeblendete Absätze nicht mit ausgegeben. Das Attribut „displayed“ wird dann nicht erzeugt.

outputLengthLimit

Definiert eine Größenbeschränkung der zu erzeugenden JSON-Datei in Bytes (Standard-Wert: unbegrenzt).

Beispiel: Größenbeschränkung bei 15MB

$CMS_SET(#global.json.outputLengthLimit, 15728640)$

Wenn der eingestellte Wert überschritten wird, wird die Generierung des JSONs mit einer ERROR-Meldung abgebrochen.

Wenn eine Größenbeschränkung eingestellt ist und die Erstellung der JSON-Datei dadurch abgebrochen wird, ist die resultierende Datei nicht valide.