1. Einleitung

FirstSpirit bietet für statisch generierte Seiten eine eigene, vorlagenbasierte Navigationsfunktion. In der modernen Headless-Welt bedarf es einer anderen Lösung, bei der eine dynamische Zuordnung zwischen einer Navigationsroute und dem entsprechenden Inhalt dahinter nahtlos integrierbar ist.

Das Navigation Service-Modul ermöglicht einen Weg, den Aufbau der FirstSpirit-Strukturverwaltung eines Projekts in ein JSON-Format zu überführen und über den Navigation Service-Endpunkt zur Verfügung zu stellen. Gemäß der Dokumentation des Navigation Service-Endpunkts kann die Struktur daraufhin über eine REST-Schnittstelle abgefragt werden.

1.1. Architektur

Die Funktionalitäten des Navigation Services werden über eine Architektur verschiedener Komponenten realisiert (vgl. Abbildung Architektur).

Bei diesen Komponenten handelt es sich um:

  • Navigation Service

  • Navigation Service-Modul

architecture
Abbildung 1. Architektur

Das Zusammenspiel der Komponenten erfolgt immer nach dem folgenden Schema:

  • Die Erstellung sowie die Aktualisierung navigationsrelevanter Inhalte finden FirstSpirit-seitig statt. Änderungen an der Struktur werden dem Navigation Service-Endpunkt (vgl. REST API) im Rahmen einer Aktualisierung bereitgestellt. Dafür erzeugt der FirstSpirit-Server eine Verbindung zu diesem und überträgt alle relevanten Daten.

  • Der Navigation Service empfängt diese Daten und aktualisiert anhand der in ihnen enthaltenen Informationen sein internes Datenmodell.

  • Die Endanwendung des Kunden fordert die gespeicherten Informationen nach Bedarf vom Navigation Service-Endpunkt an, der dafür eine REST API bereitstellt. Die Abfrage der Daten erfolgt somit nach dem pull- und nicht nach dem push-Prinzip.

Die Kommunikation zwischen dem FirstSpirit-Server und dem Navigation Service erfolgt standarmäßig per HTTPS.

2. Komponenten

Der Einsatz des Navigation Services in einer bestehenden FirstSpirit-Projektinfrastruktur erfordert zwei zusätzliche Komponenten.

Mit der Verwendung des Navigation Service-Moduls wurden ein FirstSpirit-Service mit dem Namen Navigation Client Service sowie eine Projekt-Komponente namens Navigation Project Configuration auf dem FirstSpirit-Server bereitgestellt.

Navigation Client Service

Bei der Installation des Navigation Service-Moduls wird der Navigation Client Service dem FirstSpirit-Server hinzugefügt und aktiviert. Für eine Übertragung an den Navigation Service-Endpunkt muss die Projekt-Komponente dem jeweiligen Projekt hinzugefügt werden. Der Navigation Client Service sorgt anschließend für die Erzeugung der Navigationen der FirstSpirit-Projekte.

Der Navigation Client Service muss gestartet sein, damit der Einsatz des Navigation Services funktioniert.

Navigation Project Configuration

Über das Hinzufügen der Projekt-Komponente Navigation Project Configuration zu einem FirstSpirit-Projekt wird gesteuert, ob Navigationen für dieses erzeugt werden. Diese besitzt eine eigene Konfiguration, die im Kapitel Konfiguration der Navigation Service Projekt-Komponente beschreiben ist.

3. Konfiguration

Die Einrichtung des Navigation Services für den Betrieb auf einem FirstSpirit-Server erfolgt über die Konfiguration der Projekt-Komponente: Navigation Project Configuration.

Die nachfolgenden Unterkapitel beschreiben die erforderlichen Konfigurationsschritte.

3.1. Konfiguration der Navigation Service Projekt-Komponente

Mit der Verwendung des Navigation Service-Moduls wird dem FirstSpirit-Server die Projekt-Komponente Navigation Project Configuration zur Verfügung gestellt.

Über das Hinzufügen dieser Projekt-Komponente zu einem Projekt, wird dieses aktiviert und es werden somit Navigationen erzeugt.

Durch das Hinzufügen der Navigation Project Configuration zu einem FirstSpirit Projekt, wird eine initiale Erzeugung der Navigationsstruktur ausgelöst.

Beim Entfernen der Navigation Project Configuration werden die erstellten Navigationen im Navigation Service gelöscht.

Öffnen Sie für das Hinzufügen der Projekt-Komponente 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 Navigation Project Configuration und bestätigen Sie die Auswahl mit OK.

projectcomponents add
Abbildung 2. Hinzufügen der Projekt-Komponente: Navigation Project Configuration

Die Projekt-Komponente wird der Liste im Hauptpanel hinzugefügt und muss anschließend noch konfiguriert werden (vgl. Abbildung Hinzufügen der Projekt-Komponente: Navigation Project Configuration).

Selektieren Sie dafür den Eintrag in der Liste und öffnen Sie den zugehörigen Konfigurationsdialog über Konfigurieren.

Die Felder sind wie nachfolgend beschrieben zu befüllen.