Verwendung von FirstSpirit CaaS

Für die Kommunikation mit FirstSpirit CaaS wird das Modul FirstSpirit CaaS Connect verwendet (auch: „CaaS v3“ / CaaS-Modul ab Version 3). Es stellt das Bindeglied zwischen FirstSpirit und der ausliefernden CaaS-Plattform dar und unterstützt die Übertragung von Fragmenten Out-of-the-box.
Siehe dazu folgende Dokumentationen:

• allgemeine Produkt-Dokumentation
• CaaS Connect
• CaaS Platform (nur relevant für On-premises-Kunden)

Wird hingegen die Vorgängerversion von FirstSpirit CaaS verwendet („CaaS v2“ / CaaS-Modul in einer Version 2.x), muss das auf dieser Seite beschriebene Modul „CaaS Integration“ verwendet werden, um die Inhalte eines Fragment-Projekts über FirstSpirit CaaS veröffentlichen zu können.

CaaS v2 ist veraltet und sollte nur noch in Migrationskontexten verwendet werden. Für eine Verwendung von FirstSpirit CXT mit FirstSpirit CaaS v3 ist das Modul „CaaS Integration“ nicht erforderlich.

Modul "CaaS Integration"

Funktionsweise

Bei einer Veröffentlichung werden Inhalte aus dem Fragment-Projekt automatisch

• bei jeder Änderung: in eine CaaS-Instanz ausgespielt (Preview).
• bei jeder Freigabe: in eine weitere CaaS-Instanz ausgespielt (Live).

Neben dieser Event-basierten Übertragung der Inhalte ist es auch möglich, die gesamten Inhalte eines Fragment-Projekts direkt über FirstSpirit CaaS zu veröffentlichen (siehe Veröffentlichung über einen Auftrag).

Modul-Datei

caas-integration-[version].fsm

Installieren des Moduls

Das Modul wird über den FirstSpirit ServerManager installiert, und zwar im Dialog „Servereigenschaften / Module“ über die Schaltfläche „Installieren“:

(Zu weiteren Informationen zur Installation von Modulen siehe auch Module (→Dokumentation für Administratoren).)

Starten des Dienstes "CXT CaaS Integration Service"

Das Modul „CaaS Integration“ beinhaltet den Dienst „CXT CaaS Integration Service“. Nach der Installation wird ein Dialog angezeigt, mit dem die Autostart-Option für den Dienst konfiguriert werden kann. Wird der Dialog mit „Ja“ bestätigt, wird der Dienst bei jedem Neustart des Servers automatisch gestartet.

Der Dienst kann auch zu einem späteren Zeitpunkt über die Schaltflächen „Dienst starten“ bzw. „Autostart aktivieren“ gestartet werden:

Konfiguration

Die Konfiguration von CaaS Integration erfolgt auf Projektebene. Soll ein Fragment-Projekt seine Inhalte über FirstSpirit CaaS v2 zur Verfügung stellen, muss für jedes Fragment-Projekt die Projekt-Komponente „CXT CaaS Integration Configuration“ konfiguriert werden.

Zunächst muss die Projekt-Komponente „CXT CaaS Integration Configuration“ dem Projekt im ServerManager über „Projekteigenschaften / Projekt-Komponenten“ hinzugefügt werden.

Zu allgemeinen Informationen zur Konfiguration von Projekt-Komponenten siehe Projekt-Komponenten (→Dokumentation für Administratoren).

Die Projekt-Komponente „CXT CaaS Integration Configuration“ stellt eine Konfigurationsoberfläche zur Verfügung.
Sie wird im ServerManager über „Projekteigenschaften / Projekt-Komponenten / Konfigurieren“ bzw. Doppelklick auf die Projekt-Komponente geöffnet:

Register:

LIVE: Die Inhalte aus dem Fragment-Projekt werden bei jeder Freigabe in die hier konfigurierte CaaS-Instanz ausgespielt.

PREVIEW: Die Inhalte aus dem Fragment-Projekt werden bei jeder Änderung in die hier konfigurierte CaaS-Instanz ausgespielt.

Parameter:

URL: URL zur CaaS-Instanz.

PROXY_URI: Angabe einer Proxy-Adresse, über den die CaaS-Verbindung aufgebaut wird. Bleibt das Feld leer oder bei Eingabe von Leerzeichen wird kein Proxy verwendet.

COLLECTION_NAME: Angabe eines Namens für die Collection, in die die Inhalte übertragen werden sollen.
Bleibt dieses Feld leer, wird der Referenzname der jeweiligen Seitenvorlage verwendet (Fragment-Typ, siehe Fragment-Typen definieren).

API_KEY: Angabe eines CaaS-API-Keys (siehe Dokumentation zur CaaS Platform bzw. allgemeine Cloud-Informationen).

Der konfigurierte API_Key muss schreibenden (und lesenden) Zugriff ermöglichen.

URL_CREATOR: Auswahl des gewünschten URL-Creators.
Bei Verwendung des FirstSpirit-Moduls CaaS v2 kann in der Regel der vom Modul mitgelieferte „CaaS URL Creator“ ausgewählt werden. Dieser erzeugt URLs, die die speziellen Anforderungen an CaaS-URLs erfüllt. Alternativ können auch eigene URL-Creator implementiert und hier ausgewählt werden. Siehe dazu auch Generierung (→Online Dokumentation FirstSpirit).
Wird keine Auswahl vorgenommen, wird für alle Instanzen (Preview und Live) der URL-Creator „Preview URLs“ verwendet.

Veröffentlichung über einen Auftrag

Neben der Event-basierten Übertragung einzelner Inhalte aus einem Fragment-Projekt (bei einer Änderung oder einer Freigabe), können die gesamten Inhalte eines Fragment-Projekts auch über ein Auftrags-Skript veröffentlicht werden.

Dafür stehen zwei Executables (für die Bereitstellung auf dem Live-CaaS-Server und dem Preview-CaaS-Server) zur Verfügung:

• cxt-caas-integration-full-live-deployment-executable 
  (stellt alle freigegebenen Inhalte bereit)
• cxt-caas-integration-full-preview-deployment-executable 
  (stellt alle geänderten Inhalte bereit)

Die Bereitstellung auf den beiden CaaS-Instanzen wird über separate Aufträge ausgeführt.

Dazu wird in der Auftragsverwaltung jeweils ein neuer Standard-Auftrag angelegt: Über „Hinzufügen / Standard-Auftrag anlegen“. Anschließend wird innerhalb des Auftrags im Register „Aktion“ eine neue Aktion erstellt: „Hinzufügen / Skript ausführen / Übernehmen“.

Dem Skript wird die entsprechende Executable hinzugefügt.

Für die Bereitstellung der Projektinhalte auf dem Preview-CaaS-Server:

#!executable-class
cxt-caas-integration-full-preview-deployment-executable

oder für die Bereitstellung der Projektinhalte auf dem Live-CaaS-Server:

#!executable-class
cxt-caas-integration-full-live-deployment-executable

Beim Ausführen des Auftrags werden die Projektinhalte aus dem Fragment-Projekt zur Veröffentlichung auf dem konfigurierten CaaS-Server bereitgestellt.

Ausgabe über JSON

Zum Austausch von Fragmenten zwischen FirstSpirit-CXT und FirstSpirit CaaS wird JSON (JavaScript Object Notation) verwendet. Der Ausgabekanal des Projekts muss entsprechend angepasst werden. Siehe dazu Standardisierte JSON-Ausgabe (→Online Dokumentation FirstSpirit) und Unterstützung für JSON (→Dokumentation für Administratoren).

Beispiel zur Ausgabe von Fragmenten / Varianten über JSON:

{
  "fragmentUUid": "$CMS_VALUE(#global.page.parent.uid.replaceAll("_","-"))$",
  "documentUUid": "$CMS_VALUE(#global.page.uid.replaceAll("_","-"))$",
  "variation": $CMS_VALUE(#global.page.meta("variations").toJSON())$,
  "title": $CMS_VALUE(#global.page.meta("title").toJSON())$,
  "text": $CMS_VALUE(text.toHtml().toJSON())$,
  "url": "$CMS_VALUE(url)$"
}