1. Einleitung

Das CaaS-Modul ist die Komponente, die auf dem FirstSpirit-Server betrieben wird. Es ermöglicht die Zusammenstellung und den Versand von Informationen an die CaaS-Plattform. Die Informationen betreffen alle neuen, geänderten oder gelöschten redaktionellen Inhalte des verwendeten FirstSpirit-Projekts.

Neben der Verarbeitung des Freigabe-Standes besteht zudem die Möglichkeit, eine Vorschau der nicht freigebenen Inhalte zu realisieren. Diese kann mithilfe eines sogenannten Preview-CaaS abgebildet werden.

2. Technische Voraussetzungen

Für die Verwendung des CaaS-Moduls muss eine installierte und konfigurierte CaaS-Plattform vorhanden sein. Außerdem erfordert der Einsatz des CaaS-Moduls eine gültige CaaS-Lizenz.

Eine fehlende bzw. ungültige CaaS-Lizenz bricht jede CaaS-Generierung mit einer Fehlermeldung ab.

Manipulationen an der Lizenz machen diese ungültig. Sollten Änderungen notwendig werden, wenden Sie sich bitte an den Technical Support.

Für die Systemvoraussetzungen konsultieren Sie bitte das technische Datenblatt des CaaS-Moduls .

3. Installation und Konfiguration

Um die Daten eines FirstSpirit-Projekts so zusammenzufassen, dass sie für die CaaS-Plattform verarbeitbar sind, müssen verschiedene FirstSpirit-Komponenten installiert sowie konfiguriert werden. Die dafür notwendigen Schritte werden in den nachfolgenden Unterkapiteln erläutert.

3.1. Installation des Moduls

Das Modul muss mithilfe der mitgelieferten caas-2.12.27.fsm-Datei auf dem FirstSpirit-Server hinzugefügt werden. Öffnen Sie dafür den ServerManager und wählen Sie den Bereich Server-Eigenschaften  Module.

modules
Abbildung 1. Module

Im Hauptpanel ist eine Liste aller auf dem FirstSpirit-Server installierten Module zu sehen. Wählen Sie nach dem Klicken auf Installieren die caas-2.12.27.fsm-Datei aus und bestätigen Sie die Auswahl mit Öffnen.

Ist die Verwendung des CaaS nicht lizenziert, erscheint bei der Installation des CaaS-Moduls eine Fehlermeldung. Sie weist jedoch lediglich auf die ungültige Lizenz hin, ohne die Installation zu verhindern bzw. abzubrechen.

Nach der erfolgreichen Installation wurden der Liste der Ordner Content as a Service hinzugefügt, der Alle Rechte über den Button Konfigurieren erhalten muss (siehe Abbildung Module).

Das Modul erfordert darüber hinaus eine Konfiguration, die im nachfolgenden Unterkapitel erläutert wird.

Nach jeder Installation oder Aktualisierung eines Moduls ist ein Neustart des FirstSpirit-Servers notwendig.

3.1.1. Konfiguration des CaaS-Service

Für die Übertragung der Daten in die CaaS-Plattform wird eine Verbindung zwischen dieser und dem FirstSpirit-Server benötigt. Dafür ist im Service des Moduls eine Standardkonfiguration anzugeben. Soll abweichend von dieser Standardkonfiguration eine andere CaaS-Instanz befüllt werden, kann diese im Generierungsauftrag definiert werden.

Öffnen Sie für die Standardkonfiguration den ServerManager und wählen Sie den Bereich Server-Eigenschaften  Module. Klappen Sie anschließend den Ordner Content as a Service auf und selektieren Sie anschließend den in diesem Ordner enthaltenen Service (vgl. Abbildung CaaS Service).

c service
Abbildung 2. CaaS Service

Der sich über den Button Konfigurieren öffnende Dialog besitzt vier Felder, die wie nachfolgend beschrieben zu füllen sind.

service
Abbildung 3. CaaS Service - Konfiguration
URL der REST API

In diesem Feld ist die URL einzutragen, unter der die REST-Schnittstelle der CaaS-Plattform erreichbar ist. Diese ergibt sich während der Installation und Konfiguration der CaaS-Plattform aus der verwendeten Netzwerkkonfiguration.

API Key

An dieser Stelle wird ein API Key benötigt, der Schreibrechte für alle CaaS-Projekte besitzt. Alternativ kann der Master API Key benutzt werden. Weitere Informationen zur Anlage von API Keys finden Sie in der CaaS-Plattform-Dokumentation.

Proxy-URI (optional)

Für den Fall, dass die REST-Schnittstelle nur über einen Proxy-Server erreichbar ist, muss dessen URI an dieser Stelle angegeben werden. Andernfalls kann dieses Feld leer gelassen werden.

Parallelität für Mediengenerierung

Der nummerische Wert in diesem Feld gibt die Anzahl der maximal gleichzeitig verarbeiteten Medien an. Diese Einstellung ist serverweit gültig. Sie wird also nicht pro Auftrag ausgewertet, das bedeutet, alle Aufträge eines Servers teilen sich gleichzeitig diese Beschränkung. Standardmäßig ist an dieser Stelle bereits ein Wert von 8 definiert, der für die meisten Situationen ausreichend ist und daher keine Anpassung benötigt.

Dennoch kann eine Anpassung beispielsweise in folgenden Szenarien hilfreich sein:

  • hoher, FirstSpirit-seitiger Speicherverbrauch
    Bei der FirstSpirit-seitigen Verarbeitung benötigt jedes Medium mindestens den Speicher, den es auf der Festplatte verbraucht. Daher kann eine Generierung, die sehr viele, große Medien enthält, ein begrenzender Faktor für die gleichzeitig zu verarbeitenden Medien sein. Im Fall von Speicherproblemen kann eine Verringerung des Werts zu einem geringeren Speicherverbrauch führen. Der kleinste erlaubte Wert ist 1.

  • niedriger, FirstSpirit-seitiger Speicherverbrauch
    Führen FirstSpirit-Projekte überwiegend kleine Medien, so kann die Parallelität erhöht werden, um den Durchsatz an Medien zu steigern.

3.2. Konfiguration der Projekteinstellungen

Die CaaS-Generierungen setzen voraus, dass im FirstSpirit-Projekt eine Seitenvorlage für die Projekteinstellungen gepflegt und freigegeben ist. Andernfalls bricht der Generierungsauftrag frühzeitig ab und meldet Fehler über die Auftragslogs.

Weitere Informationen finden Sie im Bereich Dokumentation für Redakteure der Online Dokumentation für FirstSpirit im Handbuch FirstSpirit SiteArchitect unter dem Punkt Globale Einstellungen  Projekteinstellungen.

3.3. Projekt-Komponente

Die im CaaS Service definierten Einstellungen sind serverweitig gültig. Die Projekt-Komponente bietet die Möglichkeit, diese Einstellungen teilweise auf Projektebene zu überschreiben, und ist daher dem Projekt hinzuzufügen.

Öffnen Sie hierfür den ServerManager und selektieren Sie den Bereich Projekt-Eigenschaften  Projekt-Komponenten.

tpp p list
Abbildung 4. Projekt-Komponenten

Im Hauptpanel ist eine Liste aller bereits vorhandenen Projekt-Komponenten zu sehen. Wählen Sie nach dem Klicken auf Hinzufügen die CaaSProjectConfiguration und bestätigen Sie die Auswahl mit OK. Die Projekt-Komponente wird der Liste im Hauptpanel hinzugefügt und muss anschließend noch konfiguriert werden (vgl. Abbildung Projekt-Komponenten). Selektieren Sie dafür den Eintrag in der Liste und öffnen Sie den zugehörigen Konfigurationsdialog über Konfigurieren.

Der Dialog gliedert sich in drei Tabs, die in den nachfolgenden Unterkapiteln einzeln erläutert werden.

3.3.1. Projekt

Bei der Übertragung von Medien in den CaaS werden standardmäßig auch zusätzliche Metadaten übermittelt und im CaaS gespeichert. Eine Auflistung dieser Metadaten finden sie im Kapitel Zusätzliche Metadaten.

Somit ergeben sich für jedes referenzierte Medium immer zwei URLs. Während die ID des Mediums der Abfrage der Metadaten dient, enthält der Inhalt der Metadaten die URL der Binärdaten des Mediums. Dieser Aspekt ist bei der URL-Generierung referenzierter Medien zu berücksichtigen.

Aus diesem Grund stellt der Tab Projekt im Konfigurationsdialog der Projekt-Komponente zwei Konfigurationsmöglichkeiten für die Medien-Generierung bereit:

Medien-URLs zeigen auf Inhalte (binär)

Diese Option bewirkt, dass die generierte URL für ein referenziertes Medium auf die Binärdaten des Mediums zeigt.

Medien-URLs zeigen auf Metadaten (JSON)

Die Auswahl dieser Option aktiviert die Generierung von Medien-URLs, die auf die entsprechenden Metadaten verweisen. Diese Option setzt voraus, dass die referenzierten Medien ebenfalls im CaaS gespeichert werden.

Neben der Konfiguration der Medien-URLs kann auf Projekt-Ebene die Auswertung der FirstSpirit-Metadaten konfiguriert werden. Es ist möglich, die Metadaten-Vorlage auszuwerten und so ein angepasstes Format der Metadaten in den CaaS zu übertragen.

Metadaten-Vorlage wird ausgewertet

Die FirstSpirit-Metadaten-Vorlage wird gerendert und in den CaaS übertragen. Die Übertragung der Werte des Template-Formulars obliegt damit in der Verantwortung des Template-Entwicklers.

Metadaten-Vorlage wird nicht ausgewertet

Die FirstSpirit-Metadaten-Vorlage wird nicht ausgewertet, sondern die Inhalte der Eingabefelder werden als JSON Struktur in den CaaS übertragen. (Standardverhalten)

Die in diesem Tab dargestellten Optionen besitzen eine Wechselwirkung zu den konfigurierbaren Optionen der Tabs Auftragskonfiguration und Vorschaukonfiguration.

tpp g conf
Abbildung 5. Projekt-Komponente - Projekt

3.3.2. Freigabestand

Projekte sind stets individuell und besitzen spezifische Anforderungen. Eine dieser Anforderungen kann sein, Medien nicht im CaaS, sondern in einem Drittsystem zu speichern.

Aus diesem Grund stellt der Tab Freigabestand im Konfigurationsdialog der Projekt-Komponente zwei Konfigurationsmöglichkeiten für die Verarbeitung von Medien bereit:

Medien in den CaaS generieren

Diese Option entspricht der Verwendung der Standard-CaaS-Generierung, bei der die referenzierten Medien dem CaaS übermittelt und von ihm persistiert werden.

FirstSpirit-Standardgenerierung verwenden

Die Auswahl dieser Option bewirkt, dass der FirstSpirit-Standardmechanismus verwendet und die Medien im Dateisystem gespeichert werden. Dies kann für eine anschließende Weiterverarbeitung der Medien, wie beispielsweise die Übertragung in ein CDN, sinnvoll sein.

Ist die Option FirstSpirit-Standardgenerierung verwenden aktiviert, muss im Tab Projekt die Option Medien-URLs zeigen auf Inhalte (binär) ausgewählt sein. Ist dort stattdessen die Option Medien-URLs zeigen auf Metadaten (JSON) selektiert, erfolgt ein automatischer Wechsel der Auswahl.

Sollten in Kombination mit einem eventuell vergebenen CDN-Präfix die Ordnernamen im Generierungsverzeichnis nicht wie erwünscht generiert werden, so können Sie in den Eigenschaften der Aktion Initialize CaaSGeneration des Generierungsauftrags den Parameter caasEnsureMediaPathStartsWithSlash auf den Wert true setzen.

Aus Gründen der Rückwärtskompatibilität muss diese Option explizit aktiviert werden.

Die nachfolgenden Felder sind nur dann verfügbar, wenn die Option FirstSpirit-Standardgenerierung verwenden ausgewählt ist.

CDN-Präfix für Medien

Sollen Medien nicht aus dem CaaS, sondern aus einem CDN ausgespielt werden, lässt sich in diesem Feld ein Präfix angeben. Dieses kann der Angabe eines Host-Namens und gegebenenfalls eines Kontextpfads entsprechen. Es wird allen URLs vorangestellt, die während der Generierung durch die verwendete URL-Factory erzeugt werden.

Die Übertragung der Medien in das CDN ist mithilfe der gewohnten FirstSpirit-Mechanismen zu lösen und nicht Bestandteil dieser Dokumentation.

URL-Factory für Mediennutzung

Das CaaS-Modul besitzt für die Generierung von Medien und ihrer URLs eine eigene URL-Factory. An dieser Stelle ist die URL-Factory anzugeben, die bei einer Verwendung der FirstSpirit-Standardgenerierung einzusetzen ist. Dabei steht eine Auswahl an auf dem FirstSpirit-Server verfügbaren URL-Factories zur Verfügung. Falls keine Auswahl getroffen wird, wird standardmäßig Advanced URLs während der CaaS-Generierung genutzt.

In diesem Feld steht aus technischen Gründen nur eine eingeschränkte Auswahl der auf dem Server installieren Methoden zur Pfaderzeugung zur Verfügung: Diese müssen das Java-Interface UrlFactory implementieren. Dies trifft bei den durch FirstSpirit mitgelieferten Implementierungen auf die Advanced URLs (AdvancedUrlFactory), sowie den CaaS URL Creator (CaaSUrlFactory) zu.

tpp p conf
Abbildung 6. Projekt-Komponente - Freigabestand

3.3.3. Vorschaustand

Bei der Verarbeitung nicht freigegebener Inhalte gilt es zu beachten, dass eine Vermischung mit dem Freigabe-Stand zu vermeiden ist. Dies wird mithilfe eines Preview-CaaS gelöst. An dieser Stelle wird vorausgesetzt, dass in der CaaS-Plattform ein Preview-CaaS bereits vorhanden und dessen URL bekannt ist.

Damit bei Änderungen an einem FirstSpirit-Projekt die nicht freigegebenen Inhalte automatisch generiert werden, ohne jedoch einen Auftrag ausführen zu müssen, kommt die FirstSpirit-Eventing-API zum Einsatz.

Der Einsatz des CaaS in Verbindung mit dem FirstSpirit Omnichannel Manager setzt die Installation und Konfiguration des Omnichannel Manager-Moduls voraus. Die notwendigen Schritte sind in der Dokumentation für den FirstSpirit Omnichannel Manager beschrieben.

Die Konfiguration zur Nutzung des Preview-CaaS wird im Tab Vorschaustand des Konfigurationsdialogs der Projekt-Komponente vorgenommen:

URL der REST API

Für die Verwendung des Preview-CaaS muss dessen URL angegeben werden. Die URL richtet sich nach der gewählten Umsetzung des Preview-CaaS in der CaaS-Plattform.

Bleibt das Feld leer, ist die Preview-Funktionalität für das jeweilige FirstSpirit-Projekt deaktiviert.

API Key

An dieser Stelle wird ein API Key benötigt, der Schreibrechte für das verwendete Projekt besitzt.

Proxy URI

Für den Fall, dass die REST-Schnittstelle nur über einen Proxy-Server erreichbar ist, muss dessen URI an dieser Stelle angegeben werden. Andernfalls kann dieses Feld leer gelassen werden.

Vorlagensatz

An dieser Stelle ist der Ausgabekanal auszuwählen, in dem die zu generierenden CaaS-Inhalte definiert werden.

Sprache

Wählen Sie alle Sprachen aus, für die Inhalte in den Preview-CaaS übertragen werden sollen.

Kontext der Templateauswertung

Mit den Standard-FirstSpirit-Funktionalitäten ist es Template-Entwicklern möglich, bestimmte redaktionelle Inhalte ausschließlich in der FirstSpirit-Vorschau bzw. im ContentCreator anzuzeigen. Mit der Generierung der nicht freigegebenen Inhalte können diese Inhalte auch in den Preview-CaaS übertragen werden. Über die Auswahl des Kontextes ist zu entscheiden, ob dabei alle Vorschau-Inhalte oder ausschließlich für den ContentCreator bestimmte Inhalte übertragen werden. Die Option Preview entspricht dem Fall #global.isPreview = true und #global.is("WEBEDIT") = false, während die Option ContentCreator sowohl #global.is("WEBEDIT") = true als auch #global.isPreview = true erfasst. Die Standardeinstellung Default erfasst keine der zuvor genannten Parameter und liefert sowohl für #global.isPreview als auch für #global.is("WEBEDIT") den Wert false zurück.

Mediennutzung

In Verbindung mit dem Preview-CaaS kann es für die Darstellung der Vorschau unter bestimmten Bedingungen sinnvoll sein, Medien nicht aus dem CaaS, sondern vom FirstSpirit-Server zu beziehen. Für die entsprechende Konfiguration stehen zwei Optionen zur Verfügung:

Medien in den CaaS generieren

Diese Option entspricht dem Standardverhalten, bei dem die referenzierten Medien aus dem CaaS abgerufen werden.

Medien aus der FirstSpirit-Vorschau nutzen

Die Auswahl dieser Option bewirkt, dass für die Anzeige von Medien in der Vorschau die FirstSpirit-Standardmittel verwendet und sie direkt vom FirstSpirit-Server abgerufen werden. In diesem Fall werden die Medien nicht im CaaS abgelegt und die generierten Medien-URLs zeigen auf die FirstSpirit-interne Vorschau.

Ist die Option Medien aus FirstSpirit-Vorschau nutzen aktiviert, muss im Tab Projekt die Option Medien-URLs zeigen auf Inhalte (binär) ausgewählt sein. Ist dort stattdessen die Option Medien-URLs zeigen auf Metadaten (JSON) selektiert, erfolgt ein automatischer Wechsel der Auswahl.

Variablen

Innerhalb der Preview werden keine Seitenvariablen ausgewertet. An dieser Stelle können Variablen gesetzt werden, die zum Zeitpunkt der Generierung im Seitenkontext zur Verfügung stehen.

tpp b conf
Abbildung 7. Projekt-Komponente - Vorschau

3.4. Konvertierungsregel

Die Definition der an den CaaS zu übertragenden Daten findet im noch anzulegenden Ausgabekanal statt. Die Daten sind JSON-Objekte, in denen Zeichenketten durch doppelte Anführungszeichen gekennzeichnet sind. Wären gleichzeitig doppelte Anführungszeichen in der Ausgabe enthalten, würde dies zu invaliden JSON-Objekten führen. Aus diesem Grund muss eine Konvertierungsregel angelegt werden, um potentielle Fehler zu vermeiden.

Es empfiehlt sich eine neue Konvertierungsregel anzulegen, anstatt eine bestehende zu bearbeiten. Erzeugen Sie hierfür eine Textdatei in Ihrem Dateisystem und fügen Sie dieser den folgenden Inhalt hinzu:

Konvertierungsregel
0x22="\""

Öffnen Sie anschließend die Server- und Projektkonfiguration und selektieren Sie den Punkt Server-Eigenschaften  Konvertierungs-Regeln. Im Hauptpanel ist eine Liste der bereits existierenden Konvertierungsregeln zu sehen. Wählen Sie nach dem Klicken auf Hinzufügen die zuvor erstellte Textdatei aus Ihrem Dateisystem aus und bestätigen Sie die Auswahl mit Öffnen. Die Liste im Hauptpanel wird daraufhin um die neue Regel ergänzt, die dem zu erstellenden Ausgabekanal zuzuordnen ist.

Weitere Informationen finden Sie in der FirstSpirit Dokumentation für Administratoren.

3.5. Ausgabekanal

Zusätzlich zu den bereits vorhandenen Ausgabekanälen eines Projekts wird für die Definition der zu übertragenden Inhalte an den CaaS ein weiterer Ausgabekanal benötigt, der manuell anzulegen ist.

Öffnen Sie dafür die Server- und Projektkonfiguration und wählen Sie den Punkt Projekt-Eigenschaften  Vorlagensätze. Durch einen Klick auf Hinzufügen wird ein Dialog angezeigt, der folgendermaßen zu füllen ist:

templateset
Abbildung 8. Ausgabekanal anlegen

In der gleichnamigen Auswahlbox muss die zuvor erzeugte Konvertierungsregel ausgewählt werden.

Bestätigen Sie den Dialog anschließend mit OK, um das Hinzufügen des Ausgabekanals abzuschließen.

Die Liste der vorhandenen Vorlagensätze wird daraufhin um den neuen Ausgabekanal erweitert. Dieser wurde automatisch aktiviert und steht somit direkt im Projekt zur Verfügung.

3.6. Generierungsauftrag (Vollgenerierung)

Die initiale Füllung des CaaS sowie die spätere Benachrichtigung über Änderungen im FirstSpirit-Projekt erfolgt über Nachrichten, die das CaaS-Moduls an die CaaS-Plattform verschickt. Für die Erstellung dieser Nachrichten wird ein Auftrag benötigt, der mindestens die in den folgenden Unterkapiteln erläuterten Aktionen enthält (vgl. auch Abbildung Vollgenerierung).

Öffnen Sie für den benötigten Auftrag den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften  Auftragsverwaltung.

Fügen Sie dort einen neuen Standard-Auftrag hinzu oder bearbeiten Sie einen bereits bestehenden Auftrag.

fullgeneration
Abbildung 9. Vollgenerierung

Um im Fehlerfall einen Datenverlust im CaaS zu vermeiden, muss die Checkbox Auch im Fehlerfall ausführen für alle Aktionen des Auftrags mit Ausnahme der Finalize CaaS Generation deaktiviert werden.

Seitenreferenzen mit einem leeren Ausgabekanal führen zu einem Abbruch der Generierung. Aus diesem Grund muss innerhalb des Projekts darauf geachtet werden, während der Generierung nur die notwendigen Seitenreferenzen zu erzeugen, oder die entsprechenden Seiten bei der CaaS-Generierung zu überspringen.

3.6.1. Initialize CaaSGeneration

Innerhalb des Auftrags muss zunächst eine Initialisierung erfolgen. Diese stellt die Übertragung der von FirstSpirit erzeugten Nachrichten an den CaaS sicher.

Initialize CaaS Generation
#! executable-class
com.espirit.caas.generation.CaaSScheduleInitializer

Des Weiteren aktiviert der Aufruf die im nächsten Schritt durchzuführende Generierung, die ohne diese Aktivierung nicht durchführbar ist. Die Aktion ist damit zwingend notwendig für eine erfolgreiche Generierung.

Besteht die Notwendigkeit eine spezifische CaaS-Instanz mit Daten zu befüllen, können nach der Erstellung des Skripts optional dessen Eigenschaften angepasst und über Hinzufügen die folgenden Parameter angelegt werden:

  • caasUrl

  • caasApiKey

  • caasProxyUri

  • caasMaxTransferTimeoutInMs

  • caasMaxTransferRetries

timeout
Abbildung 10. Parameter

Ist die REST-Schnittstelle der spezifischen CaaS-Instanz über einen Proxy-Server erreichbar, kann zusätzlich dessen URI angegeben werden.

Fehlen die Parameter an dieser Stelle, verwendet die Generierung die im Service definierte Standardkonfiguration. Werden sie hingegeben angegeben, überschreiben sie die Standardkonfiguration.

Die Parameter bedingen einander nicht und können somit auch einzeln definiert werden.

Die Parameter caasMaxTransferTimeoutInMs und caasMaxTransferRetries beeinflussen das Verhalten des Moduls hinsichtlich der Übertragung von Daten in die CaaS-Plattform. Sie sind nicht global einstellbar und werden ausschließlich im Problemfall benötigt. In diesem Fall weist eine Fehlermeldung während des FirstSpirit-Deployments auf eine notwendige Erhöhung der Werte hin. Eine einzelne Übertragung bricht immer dann ab, wenn der Wert des Parameters caasMaxTransferTimeoutInMs überschritten ist. Tritt ein Problem bei der Übertragung auf, wird diese maximal so häufig wiederholt, wie es der Wert des Parameters caasMaxTransferRetries vorgibt.

3.6.2. CaaS Generate

Die in der vorhergehenden Aktion aktivierte Generierung wird durch die hinzuzufügende Generierungsaktion ausgeführt.

In den Eigenschaften der Generierung ist ein beliebiger Name (hier: CaaS Generate) anzugeben. Es ist sicherzustellen, dass die Option Generierung nur wenn erforderlich deaktiviert sowie die Option Freigabestand generieren aktiviert ist (vgl. Abbildung Eigenschaften). Des Weiteren muss für die Pfaderzeugung der CaaS URL Creator gewählt werden.

caasgenerate
Abbildung 11. Eigenschaften

Die Verwendung eines eigenen URL Creators in einem CaaS-Szenario ist nicht möglich, da URLs in einem festen, CaaS-kompatiblen Schema erzeugt werden müssen. Die Auswahl eines eigenen URL Creators in den Eigenschaften der Generierung ist daher nicht zulässig. Wird vom Benutzer dennoch eine Auswahl getroffen, so bleibt diese wirkungslos.

Abhängig davon, ob der Auftrag den Freigabe- oder Vorschaustand generiert, wird intern automatisch die URL-Erzeugung angepasst. So werden in einem Vorschaustandardauftrag bei Aussteuerung der Medien über FirstSpirit (siehe Abbildung Projekt-Komponente - Freigabestand), die FirstSpirit-Preview-URLs generiert. Für einen Auftrag mit Generierung des Freigabestands hingegen wird weiterhin die konfigurierte URL-Factory verwendet.

Im Register Erweitert muss für alle Sprachen des Projekts der zuvor angelegte Ausgabekanal ausgewählt werden (siehe Abbildung Erweitert).

caasext
Abbildung 12. Erweitert

Da eine Generierung des CaaS von sich aus bereits parallel arbeitet, wird die Verwendung mehrerer paralleler Generierungsaktionen in einem Auftrag nicht unterstützt. Die Option zur parallelen Ausführung mehrerer Generierungsaktionen darf daher nicht aktiviert werden. Die Anzahl paralleler Verbindungen lässt sich während der Modulkonfiguration definieren und bei Bedarf pro Auftrag überschreiben.

Die Verwendung des CaaS setzt eine gültige Lizenz voraus. Eine fehlende bzw. ungültige CaaS-Lizenz unterbricht die Datenübertragung zwischen ihm und dem CaaS.

3.6.3. CleanUp

Für einen stets aktuellen Datenbestand müssen die im FirstSpirit-Projekt gelöschten Informationen auch im CaaS entfernt werden. Dies stellt der folgende Skriptaufruf sicher:

CleanUp
#! executable-class
com.espirit.caas.generation.CaaSCleanupExecutable

Verwenden verschiedene Generierungen - selbst innerhalb eines FirstSpirit-Projekts - das gleiche Projekt, darf hier kein Cleanup-Vorgang stattfinden, da sonst eine der Generierungen die Daten des anderen Auftrags aufräumt.

Die Aktion löscht innerhalb des CaaS lediglich veraltete Informationen. Die potentiell leeren Collections, in denen die übertragenen Daten gespeichert werden, bleiben jedoch immer erhalten (siehe auch Kapitel Übertragung von Dokumenten).

Diese Skript-Aktion darf nur in Verbindung mit der Vollgenerierung verwendet werden. Wird sie in einer Teil- oder in der Deltagenerierung eingesetzt, kommt es CaaS-seitig zu Datenverlusten.

3.6.4. Finalize CaaS Generation

Die Aktion Finalize CaaS Generation dient der Feststellung von Fehlern während der Zustellung der erzeugten Nachrichten.

Legen Sie dafür ein weiteres Skript an und fügen Sie diesem den folgenden Code hinzu:

Finalize CaaS Generation
#! executable-class
com.espirit.caas.generation.CaaSScheduleFinalizer

Im Gegensatz zu den anderen Aktionen des Auftrags, muss die Finalize CaaS Generation auch im Fehlerfall ausgeführt werden. Andernfalls kann ein fehlgeschlagener Auftrag dazu führen, dass ein nachfolgendes Deployment nicht ausführbar ist. In diesem Fall ist ein Neustart des FirstSpirit-Servers erforderlich.

3.7. Generierungsauftrag (Deltagenerierung)

Zur Erstellung der Nachrichten, die den CaaS ausschließlich über die seit der letzten Deltagenerierung dieses Auftrags vorgenommenen Änderungen informiert, wird ein zweiter Auftrag benötigt. Er muss ergänzend zu den im voranstehenden Kapitel beschriebenen Aktionen der Vollgenerierung zusätzlich die Aktion CaaS DeltaGeneration enthalten (vgl. auch Abbildung Deltagenerierung). Diese wird im nachfolgenden Unterkapitel erläutert.

deltageneration
Abbildung 13. Deltagenerierung

Bei einer Duplikation der Vollgenerierung muss die Aktion CleanUp entfernt werden. Sie führt in Verbindung mit der Deltagenerierung CaaS-seitig zu Datenverlusten und darf daher nur in der Vollgenerierung eingesetzt werden.

In den Eigenschaften der Aktion CaaS Generate muss die Option Generierung nur wenn erforderlich deaktiviert sein und alle etwaig vorhandenen Startknoten entfernt werden.

Um im Fehlerfall einen Datenverlust im CaaS zu vermeiden, muss die Checkbox Auch im Fehlerfall ausführen für alle Aktionen des Auftrags mit Ausnahme der Finalize CaaS Generation deaktiviert werden.

Wurden zwischen der aktuellen und der letzten Ausführung der Deltagenerierung keine Änderungen am Projekt vorgenommen, läuft der Auftrag einfach durch. In diesem Fall werden keine Seiten generiert und somit auch keine Informationen an den CaaS übermittelt

3.7.1. CaaS DeltaGeneration

Die Aktion CaaS DeltaGeneration ermittelt die seit der letzten Generierung durchgeführten Änderungen innerhalb des verwendeten FirstSpirit-Projekts. Des Weiteren konfiguriert sie die nachfolgende Generierungsaktion. Auf diesem Weg wird die Aktualisierung des im CaaS gespeicherten Datenbestands über eine minimale Anzahl von Datenübertragungen zur REST-Schnittstelle realisiert.

Es ist daher zwingend notwendig, dass die Aktion nach der Initialisierung und vor der Generierung ausgeführt wird.

Die Ermittlung der vorgenommenen Änderungen sowie die Übermittlung der notwendigen Informationen an die Generierungsaktion erfolgt über eine Skriptaktion mit folgendem Inhalt:

CaaS DeltaGeneration
#! executable-class
com.espirit.caas.generation.CaaSDeltaGenerationExecutable

Umgang mit Datenquellen

Im Kontext der Deltagenerierung führen sowohl die Neuanlage von Datensätzen als auch Änderungen an bestehenden Datensätzen zu einer Verarbeitung aller Seitenreferenzen, die die entsprechende Datenquelle eingebunden haben. Als Konsequenz werden daher alle Datensätze erneut in den CaaS übertragen.

Für alle Content-Projektionen, die genau einen Datensatz pro Seite generieren, kann dieses Verhalten optimiert werden, so dass nur die geänderten Daten an den CaaS übertragen werden.

Setzen Sie dazu in den Eigenschaften der Aktion CaaS DeltaGeneration den Parameter caasOptimizeSingleDatasetDeployment auf den Wert true. Aus Gründen der Rückwärtskompatibilität muss diese Option explizit aktiviert werden.

4. Definition der Inhalte

Das CaaS-Modul stellt die Möglichkeit bereit, redaktionelle Inhalte in den CaaS zu übertragen. Diese sind in dem zuvor erstellten Ausgabekanal zu definieren. Die Auswahl der zu übermittelnden Informationen ist stets individuell und muss daher auf der Basis bestehender projektspezifischer Anforderungen erfolgen.

4.1. Regeln für FirstSpirit-Projekt, Collection- und Document-Namen

Da die CaaS-Plattform nur eine eingeschränkte Auswahl an Zeichen für die Namensvergabe erlaubt, werden Projekt-, Collection- und Document-Namen aus FirstSpirit bei der Verwendung normalisiert. Diese normalisierten Namen enthalten ausschließlich alphanumerische Zeichen, sowie Unter- und Bindestriche. Die einzige Einschränkung dabei ist, dass der Name nicht mit einem Unterstrich beginnen darf. Etwaig vorhandene andere Zeichen, wie Leer- und Sonderzeichen, werden entfernt.

Da vor allem der Projektname innerhalb des CaaS als Identifier dient, muss seine Eindeutigkeit auch nach der Normalisierung erhalten bleiben. Bei der Vergabe von Projektnamen ist dieser Aspekt daher zwingend zu berücksichtigen.

4.2. Übertragung von Dokumenten

Standardmäßig findet keine Übertragung von FirstSpirit-Inhalten in den CaaS statt. Die zu übermittelnden Inhalte müssen daher zunächst projektspezifisch definiert werden. Diese Definition erfolgt in dem während der Installation angelegten Ausgabekanals. In ihm sind die Inhalte in Form eines JSON-Objekts anzugeben.

Die Befüllung des Ausgabekanals ist beliebig und könnte für Produkte aus dem Demo-Projekt Mithras Energy beispielsweise wie folgt aussehen:

Tabellenvorlage - Produkte
{
   "name": "$CMS_VALUE(cs_name.convert2)$",
   "description": "$CMS_VALUE(cs_description)$",
   "picture": "$CMS_REF(cs_picture,abs:2)$",
   "properties": [
      $CMS_FOR(for_property,cs_properties)$
         $CMS_VALUE(for_property)$$CMS_IF(!#for.isLast)$,$CMS_END_IF$
      $CMS_END_FOR$
   ]
}

Bei der Referenzierung von Medien mit CMS_REF ist die Verwendung des Parameters abs:1 bzw. abs:2 notwendig. Dieser dient der Generierung absoluter URLs. Andernfalls lassen sich die erzeugten URLs nicht für die Abfrage der Medien aus dem CaaS benutzen. Weitere Informationen sind in der Online Dokumentation für FirstSpirit unter dem Punkt Vorlagenentwicklung  Vorlagensyntax  Anweisungen  CMS_REF enthalten.

In dem folgenden Beispiel werden für jedes Produkt der Name, die Beschreibung, das Produktbild und die Produkteigenschaften an den CaaS übermittelt. Die Produkteigenschaften stammen dabei aus einer separaten Tabelle. Die Informationen sind somit nicht direkt verfügbar, sondern werden im jeweiligen Produkt als ein Array von JSON-Objekten abgelegt. Dafür muss der Ausgabekanal der zugehörigen Tabellenvorlage ebenfalls entsprechend gefüllt werden.

Tabellenvorlage - Produkteigenschaften
{
   "property" : "$CMS_VALUE(cs_property)$",
   "value" : "$CMS_VALUE(cs_value)$"
}

Ein vorangestellter Unterstrich sowie das Präfix fs_ sind als Namespace reserviert, da durch sie interne Attribute gekennzeichnet werden. Die Verwendung des Präfix bzw. eines vorangestellten Unterstrichs ist daher für die Bezeichner der Felder unzulässig. Gleiches gilt für den Attributnamen filename. Andernfalls kommt es im CaaS zu einem Datenverlust.

Während der Generierung wird für jede Seitenreferenz ein Aufruf erzeugt. Alle zu übermittelnden Informationen müssen aus diesem Grund im Ausgabekanal der zugehörigen Seitenreferenz verfügbar sein, um während der Generierung berücksichtigt zu werden. Im Fall des beschriebenen Beispiels ist dafür lediglich die Ausgabe des Inhaltsbereich, der die Produkte referenziert, im Ausgabekanal der Seitenvorlage notwendig.

Seitenvorlage - Standard
$CMS_VALUE(#global.page.body("Content center"))$

Bei der Schachtelung von JSON-Objekten über verschiedene Ausgabekanäle hinweg ist zwingend darauf zu achten, dass die Validität erhalten bleibt. Ist das JSON ungültig, bricht die Generierung ab und es werden keine Informationen in den CaaS übertragen.

Für Seitenreferenzen auf externe Adressen wird keine Nachricht an den CaaS generiert, weshalb für sie kein Eintrag im CaaS entsteht. Entsprechende Anweisungen im Ausgabekanal werden nicht ausgewertet.

Seitenreferenzen mit einem leeren Ausgabekanal führen zu einem Abbruch der Generierung. Aus diesem Grund muss innerhalb des Projekts darauf geachtet werden, während der Generierung nur die notwendigen Seitenreferenzen zu erzeugen. Eine solche Einschränkung kann beispielsweise durch eine Teilgenerierung erreicht werden.

Alternativ besteht die Möglichkeit, in einer Vorlage die Erzeugung einer Generierung zu unterbinden. Dafür muss innerhalb des Ausgabekanals die Seitenvariable caasSkipMessage gesetzt werden:

caasSkipMessage
$CMS_SET(#global.pageContext["caasSkipMessage"], true)$

In diesem Fall wird kein Inhalt in den CaaS übertragen und ggf. bereits bestehender Inhalt wird im Rahmen des CleanUp gelöscht.

Weitere Informationen sind in der Online Dokumentation für FirstSpirit unter dem Punkt Vorlagenentwicklung  Vorlagensyntax  Systemobjekte  #global  vorschaubezogen  Abbruch einer Generierung enthalten.

4.3. Übertragung von Medien

Wie bereits im vorhergehenden Kapitel erwähnt, können Medien ebenfalls in den CaaS übertragen werden. Dafür müssen sie entweder direkt oder durch die Angabe der entsprechenden Eingabekomponente im Ausgabekanal definiert werden.

Ein vorangestellter Unterstrich ist für die Referenznamen von Medien als Namespace reserviert, da durch ihn interne Ressourcen gekennzeichnet werden. Ein solcher Referenzname eines Mediums führt während der Generierung zu einer Verhinderung der Übertragung des Mediums an den CaaS und erzeugt eine entsprechende Fehlermeldung im Generierungslog.

Referenzierung von Bildern im Ausgabekanal
{
   "logo" : "$CMS_REF(media:"fs_logo",resolution:"Teaser",abs:2)$",
   "picture" : "$CMS_REF(pt_picture,abs:2)$"
}

Handelt es sich bei dem Medium um ein Bild, lässt sich die Auflösung bestimmen, in der es an den CaaS übertragen wird. Darüber hinaus ist die Verwendung des Parameters abs:1 bzw. abs:2 für alle Medien notwendig. Dieser dient der Generierung absoluter URLs. Andernfalls lassen sich die erzeugten URLs nicht für die Abfrage der Medien aus dem CaaS benutzen.

Um eine sprachabhängige Verarbeitung der übertragenen Daten zu ermöglichen, erhalten alle Medien vor der Speicherung im CaaS einen der Sprache entsprechenden Suffix. Bei sprachunabhängigen Medien gilt die Master-Sprache des FirstSpirit-Projekts als Default-Suffix.

Im Gegensatz zu allen anderen übertragenen Informationen erfolgt die Persistierung der Medien im CaaS nicht in Collections, sondern in einem sogenannten Bucket mit dem Namen assets.files.

4.4. Zusätzliche Metadaten

Die innerhalb des FirstSpirit-Projekts definitierten Informationen werden per Deployment an den CaaS übertragen. Sie enthalten dabei standardmäßig zusätzlich die folgenden FirstSpirit-Daten:

  • Id (fs_id)

  • Sprache (fs_language)

  • Zeitstempel (fs_date)

  • Ausführung des Auftrags (fs_scheduler_date)

  • Referenzname (fs_reference_name)

  • Revisions-Id (fs_revision_id)

  • FirstSpirit UID Type (fs_uid_type)

  • Projekt-Id (fs_project_id)

  • Objekt-Typ (fs_object_type)

  • FirstSpirit-Metadaten (fs_metadata)

Für Medien werden darüber hinaus weitere Informationen erfasst, sofern diese vorliegen:

  • Dateiendung (fs_extension)

  • Auflösung - Breite (fs_resolution_width)

  • Auflösung - Höhe (fs_resolution_height)

  • Prüfsumme (fs_crc)

  • Beschreibung (fs_description)

  • Mimetype (fs_mimetype)

  • Dateigröße (fs_size)

  • Datei-Encoding (fs_encoding)

4.5. Anpassung von Projekt/Collection im CaaS

Standardmäßig erfolgt die Persistierung aller vom CaaS-Modul versandten Informationen im CaaS in einer Collection mit dem Namen content. Sie wird automatisch bei der ersten Übertragung erzeugt und erfasst alle Inhalte, die keine Medien sind.

Ergänzend zu der Standard-Collection können weitere Collections definiert werden, um die Inhalte im CaaS zu sortieren. Dies ist vor allem dann sinnvoll, wenn eine Vielzahl unterschiedlicher Informationen an den CaaS übermittelt wird.

Optional können Inhalte aus einem FirstSpirit-Projekt auch in mehrere CaaS-Projekte übertragen werden. Dies erlaubt eine noch feinere Sortierung komplexer Daten und ermöglicht erweiterte Anwendungsszenarien, wie beispielsweise eine manuelle Versionierung.

Die Definition zusätzlicher Collections und CaaS-Projekte erfolgt über ein Plug-In, das sowohl über die Menüleiste als auch über das Kontextmenü in der Struktur-Verwaltung des FirstSpirit-Projekts bereitgestellt wird.

plugin
Abbildung 14. Menüleiste und Kontextmenü

Diese Einstellungen können nur von einem Projekt Administrator vorgenommen werden.

Das Plug-In öffnet einen Dialog, in dem sich für die selektierte Seitenreferenz bzw. den referenzierten Strukturordner ein CaaS-Projekt und eine Collection angegeben lässt. Der initiale Wert des CaaS-Projekts wird vom Namen des FirstSpirit-Projekts abgeleitet, der initiale Wert der Collection entspricht der Standard-Collection content (vgl. Abbildung Ändern des Collection-Namens für einen Strukturordner). Für Seitenreferenzen besteht darüber hinaus die Möglichkeit, den Dokumentennamen anzupassen (vgl. Abbildung Ändern des Collection- und Document-Namens für eine Seitenreferenz). Dieser Name wird für die Speicherung der auf Basis der Seitenreferenz generierten JSON-Objekte im CaaS verwendet. Ohne eine Anpassung entspricht der Dokumentenname dem Referenznamen der Seitenreferenz.

Bei der Übertragung in den CaaS wird der Dokumentenname um einen Sprach-Suffix ergänzt, der eine sprachabhängige Speicherung der Inhalte gestattet.

edit pagereffolder
Abbildung 15. Ändern des Collection-Namens für einen Strukturordner
edit pageref
Abbildung 16. Ändern des Collection- und Document-Namens für eine Seitenreferenz

Erfolgt die Definition eines CaaS-Projekts oder einer neuen Collection auf einem Strukturordner, gilt die Änderung für alle ihm untergeordneten Elemente. Dem gewohnten FirstSpirit-Verhalten folgend hat die Angabe einer Collection für ein untergeordnetes Element jedoch stets Vorrang vor der für ein Elternelement. Dies bedeutet, dass die für einen Strukturordner vorgenommene Anpassung nur dann für ein ihm untergeordnetes Element übernommen wird, wenn für dieses selbst keine Änderung durchgeführt wurde.

Ein vorangestellter Unterstrich ist bei Collection- bzw. Dokumentennamen als Namespace reserviert, da durch ihn interne Ressourcen gekennzeichnet werden. Ein solcher Name führt bei der Generierung zu einer Verhinderung der Übertragung des Dokuments an den CaaS und erzeugt eine entsprechende Fehlermeldung.

Beispiel

In dem auf der nachfolgenden Abbildung dargestellten Beispiel wurde für den Strukturordner eine eigene Collection folder angegeben. Diese Anpassung wirkt sich auf die in ihm enthaltene Seite 1 und den Unterordner mit der in diesem enthaltenen Seite 2 aus. Da für die Seite A ebenfalls eine Änderung vorgenommen und die Collection page gewählt wurde, hat die übergeordnete Definition auf sie keinen Einfluss.

example
Abbildung 17. Beispiel

Bei einer Generierung werden die auf der Seite A basierenden JSON-Objekte anschließend in der Collection page abgelegt. Die durch die Seite 1 bzw Seite 2 erzeugten JSON-Objekte werden hingegen in der Collection folder gespeichert.

Soll die Änderung der Collection oder des Dokumentennamens für ein Strukturelement rückgängig gemacht werden, ist dies ebenfalls über das bereitgestellte Plug-In möglich. Es ist zu beachten, dass die zugehörigen JSON-Objekte anschließend entsprechend der Standardkonfiguration verarbeitet und im CaaS gespeichert werden.

In den Globalen Einstellungen vorgenommene URL-Einstellungen werden bei der Generierung der JSON-Objekte nicht berücksichtigt und haben somit keinen Einfluss auf die URL-Erzeugung.

5. Ändern und Löschen von Inhalten

Die Inhalte eines FirstSpirit-Projekts können jederzeit im Rahmen des gewöhnlichen Redaktionsprozesses verändert oder gelöscht werden. Um für den Freigabestand dennoch stets aktuelle Informationen zu gewährleisten, müssen Änderungen in den CaaS übernommen werden. Genauso wie die initiale Befüllung des CaaS erfolgt auch eine Aktualisierung per Generierung.

5.1. Umbenennung eines FirstSpirit-Projekts

Die Änderung des Projektnamens erzeugt ein neues Projekt im CaaS, in dem alle aktuellen Informationen enthalten sind. Das initiale Projekt mit den veralteten Daten wird nicht automatisch entfernt, sondern bleibt erhalten und muss manuell z.B. über das CaaS Admin Interface gelöscht werden.

5.2. Änderung einer zugewiesenen Collection

Die Persistierung aller von FirstSpirit übermittelten Informationen erfolgt im CaaS in sogenannten Collections. Diese lassen sich innerhalb des SiteArchitects frei definieren. Die Änderung einer Collection für bereits im CaaS persistierte Inhalte erzeugt ausschließlich im Fall einer Vollgenerierung immer einen konsistenten Datenbestand. Die FirstSpirit-Inhalte werden in der neuen Collection gespeichert und gleichzeitig aus der initialen Collection entfernt. Da die initial gewählte Collection potentiell noch andere Inhalte besitzt, bleibt sie erhalten. Wird sie nicht mehr benötigt, kann sie z.B. über das CaaS Admin Interface gelöscht werden.

Die Delta-Generierung erkennt die Änderung einer Collection nur dann, wenn zusätzlich auch weitere Änderungen an den entsprechenden Inhalten vorgenommen wurden. In diesem Fall wird die neue Collection inklusive der veränderten Inhalte angelegt. Gleichzeitig bleibt jedoch auch die initiale Collection mit den nun veralteten Informationen bestehen und es entsteht ein inkosistenter Datenbestand.

Ohne weitere Änderungen an den Inhalten kann die Delta-Generierung die Änderung einer Collection nicht ermitteln. Die neue Collection wird daher nicht angelegt und die initiale bleibt inklusive ihrer Inhalte bestehen.

5.3. Änderung eines zugewiesenen CaaS-Projekts

Wie die zugewiesene Collection (siehe Abschnitt Änderung einer zugewiesenen Collection), kann auch das zugewiesene CaaS-Projekt frei definiert werden. Hierbei ergibt sich ein mit dem Ändern von Collections vergleichbares Verhalten bezüglich Cleanup- und Löschvorgängen. Wird etwa für alle zu generierenden Elemente das CaaS-Projekt geändert, so wird kein Cleanup mehr auf das vorher konfigurierte Projekt vorgenommen und die alten Daten bleiben bestehen. Für eine Delta-Generierung müssen ebenfalls zusätzliche Änderungen an den entsprechenden Inhalten vorgenommen werden. Wird ein Element auf FirstSpirit-Seite gelöscht, so wird dieses aus dem CaaS nur dann gelöscht, wenn es vorher mit dem aktuell konfigurierten CaaS-Projekt übertragen wurde.

5.4. Löschung eines FirstSpirit-Elements

Das Löschen eines FirstSpirit-Elements entfernt mit der nächsten Generierung alle zugehörigen Informationen aus dem CaaS. Auch in diesem Fall bleibt die zugehörige Collection erhalten, selbst wenn die Generierung das letzte Dokument aus ihr entfernt. Wird die Collection nicht mehr benötigt, lässt sie sich über das CaaS Admin Interface löschen.

5.5. Löschung eines Projekts oder einer Collection im CaaS Admin Interface

Das Löschen eines Projekts oder einer Collection im CaaS Admin Interface entfernt alle in dem Projekt bzw. in der Collection enthaltenen Informationen aus dem CaaS. Die Wiederherstellung der gelöschten Daten ist nicht über das Interface, sondern ausschließlich per Vollgenerierung möglich. Die Deltagenerierung überträgt lediglich die Daten seit der letzten Änderung. Dies erzeugt in diesem Fall einen unvollständigen Datenbestand im CaaS und führt zwangsläufig zu Inkonsistenzen.

Eine Collection wird potentiell aus verschiedenen Quellen befüllt. Aus diesem Grund kann eine Generierung sie niemals löschen. Die Löschung sowohl einer Collection als auch eines Projekts ist grundsätzlich nur manuell über das CaaS Admin Interface möglich.

6. Best Practices

In diesem Kapitel werden Lösungen für Fragen aufgezeigt, die beim Einsatz des CaaS auftreten können.

6.1. Verlinkungen aus CaaS-Inhalten auf statische Seiten

Erzeugt das verwendete FirstSpirit-Projekt neben den CaaS-Inhalten auch statische Webseiten, können zwischen ihnen Verlinkungen existieren. Da die CaaS-Inhalte mit dem CaaS URL Creator, statische Inhalte jedoch mit einem anderen URL Creator generiert werden, können die Links nicht richtig aufgelöst werden. Die Einbindung des eigenen Projekts als Remote-Projekt umgeht dies durch die Angabe eines URL Creators.

remote project
Abbildung 18. Konfigurationsdialog eines Remote-Projekts

Der Remote-Zugriff erfordert ein lizenzabhängiges Zusatzmodul. Nähere Informationen sind in der FirstSpirit CorporateMedia-Dokumentation enthalten.

Die Verlinkung der Inhalte aus dem Remote-Projekt erfolgt über Remote-Referenzen. Diese verhalten sich für den Redakteur genauso, wie normale Referenzen innerhalb des verwendeten Projekts. Lediglich der Anwendungsfall unterscheiden sich.

Remote-Referenz
<FS_REFERENCE name="remote" useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="Remote-Project"/>
      <LANGINFO lang="de" label="Remote-Projekt"/>
    </LANGINFOS>
    <PROJECTS>
      <REMOTE name="myself"/>
    </PROJECTS>
</FS_REFERENCE>

Bei der Generierung kann ein Präfix für absolute Pfade angegeben werden. Dies ist bei einem Remote-Projekt nicht möglich und muss daher gegebenfalls entsprechend beachtet werden.

7. Wartung

Die Übertragung von FirstSpirit-Daten in den CaaS kann nur funktionieren, wenn die einzelnen Komponenten einwandfrei arbeiten. Treten Störungen auf oder ist eine Aktualisierung notwendig, sind daher stets sowohl der FirstSpirit-Server als auch alle CaaS-Komponenten zu betrachten. Die nachfolgenden Unterkapitel beschreiben die notwendigen Schritte einer Fehleranalyse bei einer vorliegenden Störung sowie die Durchführung eines Backups bzw. Updates.

7.1. Fehleranalyse

Tritt während der Verwendung des CaaS-Moduls eine Störung auf, kann dieser verschiedene Ursachen zugrunde liegen. Nachfolgend werden die grundlegenden Analyseschritte zur Ermittlung von Störungsursachen erläutert.

Analyse der Logs

Im Problemfall sind die Logfiles einen guten Ausgangspunkt für die Analyse. Sie bieten die Möglichkeit, alle Vorgänge auf dem System nachzuvollziehen. Auf diesem Weg werden eventuelle Fehler und Warnungen ersichtlich.

Die Auftrags- und Server-Logs des FirstSpirit-Servers können sowohl in der Auftragsübersicht als auch im Server-Monitoring eingesehen werden.

FirstSpirit-Lizenz

Die Übertragung von Daten in den CaaS setzt eine gültige Lizenz voraus. Findet keine Übertragung statt, kann daher eine ungültige Lizenz die Ursache sein.

Template-Fehler

Die FirstSpirit-Inhalte werden in Form von JSON-Objekten an den CaaS übertragen. Ihre Definition erfolgt im Ausgabekanal. Fehler in der Definition können zu invalidem JSON führen, das eine Übertragung der Daten in den CaaS verhindert. Fehler dieser Art äußern sich als Generierungsfehler im Auftrag und sind in den Auftragslogs ersichtlich.

Konfiguration des Auftrags

Empfängt der CaaS keine Daten, ist zu überprüfen, ob der Deployment-Auftrag entsprechend der Beschreibung vollständig erstellt und konfiguriert wurde. Fehlt beispielsweise die Aktion Initialize CaaS Generation, läuft der Auftrag trotzdem fehlerfrei durch. In diesem Fall findet jedoch nur ein Deployment in das Staging-Verzeichnis des FirstSpirit-Servers statt und es werden keine Daten an den CaaS versandt.

Spezifische CaaS-Instanz

Anstelle der während der Konfiguration des Moduls angegebenen CaaS-Plattform lässt sich eine spezifische CaaS-Instanz definieren. Erhält diese keine Daten vom FirstSpirit-Server, sind die Konfigurationen in der Aktion Initialize CaaS Generation des Generierungsauftrags zu prüfen. Fehlen die Konfigurationen der spezifischen Instanz in dieser Aktion, verwendet die Generierung die im Service definierte Standardkonfiguration.

7.2. Backup

Für die FirstSpirit-seitige Sicherung stehen unterschiedliche Verfahren zur Verfügung, aus denen das jeweils präferierte individuell auszuwählen ist. Eine detaillierte Beschreibung der entsprechenden Vorgehensweise ist in der FirstSpirit Dokumentation für Administratoren enthalten.

Je nach Sicherung empfiehlt es sich, vorgenommene Einstellungen und Konfigurationsänderungen separat zu speichern.

7.3. Update

Steht eine neuere Version des CaaS-Moduls zur Verfügung, muss ein Update durchgeführt werden.

Genauso wie die Installation erfolgt die Aktualisierung des CaaS-Moduls im ServerManager im Bereich Server-Eigenschaften  Module. Dafür ist die neue Version des CaaS-Moduls über den Button Installieren auszuwählen und auf dem FirstSpirit-Server zu installieren. Eine vorherige Deinstallation des Moduls ist nicht erforderlich.

Nach jeder Installation oder Aktualisierung eines Moduls ist ein Neustart des FirstSpirit-Servers notwendig.

8. Hilfe

Der Technical Support der e-Spirit AG bietet Kunden und Partnern qualifizierte technische Unterstützung zu allen Themen, die FirstSpirit™ als Produkt betreffen. Weitere Hilfe zu vielen relevanten Themen erhalten und finden Sie in auch in unserer Community.