CaaS Module

Das Modul muss mithilfe der mitgelieferten caas-2.22.13.fsm-Datei auf dem FirstSpirit-Server hinzugefügt werden. Öffnen Sie dafür den ServerManager und wählen Sie den Bereich Server-Eigenschaften  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.22.13.fsm-Datei aus und bestätigen Sie die Auswahl mit Öffnen.

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.

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.

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.

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.

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:

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.

Information zum Templating finden sich im Abschnitt Übertragung von Dokumenten.

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.

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.

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. Eine zusätzliche Einschränkung besteht darin, dass der Name eines Projektes nicht mit einem Unterstrich beginnen darf. Etwaig vorhandene andere Zeichen, wie Leer- und Sonderzeichen, werden entfernt.

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.

Auch wenn das JSON im Ausgabekanal dediziert erzeugt werden kann, empfehlen wir ausdrücklich die von FirstSpirit bereitgestellte json-Funktion zu verwenden. Dies hat vor allem die folgenden Vorteile:

Die Konfiguration des Ausgabekanals reduziert sich damit auf den folgenden Inhalt:

Weitere Informationen sind in der Online Dokumentation für FirstSpirit unter dem Punkt Erweiterte JSON-Unterstützung  Standardisierte JSON-Ausgabe enthalten.

Wenn von dieser Empfehlung abgewichen wird, stellen Sie bei Problemen bitte immer zunächst sicher, das über das Templating valides JSON erzeugt wird, da dies die Hauptfehlerquelle darstellt.

Wie bereits im vorhergehenden Kapitel erwähnt, können Medien ebenfalls in den CaaS übertragen werden. Bei Verwendung der von FirstSpirit bereitgestellten json-Funktion werden alle referenzierten Medien automatisch verarbeitet.

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.

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:

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.