1. Einleitung

Unternehmen müssen da sein, wo ihre Kunden sind. Eine schlichte Bereitstellung von Informationen auf der eigenen Unternehmenswebseite ist daher nicht mehr ausreichend. Stattdessen müssen Kunden über verschiedene Kanäle, deren Anzahl immer rasanter wächst, angesprochen werden. Die Möglichkeit der flexiblen Verteilung von Inhalten stellt hierfür eine Grundvoraussetzung dar.

Content as a Service (im Folgenden CaaS genannt) bietet Unternehmen die für diese Kundenkommunikation notwendige Agilität. Es ermöglicht die Bereitstellung von Inhaltsfragmenten und verfügt über eine Schnittstelle für deren Abfrage. Ohne einen zusätzlichen Implementierungsaufwand sind Daten dadurch unbegrenzt wiederverwendbar. Die Veröffentlichung in einen gezielten Kanal ist nicht mehr erforderlich.

Entsprechend der Best-of-Breed-Philosophie sind die Gestaltung und die Zusammenstellung der präsentierten Inhalte damit völlig losgelöst von FirstSpirit. Dies steigert die Unabhängigkeit, Flexibilität und Geschwindigkeit in der Projektumsetzung.

2. Architektur

Die Funktionalitäten des CaaS werden über eine Architektur verschiedener Komponenten realisiert.

Bei diesen Komponenten handelt es sich um:

  • CaaS Plattform

  • CaaS Connect Modul

Die CaaS Plattform ist rückwärtskompatibel zum CaaS-Modul in Version 2.x. Für Migrationsszenarien können somit die Module in Version 2 und 3 parallel auf einem FirstSpirit-Server installiert werden und mit der gleichen CaaS Plattform verbunden sein.

caas architecture
Abbildung 1. Architektur

Das Zusammenspiel der Komponenten erfolgt nach dem folgenden Schema:

  • Die Erstellung und Bearbeitung redaktioneller Inhalte finden FirstSpirit-seitig statt.

  • Änderungen im Redaktionssystem werden automatisch in die CaaS Plattform übertragen. (Wird das CaaS-Modul in Version 2.x eingesetzt, werden Änderungen auftragsbasiert mit FirstSpirit-Generierungen an die CaaS Plattform übertragen.)

  • Die CaaS Plattform stellt die Daten im gleichen Modell zur Verfügung, wie sie FirstSpirit-seitig übertragen wurden. Vorschau- und Freigabe-Daten sind getrennt gespeichert. Historische Daten sind in der CaaS Plattform nicht verfügbar.

  • Zum Zugriff auf die Daten im Repository stellt die CaaS Plattform eine REST-Schnittstelle bereit. Dabei stehen diverse Filter- und Projektionsmöglichkeiten bereit. Der Zugriff wird über API-Keys abgesichert.

  • Die Endanwendung des Kunden fordert die gespeicherten Informationen nach Bedarf von der CaaS Plattform an.

3. Komponenten

Dieses CaaS Release in der Version 2021-10-18 beinhaltet die folgenden technischen Versionen der Komponenten:

Tabelle 1. Technische Versionen der Komponenten
Komponente Version Links

CaaS Plattform

9.6.0

CaaS Connect Modul

3.17.0

CaaS Modul v2
(veraltet - sollte nur noch in Migrationskontexten benutzt werden)

2.19.3

Weiterführende Informationen stehen in den jeweils aufgeführten separaten Dokumentationen bereit. Diese umfassen Themen wie Installation, Betrieb und Nutzung, sowie alle Informationen bezüglich der Aktualisierung der Komponenten, insbesondere Release Notes.

Zusätzlich zu den CaaS-Komponenten kommt für die redaktionelle Arbeit der Omnichannel Manager (OCM) zum Einsatz. Mit OCM werden Inhalte direkt in der Kunden-Webapplikation verwaltet. Für die Bereitstellung der Navigationsdaten wird der Navigation Service verwendet. Dieser ist im Rahmen unseres SaaS-Angebotes verfügbar.

Weiterführende Informationen zu diesen Komponenten sind hier zu finden:

4. Migration des Moduls CaaS v2 zu Connect

In 2020 wurde das neue FirstSpirit-Modul CaaS Connect als Nachfolger zum bisherigen CaaS Modul entwickelt. Dieses bietet viele Vorteile und ist der aktuelle Standard, um FirstSpirit mit dem CaaS zu verbinden.

Das CaaS Modul v2 wurde im Juli 2020 von CaaS Connect abgelöst. e-Spirit AG stellt aber weiterhin die Kompatibilität zur CaaS Plattform und zu FirstSpirit sicher.

Die Hauptvorteile von CaaS Connect gegenüber des bisherigen Moduls sind:

  • vereinfachte Konfiguration des Moduls, insbesondere keine Definition und Konfiguration von Ausgabekanälen

  • einheitliches JSON Schema für alle FirstSpirit Inhalte

  • generisches URL-Schema basierend auf eindeutigen FirstSpirit UUIDs

  • automatisches Deployment sowohl der Vorschau- als auch Release-Daten ohne die Ausführung von Aufträgen

  • verbesserte Unterstützung von Medien und Datensätzen

Diese konsolidierte Repräsentation im CaaS dient gleichzeitig als Grundlage zur Entwicklung weiterer Funktionalitäten und Services der Digital-Experience-Plattform. Die Migration zu CaaS Connect kann jedoch nicht automatisiert durchgeführt werden, da sich einige grundlegenden Prinzipien zwischen den Modulen unterscheiden.

4.1. JSON Format

Mit CaaS Connect wird das von FirstSpirit definierte JSON-Format verwendet, sodass Definition und Konfiguration eines speziellen Ausgabekanals entfallen. Als Grundlage für die Generierung der Daten dient das FirstSpirit-Formular. Änderungen hieran werden bei Datenänderung automatisch in das resultierende JSON übernommen.

Gleichzeitig bedeutet eine Änderung des Datenformats für die Migration jedoch auch, dass die konsumierenden Anwendungen und Webseiten angepasst werden müssen.

4.2. HTML Generierung

Bisher war es mit dem CaaS Modul möglich, beliebiges HTML als Teil des JSON zu generieren. Nach dem Deployment in die CaaS Plattform konnte das HTML direkt im Frontend angezeigt werden.

Mit CaaS Connect wird dieser Ansatz nicht mehr möglich sein. Stattdessen wird der Fokus auf reinen JSON Inhalt in der CaaS Plattform gelegt. Die Definition und Präsentation der Inhalte werden dadurch strikter getrennt. Potenziell benötigtes HTML muss daher im Frontend oder anderen Clients generiert wird.

4.3. URL Schema

Neben dem Datenformat definiert CaaS Connect auch ein standardisiertes URL-Schema für den CaaS. Als Grundlage für die URLs wird die FirstSpirit-UUID der entsprechenden Objekte herangezogen, sodass eine Eindeutigkeit der Daten im CaaS gewährleistet werden kann.

Darüber verwaltet CaaS Connect Vorschau- und Release-Daten in derselben CaaS Datenbank, jedoch nach wie vor getrennten Collections.

4.4. Migrationsstrategie

Da die Migration einen gewissen Aufwand darstellt, haben wir sichergestellt, dass die Module gleichzeitig betrieben werden können, auch innerhalb eines Projektes. Mit diesem Ansatz wird der Aufwand auf der Seite des FirstSpirit Projekts auf ein Minimum reduziert, sodass Sie sich auf eine schrittweise Migration der konsumierenden Anwendungen und Frontends konzentrieren können.

Die Vorbedingungen der folgenden Migrationsstrategie sind ein funktionaler FirstSpirit-Server, ein konfiguriertes CaaS Modul v2 und als Deployment-Ziel dessen eine CaaS Plattform Instanz. Sofern Sie CaaS also bereits in ihren FirstSpirit Projekten nutzen, steht der Migration nichts mehr im Weg.

4.4.1. FirstSpirit

Die folgenden vorbereitenden Schritte sind am FirstSpirit-Server durchzuführen:

  • Installation des CaaS Connect Moduls

  • Konfiguration von CaaS Connect gegen die bestehende CaaS Plattform

  • Initialbefüllung der CaaS Plattform durch das CaaS Connect Modul

Ab diesem Zeitpunkt werden die Daten durch das FirstSpirit-Eventing automatisch aktualisiert.

Nun ist der Datenbestand des FirstSpirit-Projektes zweimal in der CaaS Plattform vorhanden. Einmal wie bisher im eigens definierten Format durch das CaaS Modul und einmal im standardisierten Format durch CaaS Connect. Da die URL Schemata unterschiedlich sind, besteht auch keine Gefahr, dass sich die Daten gegenseitig überschreiben.

4.4.2. CaaS Konsumenten & Frontends

Sobald der Datenbestand in beiden Formaten in der CaaS Plattform vorhanden ist, bildet dies eine ideale Grundlage, um die konsumierenden Anwendungen und Frontends iterativ zu migrieren.

An dieser Stelle können wir ihnen aufgrund der individuellen Projektsituationen leider nur noch die Idee der Migration und keine konkreten Schritte aufzeigen. Im Wesentlichen gilt es ein sinnvolles iteratives Vorgehen für die Migration festzulegen. Hierbei können verschiedene Kriterien zugrunde gelegt werden, abhängig von ihrer konkreten Projektsituation und der Anzahl sowie Komplexität der CaaS Konsumenten und FirstSpirit Projekte.

Sie können entweder iterativ pro FirstSpirit Projekt vorgehen oder pro Konsument. Sowohl pro FirstSpirit Projekt als auch pro Konsument gibt es weitere kleinteiligere Bausteine, die unabhängig voneinander migriert werden können, z. B.:

  • Seiten & Seitenreferenzen

  • globale Inhalte

  • Datensätze

  • Medien

4.4.3. Abschluss der Migration

Sobald alle Konsumenten migriert sind und die Daten im Format des CaaS Moduls nicht mehr konsumiert werden, kann dieses Modul deinstalliert werden. Anschließend können auch die entsprechenden Datenbanken und/oder Collections aus der CaaS Plattform entfernt werden.

5. Hilfe

Der Technical Support der e-Spirit AG bietet 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.