Introducing CXT
Introducing CXT

Introducing CXT / Projekte / CaaS konfigurieren

Fragmente über FirstSpirit CaaS veröffentlichen

Inhaltsverzeichnis

Der Aufwand, Inhalte für immer neue Kanäle und Geräte zu adaptieren, entfällt im Zusammenspiel mit FirstSpirit CaaS. Über die universelle CaaS-Schnittstelle können Fragmente und Varianten (aus dem FragmentCreator) von beliebigen Frontends angezogen werden (Pull-Prinzip – Extern fragt bei FirstSpirit nach Inhalten). Damit wird jede App erreicht, die sich per Schnittstelle ansteuern lässt. Die Inhalte können (über FirstSpirit CaaS) flexibel verteilt werden, sowohl auf unternehmenseigener Ebene als auch für die Kanäle von Drittanbietern.

Checkliste

Folgende Komponenten bzw. Konfigurationen sind erforderlich, wenn Sie die auf dieser Seite beschriebene Funktionalität nutzen möchten:

 

Typ

Was?

Wo?

weitergehende Information

Modul

FragmentCreator

Servereigenschaften – Module

siehe FirstSpirit CXT FragmentCreator

Modul

FragmentCreator - Caas Integration

Servereigenschaften – Module

siehe FirstSpirit CXT CaaS Bridge / Integration

Dienst

CXT CaaS Integration Service

Servereigenschaften – Module

siehe Starten des Dienstes "CXT CaaS Integration Service"

Modul

Content as a Service

Servereigenschaften – Module

siehe Dokumentation "Content as a Service with Docker"

Dienst

CaaS Service

Servereigenschaften – Module

siehe Dokumentation "Content as a Service with Docker"

Projekt-Komponente

CXT CaaS Integration Configuration

Projekteigenschaften – Projekt-Komponenten

siehe Konfiguration der Projekt-Komponente

     

Konfiguration der Projekt-Komponente

Die Konfiguration von CaaS Integration erfolgt auf Projektebene. Soll ein Fragment-Projekt seine Inhalte über FirstSpirit CaaS 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. Der Key wird über das „CaaS Admin Interface“ bereitgestellt (siehe https://docs.e-spirit.com/caas/#createkey).

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

URL_CREATOR: Auswahl des gewünschten URL-Creators.
Bei Verwendung des FirstSpirit-Moduls Content as a Service 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)$"
}

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-11 | Datenschutz | Impressum | Kontakt