FirstSpirit Object Service - Administration und Konfiguration

e-Spirit AG

FirstSpirit Version 5.x

06.10.2017
Inhaltsverzeichnis

1. Allgemeine Einführung

Mit FirstSpirit lassen sich kundenspezifische Projekte, die unterschiedlichsten Anforderungen unterliegen, umsetzen. Oftmals ist eine dieser Anforderungen, die im Content-Management-System (CMS) gepflegten Inhalte auf einen Portal-Server zu übertragen und dort zu nutzen.

FirstSpirit bietet durch seine offene und erweiterbare Systemarchitektur optimale Voraussetzungen, um redaktionelle Inhalte in unterschiedliche Portal-Server zu integrieren.

Besondere Vorteile lassen sich durch die Kombination eines Portal-Servers mit dem CMS FirstSpirit immer dann erzielen, wenn einzelne technische Eigenschaften einer reinen Portal-Server-Lösung, wie beispielsweise eine aufwändige Navigationsanpassung, durch funktionale Stärken des FirstSpirit-Systems ergänzt und in ein erfolgreiches Gesamtsystem überführt werden.

Eine Portal-Integration mit FirstSpirit besteht immer aus zwei Bereichen:

  1. FirstSpirit-seitige Komponenten

    Diese Komponenten dienen der Ermittlung, Aufbereitung und Übertragung der notwendigen redaktionellen Daten an den Portal-Server. Sie sind in der Regel generisch, d.h. unabhängig vom konkreten Portal-Server, an den die Daten übertragen werden.

  2. Portal-seitige Komponenten

    Diese Komponenten dienen der Verarbeitung und Überführung der redaktionellen Inhalte aus dem CMS in einen konkreten Portal-Server. Damit sind sie immer spezifisch für einen Portal-Server.

Die in diesem Dokument vorgestellte Portal-Schnittstelle bezieht sich ausschließlich auf die FirstSpirit-seitigen Komponenten, welche für alle Portal-Integrationen identisch und somit unabhängig vom konkreten Portal-Server sind. Die Portal-seitigen Komponenten werden in getrennten Dokumentationen behandelt.

Im Portal-Kontext ist die Konfiguration eines Projekts portalspezifisch.

Aus diesem Grund kann die Konfigurationsanleitung des Portal-Herstellers von der im vorliegenden Dokument enthaltenen Beschreibung abweichen.

Es muss daher in jedem Fall ein Abgleich stattfinden, um mehrfach ausgeführte Arbeitsschritte und Irritationen zu vermeiden.

Das vorliegende Dokument richtet sich an technische Projektleiter und FirstSpirit-Entwickler. Es ist kein Handbuch für Redakteure.

Es wird vorausgesetzt, dass der Leser sicher in der Verwendung von FirstSpirit 5.x ist und sich bereits mit der UX-Bridge vertraut gemacht hat.

1.1. Funktionsvergleich

Die neu entwickelte Portal-Schnittstelle bietet gegenüber der alten Version deutliche Vorteile. Dies zeigt auch die folgende Gegenüberstellung:

Tabelle 1. Feature Comparison-Matrix
FeatureAlte PortalschnittstelleNeue Portalschnittstelle (über FOS)

Update von kompletten (Teil-)Bäumen

Inkrement-Update für Navigation und Inhalt

Support für alle FirstSpirit-Elemente

Erweiterbarkeit der Schnittstelle im Projekt

Support der Vererbung für Metadaten und Rechte

FirstSpirit Editierrechte verfügbar



1.2. Themen dieser Dokumentation

Dieses Dokument beschreibt die Schnittstelle zur Anbindung von Portalen an FirstSpirit, erläutert die dafür notwendigen Komponenten und erklärt deren Installation sowie Konfiguration.

Kapitel 2: Eine Auflistung der für die Anbindung eines Portals benötigten Komponenten und deren Erläuterung sind in diesem Kapitel zusammengefasst.

Kapitel 3: In diesem Kapitel wird die Installation und Konfiguration der verwendeten Komponenten erklärt.

Kapitel 4: Eine potentiell gewünsche SSL-Konfiguration wird in diesem Kapitel erläutert.

Kapitel 5: Alle notwendigen Anpassungen im FirstSpirit-Projekt werden in diesem Kapitel beschrieben.

Kapitel 6: In diesem Kapitel wird das FirstSpirit Object Service Admin Interface vorgestellt.

Kapitel 7: Ein Vergleich zwischen der bisherigen und der neuen Schnittstelle zur Integration eines Portals ist in diesem Kapitel enthalten.

Kapitel 8: Einige spezifische Begriffe, die in diesem Dokument verwendet werden, sind in diesem Kapitel aufgeführt und werden dort erläutert.

Kapitel 9: Dieses Kapitel enthält die rechtlichen Hinweise der e-Spirit AG zu dem in dieser Dokumentation beschriebenen Modul.

2. Komponenten

Für die Portalanbindung werden verschiedene Komponenten benötigt:

Die einzelnen Komponenten werden in den folgenden Unterkapiteln im Detail vorgestellt.

Architektur
Abbildung 1. Architektur


Innerhalb des Portal-Servers existiert zusätzlich das Portal-spezifische Portal-Plugin, welches den Import der Inhalte in das Portal übernimmt. Diese Komponente wird in einer getrennten, vom jeweiligen Portal-Anbieter bereitgestellten Dokumentation beschrieben.

Das Zusammenspiel der einzelnen Komponenten erfolgt immer nach dem folgenden Schema:

  • In FirstSpirit durchgeführte redaktionelle Änderungen werden während einer Generierung über den UX-Bus an den FirstSpirit Object Service (FOS) übergeben. Der FOS aktualisiert daraufhin sein internes Datenmodell (vgl. Schritt 1 & 2 der Abbildung Architektur).
  • Der FOS ermittelt die durchgeführten Änderungen und benachrichtigt das Portal-Plugin mithilfe einer Event-Nachricht (vgl. Schritt 3 & 4 der Abbildung Architektur).
  • Sind die in der Event-Nachricht enthaltenen Informationen für die Aktualisierung der Daten im Portal nicht ausreichend, erfragt das Portal-Plugin über die REST-Schnittstelle des FOS alle für eine Aktualisierung notwendigen Daten.

2.1. UX-Bridge / UX-Bus

Die UX-Bridge bildet mit dem ihr zugehörigen UX-Bus das zentrale Element für die Übertragung von FirstSpirit-Inhalten in ein Portal (vgl. Abbildung Architektur).

Die zum Datenaustausch notwendige Kommunikation zwischen den nur lose miteinander gekoppelten Komponenten wird über den UX-Bus realisiert. Er sammelt alle Nachrichten "zentral" und stellt sie den Komponenten zur Verfügung. Diese holen die für sie relevanten Informationen vom UX-Bus ab und verarbeiten sie entsprechend weiter.

Der wesentliche Vorteil des UX-Busses ist die Eigenschaft, den FirstSpirit-Server technisch vom Portal-Server zu entkoppeln. Damit entsteht eine robuste und stabile Infrastruktur. Eine temporäre, beispielsweise durch Wartungen hervorgerufene Nicht-Verfügbarkeit wird durch diese Struktur sicher abgefedert.

Des Weiteren besteht durch die Entkopplung die Möglichkeit, mehr als nur einen FOS bzw. Portal-Server anzubinden. Die in FirstSpirit gepflegten Daten lassen sich somit auf mehrere Live- oder Test-Systeme verteilen, wobei sich der jeweilige Datenbestand der unterschiedlichen Systeme voneinander unterscheiden kann, da jede Komponente nur ausschließlich auf die jeweils für sie bestimmten Nachrichten reagiert und diese verarbeitet.

Weitere Informationen sind in den UX-Bridge-Dokumentationen enthalten.

2.2. FirstSpirit Object Service-Modul

Das FOS-Modul ist die Komponente, die auf dem FirstSpirit-Server installiert werden muss (vgl. Abbildung Architektur).

Über die durch das Modul auf dem FirstSpirit-Server bereitgestellten Funktionalitäten können Nachrichten erstellt und an die UX-Bridge weitergegeben werden. Diese Nachrichten werden durch eine auf dem FirstSpirit-Server durchgeführte Generierung erzeugt und auf dem UX-Bus für den FOS bereitgestellt. Sie enthalten alle relevanten Informationen zu den geänderten Daten des verwendeten FirstSpirit-Projekts und informieren somit den FOS über die vorgenommenen Änderungen.

Das FOS-Modul stellt den Ausgangspunkt der Kommunikationskette zwischen den einzelnen Komponenten dar, indem es die relevanten Informationen sammelt, zusammenstellt und unter Verwendung des UX-Busses an die nachfolgende Komponente weiterreicht.

2.3. FirstSpirit Object Service (FOS)

Der FOS stellt das Bindeglied zwischen FirstSpirit und dem Portal-Server dar (vgl. Abbildung Architektur).

Er nimmt die über die UX-Bridge auf dem UX-Bus bereitgestellten Nachrichten entgegen und aktualisiert den in seiner internen Persistenzschicht gespeicherten Datenbestand. Dabei ermittelt er auf der Basis der erhaltenen Nachrichten anhand eines Datenabgleichs, welche Daten sich genau geändert haben. Diese Information gibt der FOS durch eine Event-Nachricht über den UX-Bus an das Portal-Plugin des angebundenen Portals weiter (vgl. Kapitel UX-Bridge / UX-Bus).

Das Portal-Plugin eines Portal-Servers empfängt diese Event-Nachricht und stößt eine Aktualisierung des Livestandes der Daten innerhalb des Portals an. Je nach Portal können die innerhalb der Event-Nachricht enthaltenen Informationen für die Aktualisierung nicht ausreichen. In diesem Fall fordert das Portal-Plugin zuvor die benötigten Daten vom FOS über dessen REST-Schnittstelle an. Abhängig von der Implementierung des Portal-Plugins kann es sich dabei nur um ein geändertes Element oder um einen Teilbaum handeln.

Das Portal-Plugin wird durch den jeweiligen Portal-Anbieter bereitgestellt.

3. Installation und Konfiguration der Komponenten

Vor dem Einsatz der neuen Schnittstelle sind verschiedene Schritte durchzuführen:

Die Verwendung des FOS ist nur in Verbindung mit Freigabe-Projekten möglich. Die Nutzung der Freigabe muss daher in den Projekteigenschaften aktiviert sein.