FirstSpirit Connect for Commerce

1. Einleitung

Die Erwartungen von Kundinnen und Kunden an moderne E-Commerce-Shopsysteme werden immer vielfältiger: Neben der reinen Darstellung von Produktkatalogen müssen sie einzigartige und personalisierte Shopping-Erlebnisse vermitteln. Kundinnen und Kunden wollen dabei über alle von ihnen genutzten Kanäle und Endgeräte angesprochen werden. Die Anzahl eingesetzter Touchpoints ist daher beliebig groß.

FirstSpirit Connect for Commerce ermöglicht die Verknüpfung der Digital Experience Platform FirstSpirit mit einem beliebigen E-Commerce-Shopsystem. Sie schafft dadurch ein leistungsstarkes Gesamtsystem, das die funktionalen Vorteile dieser Systeme kombiniert und die Bereitstellung moderner und personalisierter Inhalte ermöglicht.

Redakteurinnen und Redakteure erhalten vollständigen Zugriff auf den Produktkatalog des Shops und können diesen mit redaktionellen Inhalten, wie beispielsweise Interactive-Videos, verknüpfen. Die Pflege der Inhalte erfolgt dabei mithilfe einer intuitiv zu bedienenden und von FirstSpirit bereitgestellten WYSIWYG-Oberfläche. Darüber hinaus erhalten sie die Möglichkeit, neue Inhalte zu erstellen. Kenntnisse über das angebundene E-Commerce-Shopsystem sind dafür nicht erforderlich. Die WYSIWYG-Oberfläche stellt alle benötigen Funktionalitäten zur Verfügung.

Die Storefront des angebundenen Shops übernimmt weiterhin die Auslieferung der Inhalte. Diese bezieht sie jedoch nicht mehr ausschließlich aus dem Backend des Shops, sondern zusätzlich aus dem FirstSpirit CaaS (Content as a Service). Der CaaS entspricht einem zentralen Content Repository und persistiert die in FirstSpirit gepflegten Inhalte.
Das Gesamtsystem aus FirstSpirit und dem angebundenen Shop besitzt damit eine Architektur, in der das redaktionelle Backend FirstSpirits klar vom Frontend des Shops getrennt ist.

Wird im restlichen Dokument die Formulierung "Connect for Commerce" verwendet, ist damit innerhalb dieser Dokumentation grundsätzlich FirstSpirit Connect for Commerce gemeint.

Ein Bestandteil der Auslieferung von FirstSpirit Connect for Commerce ist das Referenzprojekt FirstSpirit Connect for Commerce Reference Project. Die vorliegende Dokumentation orientiert sich durchgängig an diesem Referenzprojekt und erläutert die mit Connect for Commerce bereitgestellten Funktionalitäten anhand gängiger Anwendungsfälle.

1.1. Funktionsumfang

FirstSpirit Connect for Commerce stellt die folgenden Möglichkeiten zur Verfügung:

Zugriff auf Produkt- und Kategorieinformationen
Erzeugung neuer redaktioneller Inhalte
gleichzeitige Darstellung von Shopelementen und redaktionellen Inhalten in der FirstSpirit-Vorschau
Ausspielung von Inhalten an beliebige Touchpoints

Die dafür notwendigen Funktionalitäten stellt das Modul nach der Installation und Konfiguration innerhalb des WYSIWYG-Clients bereit.

Die Pflege der Inhalte findet über die gewohnten FirstSpirit-Mittel statt. Mit FirstSpirit vertraute Personen benötigen daher keine darüber hinausgehenden Kenntnisse - insbesondere keine über das E-Commerce-Shopsystem. Die Inhalte werden der Storefront mithilfe des CaaS verfügbar gemacht und in Kombination mit den Inhalten des angebundenen Shops von der Storefront ausgeliefert.

Innerhalb des neu geschaffenen Gesamtsystems ergibt sich somit keinerlei Unterschied für die Auslieferung redaktioneller Inhalte. Sie erfolgt weiterhin durch die Storefront. Auch eine Wartung FirstSpirits hat keinerlei Auswirkung auf das Frontend.

Abbildung 1. Datenfluss

1.2. Architektur

Die Architektur eines Shops setzt sich standardmäßig aus dem Backend und einer Storefront zusammen. Während das Backend in diesem System sämtliche Shopfunktionalitäten bereitstellt und alle Shopinhalte persistiert, dient die Storefront der Auslieferung dieser Inhalte.

Mit der FirstSpirit Connect for Commerce-Lösung integrieren sich FirstSpirit und der CaaS in diese Architektur und erweitern die Funktionalitäten des Shops. Connect for Commerce schafft dadurch ein Gesamtsystem, das die funktionalen Stärken der einzelnen Systeme kombiniert. Innerhalb dieses Gesamtsystems repräsentieren FirstSpirit und der Shop das Backend, während der CaaS und die Bridge die Middleware und die Storefront das Frontend bilden.

Die folgende Grafik zeigt die Highlevel-Architektur dieses Gesamtsystems:

Abbildung 2. Highlevel-Architektur

Innerhalb des neu geschaffenen Gesamtsystems übernimmt die Storefront weiterhin die Auslieferung der Inhalte, die sie standardmäßig aus dem Backend des Shops bezieht. Zusätzlich fragt sie jedoch die Inhalte der jeweiligen CaaS-Instanz ab und verknüpft sie mit denen des Shops.

Im Gegensatz zur Auslieferung der Inhalte verlagert sich deren Erstellung und Pflege nach FirstSpirit. FirstSpirit stellt dafür mit dem ContentCreator einen intuitiv zu bedienenden WYSIWYG-Client zur Verfügung. In diesen ist der sogenannte Omnichannel Manager (OCM) eingebunden, der die Darstellung externer Inhalte im ContentCreator erlaubt (vgl. Abbildung Lowlevel-Architektur).

Durch die Einbettung der Storefront in den Omnichannel Manager wird eine kombinierte Vorschau der Inhalte bereitgestellt, die in diesem Fall aus dem Preview CaaS und dem Shop stammen. Die Redakteurinnen und Redakteure erhalten auf diesem Weg die Möglichkeit, bereits existierende Shopseiten im ContentCreator zu bearbeiten. Dafür stehen ihnen eine Vielzahl unterschiedlicher Komponenten zur Verfügung.

Die Bereitstellung der Produkt- und Kategorieinformationen erfolgt über Reports im ContentCreator. Die Bridge ermittelt die notwendigen Informationen dafür aus dem Backend des angebundenen Shops und übergibt sie über eine REST-Schnittstelle an den FirstSpirit-Server.

Die Übertragung der erstellten bzw. veränderten Inhalte in den Online CaaS erfolgt mit jeder Freigabe. Der CaaS persistiert die Inhalte im JSON-Format in Form von Inhaltsfragmenten und macht sie für die Storefront verfügbar, die sie zusammen mit den Shopinhalten integriert.

Das Gesamtsystem aus FirstSpirit, dem angebundenen Shop und dessen Storefront besitzt damit eine Architektur, in der das redaktionelle Backend FirstSpirits klar von der Storefront getrennt ist.

Abbildung 3. Lowlevel-Architektur

1.3. Konzept

Connect for Commerce bietet die Möglichkeit, redaktionelle Inhalte für den angebundenen Shop FirstSpirit-seitig zu pflegen und diese anschließend in den CaaS zu übertragen. Aus diesem werden sie von der Storefront des Shops abgefragt und zusammen mit den Produktinformationen aus dem Shop ausgeliefert. Dafür muss die Verarbeitung von Inhalten in beiden Systemen aufeinander abgestimmt und zueinander kompatibel sein. Die nachfolgenden Unterkapitel beschreiben das zugrunde liegende Konzept, mit dem diese Kompatibilität erreicht wird.

1.3.1. Life Cycle

Innerhalb des mit Connect for Commerce geschaffenen Gesamtsystems verlagert sich die Erstellung und Pflege redaktioneller Inhalte nach FirstSpirit. Durch den vollständigen Zugriff auf den Produktkatalog des angebundenen Shops ist dabei auch eine Einbindung der Shopinhalte möglich.

Mit der Freigabe der redaktionellen Inhalte erfolgt eine automatische Übertragung in den CaaS. Dieser stellt sie wiederum der Storefront des angebundenen Shops bereit.

Die Storefront fragt die Informationen ab und verknüpft sie mit denen des Shops, um sie in einer kombinierten Ansicht auszuliefern. Für die Vorschau ermittelt FirstSpirit die dargestellte Seite wiederum aus der Storefront und stellt sie mit den gepflegten Inhalten im ContentCreator dar.

Abbildung 4. Life Cycle

1.3.2. Bridge

Die Bridge ist ein Microservice, der als Bindeglied zwischen einem beliebigen Shop-Backend und dem FirstSpirit-Server fungiert. Sie dient dazu, die Kommunikation und den Datenaustausch zwischen den beiden Systemen zu erleichtern.

Die Bridge implementiert die REST-Schnittstellen der Bridge API und überträgt die verfügbaren Produkt-, Kategorie- und Inhaltsseiten-Informationen aus dem Shop-Backend an den FirstSpirit-Server. Sie ist ebenfalls für das Mapping zwischen FirstSpirit-Seiten und Shop-Seiten verantwortlich.

Referenzimplementierungen verschiedener Bridges sind auf Github verfügbar.

1.3.3. CaaS Connect

Der CaaS entspricht einem zentralen Repository. Er persistiert die FirstSpirit-Inhalte in Form von Inhaltsfragmenten und stellt sie in einem einheitlichen JSON-Format beliebigen Endpunkten bereit.
Im Gegensatz zu vorherigen CaaS-Versionen entfällt mit CaaS Connect das Templating in FirstSpirit und verlagert sich in das Frontend. Durch die kontinuierliche Übertragung der Inhalte ist darüber hinaus jederzeit ein aktueller Datenbestand im CaaS sichergestellt.

Weitere Informationen sind in der CaaS Connect-Dokumentation enthalten.

1.3.4. Frontend API

Die Frontend API erweitert FirstSpirit Connect for Commerce, um die Funktionalität, Produkt-, Kategorie-, und Inhaltsseiten als Shop Driven Pages zu erzeugen, Daten aus dem CaaS abzurufen und markierte Slots für die Inhaltsbearbeitung vorzubereiten.

Sie besteht aus zwei npm-Paketen:

fcecom-frontend-api-client: Stellt die API-Methoden für die Integration in die Storefront bereit.
fcecom-frontend-api-server: Übernimmt die Kommunikation mit dem CaaS und muss in einen Backend-Dienst integriert werden.

Die Referenzimplementierung eines Backend-Service ist auf Github verfügbar.

Weitere Informationen und Beispiele sind in der Frontend API-Dokumentation enthalten.

Um die Performance der CaaS-Requests zu verbessern, legt das Connect for Commerce-Modul einen Index im CaaS an. Dieser besteht aus den Schlüsseln page.formData.type.value, page.formData.id.value, locale.language und locale.country, welche zur Identifizierung einer Shop Driven Page notwendig sind. Der Index wird jeweils für die Vorschau- und Freigabe-Collection angelegt.

1.3.5. Seiten

Ähnlich wie in FirstSpirit basieren Seiten innerhalb eines Shops auf einer Struktur unterschiedlicher Komponenten. Um redaktionelle Inhalte zwischen den beiden Systemen austauschen zu können, müssen diese Komponenten aufeinander abgestimmt sein.

Innerhalb des in der Auslieferung enthaltenen Referenzprojekts FirstSpirit Connect for Commerce Reference Project werden die editierbaren Bereiche einer Shopseite durch die Inhaltsbereiche einer FirstSpirit-Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils der äquivalenten Komponente einer Shopseite entsprechen (vgl. Abbildung Page Rendering).

Mit FirstSpirit lassen sich somit Komponenten generieren, die innerhalb der editierbaren Bereiche einer Shopseite dargestellt werden.

Abbildung 5. Page Rendering

1.3.6. Seitentypen

Wie im vorhergehenden Kapitel beschrieben, erfolgt die Pflege redaktioneller Inhalte sowohl in FirstSpirit als auch im Shopsystem auf Basis einer Seite. Connect for Commerce unterscheidet dabei zwischen Shop Driven Pages und den FirstSpirit Driven Pages.

FirstSpirit Driven Pages: FirstSpirit Driven Pages existieren ausschließlich in FirstSpirit und besitzen keine zugehörige Seite im Shopsystem. Sie dienen der Erzeugung von Inhalts- oder Kampagnenseiten, die nicht zwingend im Standardumfang des Shops enthalten sind. FirstSpirit Driven Pages können entweder das Layout einer Shop Driven Page oder ein eigenes Layout verwenden, das in der Storefront definiert ist.
Shop Driven Pages: Im Gegensatz zu den FirstSpirit Driven Pages besitzen die Shop Driven Pages sowohl eine Seite in FirstSpirit als auch im Shopsystem. Sie entsprechen beispielsweise der Homepage oder den Produkt- und Kategorieseiten. Die FirstSpirit-seitig gepflegten Inhalte überschreiben oder ergänzen die bestehenden Inhalte in den vordefinierten Slots dieser Seiten.

1.3.7. Vorschau

Die mit dem FirstSpirit Connect for Commerce-Modul realisierte Integration sieht FirstSpirit-seitig lediglich die Erzeugung und Pflege der redaktionellen Inhalte sowie ihre Publizierung in Form von JSON-Dokumenten vor. Die Storefront des angebundenen Shops bestimmt jedoch weiterhin das Rahmenwerk einer Seite, deren editierbare Bereiche die generierten Komponenten einbinden.

Um eine Seite in der Vorschau darzustellen, ermittelt FirstSpirit ihre aktuelle Ansicht in der Storefront. In diesem Fall fragt diese ihrerseits die redaktionellen Inhalte aus dem Preview CaaS ab und ersetzt die entsprechenden Komponenten in der Shopseite. FirstSpirit stellt anschließend das Resultat mithilfe des Omnichannel Managers im ContentCreator dar.

1.3.8. Identifier

Mit Connect for Commerce erhalten Redakteurinnen und Redakteure vollständigen Zugriff auf den Produktkatalog des angebundenen Shops und können diesen durch redaktionelle Inhalte ergänzen. Die Ermittlung der dafür notwendigen Informationen aus dem Shop-Backend erfolgt mithilfe einer Bridge. Sie übergibt die Daten an den FirstSpirit-Server, der sie über Reports im ContentCreator bereitstellt.

Um stets eine fehlerfreie Zuordnung zwischen den realen Shopdaten und den in FirstSpirit verwendeten Produkt- und Kategorieinformationen zu gewährleisten, ist ein Mapping erforderlich. Dieses muss auf eindeutigen IDs basieren und kann beispielsweise der Abbildung einer SKU auf eine URL entsprechen. Das Mapping ist sowohl für die Bridge als auch für die Datenübertragung im Frontend relevant. Die nachfolgende Grafik stellt das Mapping einer Product ID oder Category ID auf eine Resource ID dar.

Die im Mapping definierten IDs werden ihrerseits in den Formulardaten des jeweiligen FirstSpirit-Elements gespeichert und bei jeder Freigabe per Deployment in den CaaS übertragen. Bei einem solchen FirstSpirit-Element kann es sich sowohl um eine Seite als auch um beispielsweise einen einzelnen Teaser, der ein bestimmtes Produkt referenziert, handeln. Der CaaS persistiert die in FirstSpirit erstellten Inhalte in Form von Inhaltsfragmenten und stellt diese der Storefront des angebundenen Shops bereit.

Die Storefront übernimmt weiterhin die Auslieferung der Inhalte, die sie standardmäßig aus dem Backend des Shops bezieht. Mit Connect for Commerce greift sie zusätzlich auf den CaaS zu und fragt von ihm die redaktionellen Daten ab. Die Abfrage erfolgt auf Basis des von der Bridge vorgegebenen Mappings, das auch im Frontend bekannt sein muss. Auf diesem Weg ist sichergestellt, dass der CaaS die richtigen Daten zurückgibt. Die Storefront verknüpft die Informationen mit denen des Shops und liefert sie in einer kombinierten Ansicht aus.

Abbildung 6. Mapping der IDs

1.3.9. Redaktionelle Änderungen

Im Rahmen des gewöhnlichen Redaktionsprozesses ist jederzeit eine Änderung oder Löschung der Inhalte eines FirstSpirit-Projekts möglich. Jegliche dieser Anpassungen machen eine Aktualisierung der ausgelieferten Inhalte erforderlich. Genauso wie für die initiale Veröffentlichung neuer Inhalte ist auch dafür eine Freigabe erforderlich, die eine automatische Übertragung der Inhalte in den CaaS anstößt.

2. Komponenten

Connect for Commerce setzt sich aus verschiedenen Komponenten zusammen, deren Funktionalität die folgenden Absätze beschreiben.

FirstSpirit: Die FirstSpirit-Umgebung entspricht dem FirstSpirit-Server sowie den auf ihm installierten Modulen. FirstSpirit ermöglicht die Erstellung und Pflege von Inhalten und stellt dafür den ContentCreator bereit. Dieser erlaubt mithilfe des Omnichannel Managers die Einbindung externer Inhalte. Redakteurinnen und Redakteure erhalten damit eine kombinierte Vorschau aus FirstSpirit- und Shopinhalten, die sie durch die Verwendung unterschiedlicher Funktionalitäten bearbeiten können.
Bridge: Die Bridge ist neben dem CaaS das zentrale Bindeglied zwischen FirstSpirit und dem angebundenen Shop: Sie ermittelt die Produktinformation aus dem Shop-Backend und übergibt sie über eine REST-Schnittstelle an den FirstSpirit-Server. Dieser stellt die Daten in Form von Reports im ContentCreator zur Verfügung und ermöglicht so ihre Einbindung bei der Erstellung neuer Inhalte.

Da bei der Abfrage von Produktdaten die Schnittstellen des jeweils angebundenen Shops zu berücksichtigen sind, ist jeweils eine Shop-spezifische Implementierung der Bridge erforderlich.
CaaS: Der CaaS entspricht einem zentralen Repository und ist zusätzlich zur Bridge das zweite zentrale Bindeglied von Connect for Commerce. Er persistiert die in FirstSpirit erstellten Inhalte in Form von Inhaltsfragmenten und stellt diese dem angebundenen Shop bereit. Dessen Storefront fragt die Informationen ab und kombiniert sie mit denen des Shops.
E-Commerce-Shop: Während das Backend des angebundenen E-Commerce-Shops sämtliche Shopfunktionalitäten bereitstellt, übernimmt die Storefront weiterhin die Auslieferung der Inhalte. Diese bezieht sie sowohl aus dem Shop-Backend als auch aus dem CaaS und verknüpft sie miteinander, um dann eine kombinierte Ansicht auszuliefern. Innerhalb des durch Connect for Commerce geschaffenen Gesamtsystems ergibt sich somit für die Shopstruktur keinerlei Unterschied.

3. Aufgaben für Entwickelnde

FirstSpirit Connect for Commerce ermöglicht die Verknüpfung FirstSpirits mit einem beliebigen Shopsystem. Die Architektur eines solchen Shopsystems setzt sich standardmäßig aus dem Shop-Backend und einer Storefront zusammen. Da die Verknüpfung - sowohl mit dem Backend als auch mit der Storefront - stets Shop-spezifisch erfolgen muss, ist zusätzlicher Implementierungsaufwand erforderlich. Dieser besteht in der Implementierung einer sogenannten Bridge sowie in der Übertragung der im CaaS gespeicherten Daten in die Storefront.

Die Crownpeak Technology GmbH bietet ausschließlich für den von ihr bereitgestellten Quellcode Support und Updates an. Für Eigenimplementierungen kann sie explizit weder die Verantwortung noch den Support übernehmen.

Bridge-Implementierung

Die Bridge entspricht einem Service, dessen Aufgabe die Ermittlung der Produktinformationen aus dem Shop-Backend und ihre Übertragung an den FirstSpirit-Server ist. Sie verknüpft die FirstSpirit Connect for Commerce-API mit der des Shops und stellt auf diesem Weg eine Verbindung zwischen beiden Systemen her.

Die Auslieferung enthält bereits eine Auswahl unterschiedlicher Bridge-Implementierungen für verschiedene Shopsysteme, die jeweils als Microservice umgesetzt wurden. Diese lassen sich individuell erweitern, sind aber auch ohne Anpassung verwendbar und in diesem Fall nur auf ihre Kompatibilität mit den gewünschten Anwendungsfällen zu prüfen. Des Weiteren stellt die Auslieferung ein npm-Modul zur Verfügung, welches für die Implementierung von Bridges verwendet werden kann. Das Modul implementiert die grundlegende Logik für eine Bridge. Lediglich die für das Shopsystem spezifischen Funktionalitäten müssen als Eigenimplementierung hinzugefügt werden. Alternativ zu diesen Optionen besteht die Möglichkeit, die Bridge für den angebundenen Shop vollständig selbst zu implementieren.

Sowohl im Fall einer Eigenimplementierung als auch bei der Verwendung einer bereitgestellten Bridge ist sicherzustellen, dass die Bridge vom FirstSpirit-Server aus erreichbar ist, um die aus dem Shop-Backend ermittelten Daten entgegenzunehmen. Der Datenaustausch ist dabei via Basic-Auth vor unerlaubtem Zugriff zu schützen. Gleichzeitig ist die Erreichbarkeit des Shops sicherzustellen: Besitzt er ebenfalls eine Authentifizierung, muss die Bridge auf dessen Backend zugreifen und Daten abfragen dürfen.

Um die Daten FirstSpirit-seitig darzustellen, ist außerdem eine Verknüpfung der Bridge-Endpunkte Content, Products und Categories mit den entsprechenden Endpunkten der Shop-API erforderlich. Sie werden durch die FirstSpirit Connect for Commerce-API bereitgestellt und entsprechen jeweils einem Report im ContentCreator. Sind weitere Endpunkte gewünscht, ist deren Verknüpfung eigenständig durchzuführen.

Die Implementierung des Bridge-Endpunkts Mapping ist erforderlich, um eine Verknüpfung zwischen FirstSpirit-Seiten und Seiten im Shopsystem herzustellen. Er gibt einen Bezeichner für eine gegebene Storefront-URL zurück, der in FirstSpirit verwendet wird, um die Seite zu identifizieren. Umgekehrt kann eine Storefront-URL auf der Grundlage gegebener Bezeichner-Eigenschaften in FirstSpirit konstruiert werden.

Da die in FirstSpirit verwendeten Produkt- und Kategorieinformationen stets den realen Daten im Shop zuzuordnen sein müssen, ist für sie ein Mapping zu definieren. Dieses Mapping muss auf eindeutigen IDs basieren und ist auch für die Datenübertragung im Frontend notwendig. Ein mögliches Mapping kann beispielsweise die Abbildung der SKU auf eine URL sein.

Weitere Informationen zur Implementierung einer Bridge sind im entsprechenden Anwendungsfallkapitel enthalten.

Da die IDs die Grundlage für das Mapping der Produkt- und Kategorieinformationen bilden, sind nachträgliche Änderungen nicht zu empfehlen und daher grundsätzlich zu vermeiden. Die initiale Abstimmung sowie die Konzeption der Gesamtarchitektur liegen in der Verantwortung der Entwickelnden.

Die Bereitstellung der FirstSpirit Connect for Commerce-API-Dokumentation erfolgt auf zwei Arten:

im ReDoc-Format
als lokale Swagger-UI
bei der Verwendung der durch die Crownpeak Technology GmbH bereitgestellten Bridge-Implementierungen

Datenübertragung im Frontend

Die Übertragung der im CaaS gespeicherten Daten in die Storefront muss auf Basis einer Eigenimplementierung erfolgen.

Es ist sicherzustellen, dass die Datenabfrage aus dem CaaS nur mit einer entsprechenden Berechtigung möglich ist. Der CaaS setzt dafür einen API Key voraus, der die Zugriffsrechte definiert. Dieser Key besitzt den Stellenwert eines Passworts und ist daher entsprechend zu behandeln. Ohne eine Absicherung des API Keys sind die im CaaS gespeicherten Daten frei zugänglich.

Darüber hinaus ist es wichtig, die richtigen Informationen abzurufen. Dies setzt eine korrekte Zuordnung zwischen den in FirstSpirit verwendeten Produkt- und Kategorieinformationen und den realen Shopdaten voraus. Während der Bridge-Implementierung erfolgt daher die Definition eines Mappings, das auf eindeutigen IDs basiert. Die IDs werden ihrerseits in den Formulardaten eines FirstSpirit-Elements gespeichert und per Freigabe mit in den CaaS übertragen. Auf Basis der IDs ist damit sowohl eine Abfrage der im CaaS gespeicherten FirstSpirit-Daten als auch ihre Verknüpfung mit den Shopdaten möglich.

Die im CaaS gespeicherten JSON-Inhaltsfragmente sind zum Teil sehr verschachtelt und enthalten Informationen, die für die Ausgabe in der Storefront irrelevant sind. Aus diesem Grund ist es sinnvoll, die Daten zunächst zu reduzieren und in ein für die Storefront optimales Format zu transformieren. Dabei ist auf eine korrekte Auflösung verknüpfter Informationen, wie beispielsweise Medien-URLs, zu achten.

Die Storefront verbindet die aus dem CaaS erhaltenen redaktionellen Inhalte mit denen aus dem Shop-Backend und liefert sie in einer kombinierten Ansicht aus. Dabei ist nicht nur die Darstellung der richtigen Inhalte, sondern auch deren korrekte Platzierung wichtig. Innerhalb des in der Auslieferung enthaltenen Referenzprojekts werden die editierbaren Bereiche einer Shopseite durch die Inhaltsbereiche einer FirstSpirit-Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils der äquivalenten Komponente einer Shopseite entsprechen. Dies ist bei der Ausgabe redaktioneller Inhalte zu berücksichtigen und umzusetzen.

Jeder Aufruf einer Shopseite erzeugt gleichzeitig eine CaaS-Abfrage, da die Ermittlung der in der Storefront dargestellten Inhalte dynamisch erfolgt. Daher ist eine Caching-Strategie, die sowohl Performance-Probleme als auch die Kosten für ein hohes Datenaufkommen vermeidet, äußerst sinnvoll.

Eine ausführlichere Beschreibung zur Darstellung von Inhalten in der Storefront enthält das gleichnamige Anwendungsfallkapitel.

4. Quick Start

Das Quick-Start-Kapitel richtet sich an Administratoren und skizziert die durchzuführenden Installationsschritte zur Anbindung eines E-Commerce-Shops. Es ist darauf ausgelegt, eine erste Übersicht zu bieten und daher bewusst knapp gehalten. Eine ausführliche Erläuterung der auszuführenden Schritte mit zusätzlichen Informationen ist im nachfolgenden Installationskapitel enthalten.

Die nachfolgende Liste setzt voraus, dass bereits eine Shop-Instanz existiert und von der Crownpeak Technology GmbH eine FirstSpirit-Umgebung inklusive aller benötigten Module und eines importieren Projekts bereitgestellt ist.

Zusätzlich zu den Installationsschritten sind einige Eigenimplementierungen erforderlich, die an dieser Stelle keine Berücksichtigung finden. Sie decken unterschiedliche Anwendungsfälle ab, die im gleichnamigen Kapitel beschrieben sind.

Durchzuführende Installationsschritte

Einbindung des Omnichannel Managers

Ermöglichen Sie die Darstellung der Storefront in einem iFrame, indem Sie Shop-seitig frame-ancestors oder einen X-Frame-Options-Header setzen.
Erlauben Sie das Cross-Origin Ressource Sharing durch die Konfiguration eines CORS-Filters.
Binden Sie die TPP-API entweder über ein npm-Modul oder manuell in der Storefront ein.
Markieren Sie mithilfe des HTML-Attributs data-preview-id die editierbaren Inhaltsbereiche innerhalb der existierenden Shopseiten.

Konfiguration der Projekt-Komponenten

Öffnen Sie den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften Projekt-Komponenten.
Geben Sie im Konfigurationsdialog der CaaS Connect Project App die erforderlichen Verbindungsdaten Ihrer CaaS-Instanzen an.
Konfigurieren Sie im Dialog der Navigation Project Configuration die Navigation URL sowohl für die Vorschau als auch für den Live-Stand.
Nur bei der Nutzung des Interactive Videos: Speichern Sie im Konfigurationsdialog der YouTube-DAP-Integration einen Google API Key und optional eine Channel-ID.
Tragen Sie im Konfigurationsdialog der FirstSpirit Connect for Commerce - Project Configuration die API URL der Bridge sowie die Login-Daten eines technischen Accounts ein.

Auswahl des Element Status Providers für die Arbeitsabläufe

Öffnen Sie den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften ContentCreator.
Wählen Sie im entsprechenden Feld den BasicWorkflows Status Provider aus.

Rechtedefinition für die Arbeitsabläufe

Öffnen Sie als Projektadministrator die zu konfigurierende Verwaltung im SiteArchitect.
Selektieren Sie im Kontextmenü des Root-Knotens der entsprechenden Verwaltung den Eintrag Extras Rechte ändern.
Vergeben Sie im Reiter Arbeitsablauf Rechte des sich öffnenden Konfigurationsdialogs die entsprechenden Rechte.

Definition der externen Vorschau-URL

Öffnen Sie den Bereich Projekt-Eigenschaften ContentCreator innerhalb des ServerManagers.
Fügen Sie im gleichnamigen Feld die externe Vorschau-URL ein.

5. Installation

FirstSpirit dient der Erstellung und Pflege redaktioneller Daten, die in den CaaS übertragen und von diesem persistiert werden. Um die Daten in den Shop zu integrieren, benötigt die Storefront eine Zugriffsmöglichkeit auf den CaaS. Diese wird durch verschiedene Elemente bereitgestellt, die eine Shop-seitige Einbindung und Konfiguration erfordern.

Des Weiteren ist für die Verwendung der Funktionalitäten des FirstSpirit Connect for Commerce-Moduls die FirstSpirit-seitige Installation und Konfiguration unterschiedlicher Komponenten erforderlich.

Die folgenden Unterkapitel erläutern die notwendigen Installationsschritte auf beiden Seiten.

5.1. Einbindung des Omnichannel Managers

FirstSpirit Connect for Commerce ermöglicht die Verknüpfung FirstSpirits mit einem beliebigen E-Commerce-Shopsystem. Redakteurinnen und Redakteure erhalten vollständigen Zugriff auf den Produktkatalog des angebundenen Shops und können diesen mit redaktionellen Inhalten verknüpfen. FirstSpirit stellt dafür den ContentCreator zur Verfügung, der durch die Einbindung des Omnichannel Managers die Darstellung externer Inhalte erlaubt. Durch die Einbettung der Storefront in den Omnichannel Manager wird eine kombinierte Vorschau der Inhalte bereitgestellt, die in diesem Fall aus dem Preview CaaS und dem Shop stammen. Die Redakteurinnen und Redakteure erhalten auf diesem Weg die Möglichkeit, bereits existierende Shopseiten im ContentCreator zu bearbeiten.

Die Verwendung des Omnichannel Managers stellt die folgenden Anforderungen an den verwendeten Shop:

Darstellung im iFrame: Um die Inhalte des angebundenen Shops im ContentCreator darstellen zu können, muss dessen Storefront im iFrame aufrufbar sein. Dafür sind frame-ancestors oder ein X-Frame-Options-Header erforderlich, der standardmäßig in der Konfiguration des verwendeten Webservers zu setzen ist. Je nach Shopsystem kann dies jedoch abweichen.

Beachten Sie, dass frame-ancestors den X-Frame-Options-Header überflüssig macht. Daher ist frame-ancestors die empfohlene Option, aber da einige Browser dies noch nicht unterstützen, kann x-frame-options als Fallback erforderlich sein.

CORS erlauben: Zusätzlich zur Darstellung im iFrame muss der Storefront des angebundenen Shops das Cross-Origin Resource Sharing (CORS) erlaubt sein. Der dafür erforderliche CORS-Filter erlaubt die Durchführung von Cross-Domain-Anfragen und ist Shop-spezifisch zu konfigurieren.
Einbindung der TPP-API: Die Bearbeitung existierender Shopseiten im ContentCreator setzt voraus, dass Shop-seitig ein Zugriff auf die API des Omnichannel Managers besteht. Dafür ist eine JavaScript-Datei erforderlich, die sich entweder mithilfe eines npm-Moduls oder manuell in der Storefront einbinden lässt. Sie stellt die Funktionalitäten des ContentCreators in der Storefront bereit und ermöglicht somit die Pflege externer Inhalte.
Markierung editierbarer Inhaltsbereiche: Neben der Einbindung der TPP-API ist für die Bearbeitung existierender Shopseiten die Markierung der editierbaren Inhaltsbereiche erforderlich. Dafür ist das HTML-Attribut data-preview-id zu setzen. Erst dieses ermöglicht die Nutzung der durch den ContentCreator zur Verfügung gestellten Editierfunktionen und damit die Pflege der redaktionellen Inhalte. Die Bearbeitung der Inhalte stößt ihre Übertragung in den CaaS an, der sie wiederum über eine REST-Schnittstelle zur Abfrage bereitstellt.

Weitere Informationen über den Omnichannel Manager sowie dessen API sind in der Dokumentation des Omnichannel Managers beziehungsweise in der API-Beschreibung enthalten.

5.2. Konfiguration der Projekt-Komponente

Für den Einsatz des FirstSpirit Connect for Commerce-Moduls sind einige projektspezifische Informationen erforderlich. Sie sind über die Projekt-Komponente anzugeben, die dem bereitgestellten Referenzprojekt bereits hinzugefügt ist.

Zur Nutzung des FirstSpirit Connect for Commerce-Moduls ist außerdem eine Konfiguration des CaaS Connect-Moduls sowie des NavigationServices erforderlich. Die dafür notwendigen Schritte sind in der CaaS Connect-Dokumentation und in der Dokumentation des NavigationServices beschrieben.

Die Verwendung des Interactive Videos setzt zusätzlich die Konfiguration der YouTube-DAP-Integration voraus. Diese ist in der zugehörigen Readme-Datei erläutert.

Öffnen Sie für die Konfiguration den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften Projekt-Komponenten.

Abbildung 7. Projekt-Eigenschaften - Projekt-Komponenten

Im Hauptpanel ist eine Liste aller bereits vorhandenen Projekt-Komponenten zu sehen. Selektieren Sie den Eintrag FirstSpirit Connect for Commerce - Project Configuration und öffnen Sie den zugehörigen Konfigurationsdialog über Konfigurieren.

5.2.1. Allgemein

Im Tab Allgemein werden folgende Einstellungen vorgenommen:

Der absolute Pfad zur ContentCreator Extension-Datei
ContentCreator Extension nutzen
Erzeugung von Inhaltsseiten über Bridge deaktivieren

Die ContentCreator Extension entspricht einer JavaScript-Datei, welche an einem für den Browser des Redakteurs erreichbaren Ort bereitgestellt werden muss. Das Skript ermöglicht die Kommunikation zwischen ContentCreator und dem FirstSpirit Connect for Commerce-Modul. Das Skript ist projektspezifisch anpassbar. Die Implementierung der ContentCreator Extension beinhaltet einen einfachen Webserver und wird auf GitHub bereitgestellt.

Bei Verwendung der Frontend API muss die Checkbox ContentCreator Extension nutzen deaktiviert sein.

Im Standard erzeugt das FirstSpirit Connect for Commerce-Modul beim Erzeugen einer Inhalsseite über die Plus-Schaltfläche im ContentCreator über die Bridge ein Äquivalent der Seite im Shop-System. Über die Checkbox Erzeugung von Inhaltsseiten über Bridge deaktivieren kann dieses Verhalten unterbunden werden.

Abbildung 8. Projekt-Komponente - Konfigurationsdialog - Allgemein

5.2.2. Bridge

Konfiguration der Bridge

Im Tab Bridge werden folgende Einstellungen vorgenommen:

Die API URL der Bridge
Die Zugangsdaten für die Anmeldung an der Bridge

Außerdem kann über die Schaltfläche Bridge-Verbindung testen die Verbindung zur Bridge getestet werden.

Abbildung 9. Projekt-Komponente - Konfigurationsdialog - Bridge

Verbindungstest

Die Projekt-Komponente bietet die Möglichkeit die Verbindung zwischen dem Connect for Commerce-Modul und der Bridge zu testen.

Das Protokoll-Fenster zeigt das Resultat des Verbindungstests detailliert an. Dabei werden erfolgreiche Anfragen sowie Fehler eindeutig dargestellt. In diesem Fenster wird zusätzlich dargestellt, wenn ein Endpunkt veraltet ist und bald eingestellt und entfernt wird.

Abbildung 10. Beispielausgabe: Erfolgreicher Verbindungstest

Abbildung 11. Beispielausgabe: Deaktiviertes Feature

Abbildung 12. Beispielausgabe: Fehlerhafter Verbindungstest

5.2.3. Reports

Im Tab Reports ist sowohl für den Kategorien- als auch für den Produkte-Report optional die Anzahl der Kategorieebenen definierbar. Diese beschränken die Darstellung des Kategoriebaums innerhalb des entsprechenden Reports auf die Anzahl der gewünschten Ebenen, für die standardmäßig jeweils der Wert 3 vorgegeben ist.

Abbildung 13. Projekt-Komponente - Konfigurationsdialog - Reports

5.3. Installation der Web-Komponenten

Für den ContentCreator wird eine Web-Komponente benötigt, die dem bereitgestellten Referenzprojekt bereits hinzugefügt ist. Sie ist standardmäßig global im ServerManager im Bereich Server-Eigenschaften Web-Applikationen installiert. In diesem Fall sind alle für die Web-Komponente erforderlichen Installations- oder Konfigurationsschritte bereits seitens der Crownpeak Technology GmbH durchgeführt.

Abbildung 14. Web-Komponenten in den Server-Eigenschaften

Innerhalb des Hauptpanels sind verschiedene Registerkarten zu sehen, die jeweils eine Liste der bereits vorhandenen Web-Komponenten enthalten. Diese Liste enthält für den ContentCreator die folgenden Einträge:

BasicWorkflows_ContentCreator_Library (nur bei der Verwendung der BasicWorkflows erforderlich)
FirstSpirit Connect for Commerce - Web Application Component
FirstSpirit ThirdPartyPreview WebApp
YouTube-DAP-Integration (nur bei der Verwendung des Interactive Videos)
Interactive Video (nur bei der Verwendung des Interactive Videos)

Detaillierte Informationen zur Konfiguration von Web-Komponenten finden Sie in der FirstSpirit Dokumentation für Administratoren.

5.4. Arbeitsabläufe

Die Freigabe und Löschung von Inhalten durch Redakteurinnen und Redakteure erfolgt innerhalb des bereitgestellten Referenzprojekts FirstSpirit Connect for Commerce Reference Project über die BasicWorkflows. Diese sind dem Projekt bereits hinzugefügt und alternativ zu projektspezifischen Arbeitsabläufen einsetzbar.

Installation des BasicWorkflows-Moduls

Vor der Verwendung der Arbeitsabläufe muss zunächst das BasicWorkflows-Modul auf dem FirstSpirit-Server installiert und die Web-Komponente aktiviert sein. Die dafür notwendigen Schritte sind analog zur Installation der anderen Module und der Aktivierung der dem FirstSpirit Connect for Commerce-Modul zugehörigen Web-Komponente. Standardmäßig sind diese Schritte bereits durchgeführt.

Der Einsatz der BasicWorkflows im ContentCreator erfordert darüber hinaus die Auswahl des bereitgestellten BasicWorkflows Status Providers im Bereich Projekt-Eigenschaften ContentCreator innerhalb des ServerManagers. Im Referenzprojekt FirstSpirit Connect for Commerce Reference Project ist diese Einstellung ebenfalls bereits vorgenommen.

Abbildung 15. Element Status Provider

Vorlagen

Die BasicWorkflows benötigen verschiedene Vorlagen. Diese erfordern üblicherweise einen Import über das Kontextmenü in das verwendete FirstSpirit-Projekt. Im Referenzprojekt sind sie jedoch bereits enthalten und ein Import der Vorlagen ist somit nicht notwendig.

Rechtevergabe

Im letzten Schritt müssen die Arbeitsabläufe in den einzelnen Verwaltungen erlaubt werden, um auf FirstSpirit-Elementen ausgeführt werden zu können. Dafür lässt sich im SiteArchitect auf den Root-Knoten der Verwaltungen über den Kontextmenüeintrag Extras Rechte ändern die Rechtevergabe öffnen. Dieser Schritt ist im Referenzprojekt ebenfalls bereits durchgeführt und entfällt damit.

Die auf den Root-Knoten der Verwaltungen gesetzten Rechte zur Ausführung der Arbeitsabläufe beziehen sich auf die Gruppe Everyone. Falls dies nicht gewünscht ist, muss eine manuelle Anpassung der Rechte erfolgen.

Nähere Informationen zur Installation, Konfiguration und Funktionalität der Arbeitsabläufe finden Sie in der BasicWorkflows-Dokumentation.

5.5. Deployment-Aufträge

Die Veröffentlichung redaktioneller Inhalte sowie die Aktualisierung des Online CaaS erfolgt in Verbindung mit CaaS Connect bei jeder Freigabe. Ein zusätzlicher Deployment-Prozess ist in diesem Fall nicht notwendig.

Dennoch können während des Projektverlaufs Situationen auftreten, die eine manuelle Übertragung der redaktionellen Inhalte in den CaaS erfordern. Das CaaS Connect-Modul stellt daher zwei Aufträge bereit, die dem Projekt automatisch hinzugefügt werden. Sie benötigen keine projektspezifische Anpassung.

5.6. Definition der externen Vorschau-URL

Durch die Verwendung des Omnichannel Managers stellt der ContentCreator externe Shopinhalte dar, auf die der Omnichannel Manager eine Zugriffsmöglichkeit benötigt. In den ContentCreator-Eigenschaften ist daher die Vorschau-URL der verwendeten Storefront anzugeben. Da die Angabe stets projektspezifisch ist, existiert für sie innerhalb des Referenzprojekts keine Standardkonfiguration.

Öffnen Sie für die Eingabe den Bereich Projekt-Eigenschaften ContentCreator innerhalb des ServerManagers und tragen Sie in dem Feld Externe Vorschau-URL die URL der Storefront ein.

Abbildung 16. Externe Vorschau-URL

6. Referenzprojekt

Das FirstSpirit Connect for Commerce-Modul stellt unterschiedliche Möglichkeiten bereit, auf Shop-Inhalte zuzugreifen und diese in FirstSpirit zu verwenden. Dafür sind sowohl innerhalb des FirstSpirit-Projekts als auch in der Storefront verschiedene Komponenten erforderlich. Die nachfolgenden Unterkapitel beschreiben diese Komponenten und die zwischen ihnen bestehenden Beziehungen anhand des mitgelieferten Referenzprojekts.

6.1. Sprachen

Um Shop-Inhalte mit FirstSpirit mehrsprachig pflegen zu können, ist es notwendig eine eindeutige Zuordnung zwischen Shop-Sprachen und Sprachen des Projekts zu schaffen. Die im FirstSpirit-Projekt definierten Sprachen sind daher so zu wählen, dass ihre Abkürzungen den Kürzeln der Shop-Sprachen entsprechen.

Innerhalb des Referenzprojekts sind DE und EN als verfügbare Sprachen vorkonfiguriert. Benötigt der Shop hingegen Sprachkürzel im Locale-Format (z.B. en_GB), so sind die beiden Sprachen DE und EN zu entfernen und durch Projektsprachen mit entsprechenden Abkürzungen zu ersetzen. Bei der Zuordnung von Shop-Sprachen zu Projekt-Sprachen wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Weitere Informationen zur Auswahl und Konfiguration von Sprachen im Projekt sind in der FirstSpirit Online-Documentation zu finden.

6.2. Seiten

Im Gegensatz zur Auslieferung der Shop-Inhalte verlagert sich durch die Verwendung von Connect for Commerce deren Erstellung und Pflege nach FirstSpirit.". FirstSpirit stellt dafür den ContentCreator zur Verfügung. In ihm lassen sich mithilfe des Omnichannel Managers sowohl die mit FirstSpirit erstellten Seiten als auch die bereits existierenden Shopseiten darstellen und mit redaktionellen Inhalten anreichern.

Die Erzeugung und Bearbeitung redaktioneller Inhalte erfolgt in FirstSpirit grundsätzlich auf Basis einer Seitenreferenz. Sie und die ihr zugrundeliegende Seite werden im bereitgestellten Referenzprojekt automatisch im Hintergrund erzeugt, sobald im ContentCreator eine neue Seite erzeugt wird. Dies ist auch der Fall für bestehende Seiten, die noch nicht in FirstSpirit existieren.

Das Referenzprojekt besitzt für Inhalts-, Produkt- und Kategorieseiten die folgenden Seitenvorlagen:

Homepage
Inhaltsseite
Kategorieseite
Produktseite
Landingpage

Homepage: Die Homepage-Seitenvorlage ist ein Beispiel für sogenannte statische Seiten, wie beispielsweise die Startseite, die Login-Seite oder der Warenkorb. Statische Seiten besitzen eine fixe URL und existieren standardmäßig nur einmal innerhalb eines Shops. Sie sind durch den Shop vorgegeben und besitzen ein eigenes Layout, das sie von den übrigen Seiten unterscheidet. Aus diesem Grund benötigen sie jeweils eine eigene Vorlage.
Inhaltsseiten: Die Vorlagen der Inhaltsseiten bilden die Basis für die Standardseiten des Projekts und werden daher mehrfach referenziert. Inhaltsseiten enthalten im Gegensatz zu den Kategorie- und Produktseiten allgemeine Informationen, die sich nicht auf spezifische Produkte beziehen.
Kategorie- / Produktseiten: Sowohl die Kategorie- als auch die Produktseiten dienen der Darstellung der aus dem angebundenen Shop stammenden Produkte. Produktseiten stellen dafür die Detailansicht eines spezifischen Produkts dar. Im Gegensatz dazu bieten die Kategorieseiten eine Übersicht über alle einer Kategorie zugehörigen Produkte.

Die Einbindung der aus dem angebundenen Shop stammenden Kategorie- und Produktinformationen erfolgt unter anderem über zwei Reports, die das FirstSpirit Connect for Commerce-Modul im ContentCreator bereitstellt.
Landingpages: Landingpages sind temporäre Seiten, die kein Bestandteil des allgemeinen Webauftritts sind. Stattdessen beziehen sie sich auf spezifische Events, wie beispielsweise einen Summer Sale oder den Black Friday.

6.3. Absätze

Innerhalb des in der Auslieferung enthaltenen Referenzprojekts FirstSpirit Connect for Commerce Reference Project werden die editierbaren Bereiche einer Seite durch die Inhaltsbereiche einer FirstSpirit-Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils der äquivalenten Komponente einer Shopseite entsprechen.

Das Referenzprojekt stellt dafür die folgenden Absatzvorlagen zur Verfügung:

Banner
Karussell
Interactive Video
Interactive Image
Text/Bild
Featured Products
Modal
Multi-Slot Container
Teaser Grid

Banner: Das Banner entspricht einem einzelnen Bild im Querformat, das standardmäßig im Kopfbereich einer Seite eingebunden ist.

Der Absatz erlaubt die Auswahl eines zuschneidbaren Bilds, die Angabe einer Überschrift, eines Untertitels und eines Verweises. Sowohl die Textfarbe als auch die Position sind für die Überschrift, den Untertitel und den Verweis selektierbar.
Karussell: Das Karussell gleicht in Form und Editierbarkeit dem Banner. Im Gegensatz zu diesem bindet es jedoch mehrere Bilder ein, die kontinuierlich rotieren.
Interactive Video: Das Interactive Video ermöglicht die Anzeige und Referenzierung von Produkten zu definierten Zeitpunkten in einem Video.

Der Absatz erfordert die Auswahl eines Videos, in dem zu beliebigen Zeitpunkten Text/Bild- oder Produkt-Elemente einblendbar sind..

Text/Bild-Element
Ein Text/Bild-Element besteht aus einem Bild, einer Überschrift, einem Text und einem Inhaltsverweis.

Produkt-Element
Ein Produkt-Element enthält jeweils ein Produktfoto, einen Produktnamen, eine Produktbeschreibung sowie optional ein Bild und einen Text.

Die Verwendung des Interactive Videos setzt zwingend die Installation und Konfiguration der Module YouTube-DAP-Integration und Interactive Video voraus. Andernfalls besitzt dieser Absatz keine Funktionalität.

Interactive Image: Das Interactive Image ermöglicht die Anzeige und Referenzierung von Produkten auf einer Image Map.

Der Absatz erfordert die Auswahl eines Bildes auf dem Verweise zu Produktdetailseiten einblendbar sind. Zusätzlich kann neben dem Bild auch eine Überschrift und ein Text gepflegt werden.
Text/Bild: Der Text-Bild-Absatz erwartet die Eingabe eines Texts. Zusätzlich erlaubt er die Angabe einer Überschrift und die Auswahl eines Bilds, das links oder rechts neben dem Text positionierbar ist.
Featured Products: Das Featured Products ist eine Layoutkomponente, die neben der Eingabe einer Überschrift und eines Texts, die automatische Anordnung von Produktelementen ermöglicht. Die Anordnung der Elemente ist dabei abhängig von ihrer Anzahl: Bis zu einer Anzahl von drei Elementen werden diese nebeneinander dargestellt. Zusätzliche Elemente werden in Gruppen von ebenfalls bis zu drei Elementen zusammenfasst und in weiteren Zeilen darunter angezeigt.

Ein Produktelement beinhaltet das Produktfoto, den Produktnamen und die Produktbeschreibung. Die Informationen für ein Produktelement stammen standardmäßig aus dem FirstSpirit Connect for Commerce - Products Data Access Plugin.
Modal: Das Modal ist eine Layoutkomponente, die Informationen in einem eingeblendetem Dialogfeld darstellt, das den primären Inhalt überlagert.

Es erlaubt die Auswahl eines Bildes sowie die Eingabe einer Überschrift, einer Unterüberschrift und eines Texts. Zusätzlich erlaubt es die Definition eines Verweises.

Das Modal ist keine Standard-Absatzvorlage und kann nur über die Bearbeitung der Seiteninformationen in der ContentCreator-Navigation ausgewählt werden. Im Referenzprojekt ist die Modal-Komponente nur für die Homepage-Seitenvorlage zugelassen.

Multi-Slot Container: Der Multi Slot Container ist eine Layoutkomponente, die neben der Eingabe einer Überschrift die automatische Anordnung von Inhalts-, Kategorie- oder Produktelementen ermöglicht. Die Anordnung der Elemente ist dabei abhängig von ihrer Anzahl: Bis zu einer Anzahl von vier Elementen werden diese nebeneinander dargestellt und entsprechend skaliert. Zusätzliche Elemente werden in Gruppen von ebenfalls bis zu vier Elementen zusammenfasst und in weiteren Zeilen darunter angezeigt.

Alle Elemente ermöglichen die Eingabe einer Überschrift, eines Untertitels und eines Teasertextes sowie die Auswahl eines Bilds, für das ein Alternativtext angebbar ist. Des Weiteren enthält die Darstellung der Elemente jeweils einen Button, dessen Beschriftung frei definierbar ist und der auf die Detailansicht des jeweiligen Elements verweist. Dieser Button ist nur dann sichtbar, wenn der Multi Slot Container lediglich ein einziges Element enthält.

Ergänzend zu den genannten Eingabemöglichkeiten erlaubt das Inhaltselement die Definition eines Verweises. Auch in diesem Fall sind dafür alle im Referenzprojekt verfügbaren Verweistypen zulässig.

Das Kategorieelement besitzt zusätzlich zu den genannten Eingabekomponenten eine Komponente zur Auswahl einer Kategorie. Wird für eine Kategorie kein Bild ausgewählt, zeigt das Kategorieelement ein Default-Bild an.

Die Informationen für ein Kategorie- und Produktelement stammen standardmäßig aus dem FirstSpirit Connect for Commerce - Categories Data Access Plugin und FirstSpirit Connect for Commerce - Products Data Access Plugin. Sie dienen als Fallback und werden durch Eingaben in den genannten Komponenten überschrieben.
Teaser Grid: Das Teaser Grid ist eine Layoutkomponente, die eine freie Anordnung und Skalierung unterschiedlicher Elemente ermöglicht.

Die Elemente können einem Bild oder einem Video entsprechen, für die jeweils ein Verweis sowie eine Überschrift, ein Untertitel und ein Text definierbar sind.

6.4. Verweise

Die FirstSpirit-seitig gepflegten, redaktionellen Inhalte können die nachfolgenden Verweise enthalten, die sie mit anderen Inhalten verknüpfen. Sie basieren auf Verweisvorlagen, die im Referenzprojekt bereits enthalten sind.

Kategorie- und Produktverweis: Das FirstSpirit Connect for Commerce-Modul stellt im ContentCreator jeweils einen Report für Produkte und Kategorien bereit. Sie dienen der Darstellung der aus dem Shop Backend stammenden Kategorie- und Produktinformationen, die sich für Verweise auf Kategorie- bzw. Produktdetailseiten verwenden lassen.

Das Referenzprojekt enthält dafür die Verweisvorlagen category_link und product_link, die einem Kategorie- bzw. Produktverweis entsprechen. Sie ermöglichen die Referenzierung von Kategorie- bzw. Produktdetailseiten.

Inhaltsverweis: Die im Referenzprojekt enthaltene Verweisvorlage internal_link entspricht einem Inhaltsverweis. Er ermöglicht die Referenzierung von Seiten, die innerhalb des Referenzprojekts gepflegt sind.
Externer Verweis: Die Verweisvorlage external_link entspricht einem externen Verweis und funktioniert ähnlich wie der Inhaltsverweis. Im Gegensatz zu diesem verweist er jedoch auf externe Inhalte und erwartet daher eine URL, statt einer Seitenreferenz.
CTA Verweis: Ein Call-to-Action Verweis wird mit der Verweisvorlage cta_link im Referenzprojekt zur Verfügung gestellt.
Die Darstellung des Verweistexts erfolgt entweder als heller oder dunkler CTA Button. Zusätzlich kann ein Verweis aus den bisherigen Verweistypen ausgewählt werden.
Interaktiver Produktverweis: Die Seitenvorlage Interaktives Bild verwendet ausschließlich die Verweisvorlage ìnteractive_product_link.
Er funktioniert ähnlich wie der Produktverweis mit der Ausnahme, dass zusätzlich eine Überschrift gepflegt werden kann.
DOM Verweise: Die im Referenzprojekt enthaltenen Verweisvorlagen dom_category_link, dom_content_link, dom_external_link und dom_product_link funktionieren ähnlich wie die zuvor beschriebenen äquivalenten Verweisvorlagen. Diese Verweisvorlagen werden im DOM-Texteditor verwendet und stellen zusätzlich ein Feld für den Verweistext zur Verfügung.

7. Anwendungsfälle

Innerhalb des Verlaufs eines Projekts können unterschiedliche Situationen auftreten, die bestimmte Handlungsschritte erfordern. Die nachfolgenden Unterkapitel stellen Situationen dar, die typischerweise in Integrationsprojekten vorkommen können, und beschreiben anhand des mitgelieferten Referenzprojekts die notwendigen Schritte für ihre Auflösung.

7.1. Bridge-Implementierung

Im Gegensatz zur Auslieferung der Inhalte, die weiterhin durch die Storefront erfolgt, verlagert sich deren Erstellung und Pflege nach FirstSpirit. FirstSpirit stellt dafür den ContentCreator zur Verfügung. In ihm lassen sich sowohl die mit FirstSpirit erstellten Seiten als auch die bereits existierenden Shopseiten darstellen und mit redaktionellen Inhalten anreichern. Zusätzlich ermöglichen die im ContentCreator enthaltenen Reports die Bereitstellung von Produkt- und Kategorieinformationen aus dem Shop. Dies setzt jedoch eine Bridge voraus, die spezifisch für den jeweiligen Shop sein muss.

Die Bridge ermittelt die notwendigen Informationen aus dem Backend des angebundenen Shops und übergibt sie über eine REST-Schnittstelle an den FirstSpirit-Server. Dafür verknüpft sie die FirstSpirit Connect for Commerce-API mit der des Shops und stellt auf diesem Weg eine Verbindung zwischen beiden Systemen her. Genauso wie der CaaS bildet die Bridge somit die Middleware innerhalb des durch Connect for Commerce geschaffenen Gesamtsystems. Anders als dieser kommuniziert die Bridge jedoch ausschließlich mit dem Backend des Shops und nicht mit dessen Storefront.

Abbildung 17. Position der Bridge im Gesamtsystem

Die Crownpeak Technology GmbH stellt Bridge-Implementierungen in zwei verschiedenen Ausprägungen zur Verfügung und ermöglicht damit die folgenden vier Nutzungsarten:

verfügbare Bridge
Die Auslieferung enthält für spezifische Shops bereits eine Auswahl unterschiedlicher Bridge-Implementierungen. Diese stehen auf GitHub zur Verfügung und sind ohne weitere Anpassung direkt verwendbar.
angepasste Bridge
Die auf GitHub verfügbaren Bridge-Implementierungen sind individuell anpassbar. Auf diesem Weg können der verwendeten Bridge weitere Features hinzugefügt werden, die nicht im Standardumfang enthalten sind.
Bridge Commons
Zusätzlich zu den Bridge-Implementierungen stellt die Auslieferung ein npm-Modul als Grundlage für die Implementierung einer Bridge bereit. Bei diesem handelt es sich um das Grundgerüst einer Bridge, welches lediglich um die shopspezifischen Funktionen erweitert werden muss. Es dient ausschließlich als Grundlage für eine Eigenimplementierung.
Eigenimplementierung
Alternativ zu den bereits genannten Optionen besteht die Möglichkeit, die Bridge für den angebundenen Shop vollständig selbst zu implementieren. In diesem Fall sind die nachfolgend beschriebenen Aspekte zu beachten.

Die Crownpeak Technology GmbH bietet ausschließlich für den von ihr bereitgestellten Quellcode Support und Updates an. Für Eigenimplementierungen übernimmt sie explizit weder die Verantwortung noch den Support.

Die Implementierung einer Bridge muss wie zuvor erwähnt auf den angebundenen Shop abgestimmt sein. Aus diesem Grund ist eine detaillierte Anleitung nicht möglich. Grundsätzlich sind jedoch die folgenden Schritte erforderlich:

Erstellung eines HTTP-Services
FirstSpirit-seitige Authentifizierung
Sicherstellung der Erreichbarkeit des Shops
Verknüpfung der Endpunkte

Erstellung eines HTTP-Services: Die Bridge entspricht einem zu entwickelnden Service, der die FirstSpirit Connect for Commerce-API implementiert. Dieser kann entweder als eigenständiger Microservice oder als nativer Service innerhalb der Shoparchitektur realisiert werden. In beiden Fällen muss der Service via HTTP erreichbar sein, um dem FirstSpirit-Server die Ermittlung der Shopdaten zu ermöglichen.

FirstSpirit-seitige Authentifizierung

Um den Datenaustausch zwischen dem FirstSpirit-Server und der Bridge vor unerlaubten Zugriffen zu schützen, muss in der Bridge Basic-Auth implementiert sein. Des Weiteren sind die Zugangsdaten für die Anmeldung an der Bridge sowie deren API URL im Konfigurationsdialog der Projekt-Komponente einzutragen. Der Dialog enthält zusätzlich zu den Eingabefeldern einen Button, der einen Test der Verbindung zwischen dem FirstSpirit-Server und der Bridge ermöglicht.

Sicherstellung der Erreichbarkeit des Shops

Unter Umständen setzt der anzubindende Shop ebenfalls eine Authentifizierung voraus. In diesem Fall ist sicherzustellen, dass die Bridge auf dessen Backend zugreifen und Daten abfragen kann.

Darüber hinaus muss die Bridge auf einen möglichen Ausfall der Shop-Instanz reagieren können und dem FirstSpirit-Server eine entsprechende Information zurückliefern. Eine solche Situation darf keinen Einfluss auf die FirstSpirit-seitige Erstellung und Pflege redaktioneller Inhalte haben, auch wenn die Shopinhalte möglicherweise temporär nicht verfügbar sind.

Verknüpfung der Endpunkte

Die FirstSpirit Connect for Commerce-API verfügt über die Endpunkte Content, Products, Categories und Mapping, die optional verwendbar sind. Die Content, Products und Categories Endpunkte entsprechen einem Report im ContentCreator, der sich bei Bedarf deaktivieren lässt.

Content
Der Endpunkt Content stellt einen Report für Inhaltsseiten zur Verfügung. Dieser ermöglicht sowohl die Darstellung der mit FirstSpirit erzeugten Seiten als auch der im Shop existierenden Seiten, wie zum Beispiel die Homepage oder der Warenkorb.
Products und Categories
Die Endpunkte Products und Categories erlauben die Bereitstellung von Produkt- und Kategorieinformationen. In beiden Fällen ist der Umfang der zurückgelieferten Informationen eingeschränkt, da ihre Verarbeitung erst während der Bereitstellung im Frontend erfolgt und keine Aufbereitung erforderlich ist. So wird beispielsweise der Preis eines Produkts immer dynamisch für die Anzeige im Frontend abgefragt und steht daher im redaktionellen Backend FirstSpirits nicht zur Verfügung.

Die Verknüpfung der Produkt- und Kategorieinformationen erlaubt es Redakteurinnen und Redakteuren, Produkte nach Kategorien zu filtern oder spezifische Suchen durchzuführen. Eine solche Produktsuche in Abhängigkeit der Kategorien setzt eine Eigenimplementierung voraus, die alle Suchanfragen an den Shop weiterleitet und das Ergebnis in FirstSpirit darstellt.
Mapping
Der Mapping Endpunkt stellt die Veknüpfung zwischen Seiten in FirstSpirit und Seiten im Shopsystem her. Er gibt einen Bezeichner für eine gegebene Storefront-URL zurück, der in FirstSpirit verwendet wird, um die Seite zu identifizieren. Er bietet ebenfalls die Möglichkeit, eine Storefront-URL auf der Grundlage der gegebenen Bezeichner-Eigenschaften in FirstSpirit zu konstruieren.

Für die Endpunkte Content, Products und Categories existiert ein zugehöriges Data Access Plugin (DAP). Dieses ermöglicht jeweils die Verlinkung der bereitgestellten Daten und deren Einbindung in redaktionellen Inhalten. Im Fall des Products-Endpunkts ist somit beispielsweise die Verlinkung von Produkten und die Erstellung von Produktteasern möglich.

Dazu genügt das Hinzufügen einer FS_INDEX-Eingabekomponente zur Vorlage des Absatzes, in dem Inhalt mit einem Produkt verknüpft werden soll:

FS_INDEX-Eingabekomponente in Absatzvorlage

<FS_INDEX name="st_product" height="1" useLanguages="no">
    <LANGINFOS>
        <LANGINFO lang="*" label=""/>
    </LANGINFOS>
    <SOURCE name="FirstSpirit Connect for Commerce/FirstSpirit Connect for Commerce - Products Data Access Plugin"/>
</FS_INDEX>

Auf dieselbe Art und Weise können Inhalte sowohl mit Kategorien, als auch mit weiteren Inhaltsseiten verknüpft werden. Lediglich das anzubindende DAP muss entsprechend ausgetauscht werden. Zur Verfügung stehen folgende drei DAPs:

FirstSpirit Connect for Commerce - Products Data Access Plugin
FirstSpirit Connect for Commerce - Categories Data Access Plugin
FirstSpirit Connect for Commerce - ContentPages Data Access Plugin

Die Verknüpfung der Bridge-Endpunkte mit denen des Shops ist abgeschlossen, sobald die Reports im ContentCreator die gewünschten Shop-Daten bereitstellen. Dies entspricht gleichzeitig einem erfolgreichen Ende-zu-Ende-Test.

Die in FirstSpirit verwendeten Produkt- und Kategorieinformationen müssen stets den realen Daten im Shop zuzuordnen sein. Dies ist insbesondere bei Anpassungen an bestehenden IDs zu berücksichtigen. Da sie die Grundlage für das Mapping der Daten bilden, sind Veränderungen an den IDs nicht zu empfehlen und daher grundsätzlich zu vermeiden.

Sind dennoch Änderungen erforderlich, synchronisieren sich sowohl die in den Reports dargestellten als auch die in DAPs enthaltenen Informationen eigenständig. Die in den Eingabekomponenten von Produkt- und Kategorieseiten gespeicherten IDs erfordern jedoch eine Aktualisierung. In allen Fällen ist zwingend sicherzustellen, dass eine in FirstSpirit gespeicherte Information zu der aus dem Shop identisch ist. Andernfalls ist ein manueller Aufwand unvermeidbar.

7.2. Darstellung von Inhalten in der Storefront

Nach der FirstSpirit-seitigen Erstellung oder Pflege redaktioneller Inhalte findet mit deren Speicherung und Freigabe eine automatische Übertragung in den CaaS statt. Dieser persistiert die Inhalte im JSON-Format in Form von Inhaltsfragmenten und stellt sie über eine REST-Schnittstelle bereit. Die Storefront nimmt diese Informationen entgegen und verknüpft sie mit denen des Shops, um sie in einer kombinierten Ansicht auszuliefern.

Die Übertragung der CaaS-Inhalte in die Storefront ist auf Basis einer Eigenimplementierung möglich. Diese muss auf den angebundenen Shop abgestimmt sein, weshalb eine detaillierte Anleitung an dieser Stelle nicht möglich ist.

Unabhängig von der gewünschten Übertragungsform sind jedoch grundsätzlich die folgenden Punkte zu berücksichtigen:

Authentifizierung
Abfrage der Daten
Transformation der Daten
Ausgabe der Daten
Caching

Authentifizierung: Die Abfrage von Daten aus dem CaaS setzt einen API Key voraus, welcher vor unerlaubten Zugriffen zu schützen ist. Er besitzt den Stellenwert eines Passworts und ist daher entsprechend zu behandeln. Andernfalls sind die im CaaS gespeicherten Inhalte frei zugänglich.
Abfrage der Daten: Bei der Abfrage der redaktionellen Inhalte aus dem CaaS ist es wichtig, die richtigen Daten abzufragen. Aus diesem Grund ist darauf zu achten, dass sich die in FirstSpirit verwendeten Produkt- und Kategorieinformationen stets den realen Daten im Shop zuordnen lassen. Dafür ist ein Mapping erforderlich, das auf eindeutigen IDs basiert und bereits durch die Bridge vorgegeben sein muss. Die IDs werden ihrerseits in den Formulardaten eines FirstSpirit-Elements gespeichert und per Freigabe mit in den CaaS übertragen. Auf Basis der IDs ist damit sowohl eine Abfrage der im CaaS gespeicherten FirstSpirit-Daten als auch ihre Verknüpfung mit den Shopdaten möglich.

Informationen über die Struktur sind im Gegensatz zu den redaktionellen Inhalten im NavigationService gespeichert. Für die Implementierung einer Navigation sind daher jegliche Datenabfragen gegen diesen zu richten.

Transformation der Daten: Der CaaS speichert die an ihn übergebenen Daten im JSON-Format in Form von Inhaltsfragmenten. Diese sind zum Teil sehr verschachtelt und enthalten darüber hinaus Informationen, die für die Ausgabe in der Storefront irrelevant sind. Aus diesem Grund ist es sinnvoll, im ersten Schritt ihrer Verarbeitung eine Transformation durchzuführen. In diesem Schritt ist es empfehlenswert, die Daten auf das Wesentliche zu reduzieren und in ein für die Storefront optimales Format zu übertragen. Außerdem ist darauf zu achten, dass verknüpfte Informationen, wie beispielsweise Medien-URLs, korrekt aufgelöst werden.
Ausgabe der Daten: Die Ausgabe der redaktionellen Inhalte übernimmt weiterhin die Storefront. Diese bezieht sie jedoch nicht mehr ausschließlich aus dem Shop-Backend, sondern zusätzlich aus dem CaaS. Die Storefront verknüpft die Daten miteinander, um sie in einer kombinierten Ansicht auszuliefern.

Genauso wie bei der Abfrage der Daten aus dem CaaS ist auch bei ihrer Ausgabe darauf zu achten, dass die in FirstSpirit verwendeten Informationen stets mit den realen Shop-Daten übereinstimmen. Dies beinhaltet nicht nur die Darstellung der richtigen Inhalte, sondern auch deren korrekte Platzierung. Innerhalb des in der Auslieferung enthaltenen Referenzprojekts FirstSpirit Connect for Commerce Reference Project werden die editierbaren Bereiche einer Shopseite durch die Inhaltsbereiche einer FirstSpirit-Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils der äquivalenten Komponente einer Shopseite entsprechen. Dies ist bei der Ausgabe der redaktionellen Inhalte zu berücksichtigen und umzusetzen.
Caching: Die in der Storefront dargestellten Inhalte werden dynamisch aus dem CaaS ermittelt. Jeder Aufruf der Shopseite erzeugt somit eine CaaS-Abfrage. Dies würde insbesondere zu bestimmten Events, wie beispielsweise dem Black Friday, zu einem umfangreichen Datenaufkommen führen. Um sowohl Performance-Probleme als auch die Kosten für einen hohen Datenverkehr zu vermeiden, ist eine projektspezifische Umsetzung einer Caching-Strategie dringend empfohlen.

7.3. Create Reference Page Executable

Für die Erzeugung von Shop Driven Pages steht das FirstSpirit Connect for Commerce - Create Reference Page Executable zur Verfügung. Dieses kann über die execute Methode der TPP-SNAP-API aufgerufen werden.

Dem Executable werden beim Aufruf folgende Argumente in Form eines JavaScript Objekts übergeben:

id (erforderlich)
fsPageTemplate (erforderlich)
type - (erforderlich)
displayNames - (optional)

Beispielhafte Methode zum Aufrufen des FirstSpirit Connect for Commerce - Create Reference Page Executable

const createReferencePage = () => {
        payload = {
            id: 'pageId',
            fsPageTemplate: 'product',
            type: 'product',
            displayNames: {
                DE: 'Displayname DE',
                EN: 'Displayname EN'
            }
        };
        TPP_SNAP.execute('class:FirstSpirit Connect for Commerce - Create Reference Page', payload);
};

Das FirstSpirit Connect for Commerce Modul erzeugt eine Seite mit den übergebenen Werten. id entspricht dem identifier der Seite im Shopsystem und wird im FormData der zu erstellenden Seite hinterlegt. type entspricht dem Seitentyp (product, category oder content) und wird ebenfalls im FormData der Seite hinterlegt. Diese Kombination macht eine Seite eindeutig identifizierbar und einer Seite im Shopsystem zuordenbar. Seiten vom Typ product besitzen immer ein Äquivalent im Produkte-Report, Seiten vom Typ category ein Äquivalent im Kategorie-Report und Seiten vom Typ content ein Äquivalent im Inhaltsseiten-Report. fsPageTemplate gibt an auf welcher FirstSpirit Seitenvorlage die zu erstellende Seite basiert. Über das optionale displayNames Objekt werden die gewünschten Anzeigenamen in den im FirstSpirit-Project verfügbaren Sprachen definiert. Dabei ist wichtig, dass die Attributnamen der Abkürzung der in FirstSpirit konfigurierten Sprache entsprechen. Falls keine displayNames oder diese nicht für alle Projektsprachen übergeben werden, wird der Anzeigename für die fehlenden Sprachen, nach dem Schema <pageType>_<id> gesetzt.

8. Fehlercodes

Fehlern, die während der Verwendung der Frontend API auftreten, wird ein Fehlercode zugewiesen. Dieser hilft bei der Behebung der zu Grunde liegenden Probleme. Die folgende Tabelle listet diese Codes und mögliche Fehlerbehebungen auf.

Code	Beschreibung	Mögliche Lösung
0000	Unbekannter Fehler
1020	Vorlage nicht zugewiesen	Überprüfen Sie die Vorlagenzuweisung
1030	Feld nicht eindeutig	Verwenden Sie einen anderen Wert
1040	Pflichtfeld nicht gefüllt	Geben Sie einen Wert an
2010	Seite existiert bereits in FirstSpirit	Prüfen Sie, ob sich die Seite im CaaS befindet
2020	Vorlage nicht zugewiesen	Überprüfen Sie die Vorlagenzuweisung
2030	Ungültiger Seitentyp	Verwenden Sie "product", "category" oder "content"
2040	Falsch formatierte displayNames	Überprüfen Sie das Format der displayNames beim Erstellen einer Shop-getriebenen Seite
2050	Ein notwendiger Parameter fehlt	Überprüfen Sie, ob die Anfrage alle notwendigen Parameter enthält beim Erstellen einer Shop-getriebenen Seite
3010	FirstSpirit kann sich nicht mit der Bridge verbinden	Überprüfen Sie die Konfiguration
3020	FirstSpirit erhält 401 von der Bridge	Überprüfen Sie die Konfiguration
3030	FirstSpirit erhält 500 von der Bridge	Überprüfen Sie die Bridge Logs
3040	FirstSpirit erhält 408 von der Bridge	Überprüfen Sie den Bridge Service
3050	FirstSpirit kann sich nicht mit der ContentCreator Extension verbinden	Überprüfen Sie die Konfiguration
8010	Frontend API Server kann sich nicht mit CaaS verbinden	Überprüfen Sie die Konfiguration
8020	Frontend API Server erhält 401 vom CaaS	Überprüfen Sie den konfigurierten API-Schlüssel
8030	Frontend API Server kann sich nicht mit dem Navigation Service verbinden	Überprüfen Sie die Konfiguration
8040	Frontend API Server erhält 401 vom Navigation Service	Überprüfen Sie den konfigurierten API-Schlüssel
8050	Kann Absatz nicht mittels TPP anlegen	Prüfen Sie, ob die Seite in FirstSpirit existiert
8060	Seite nach Erstellung nicht in CaaS gefunden	Überprüfen Sie das CaaS-Deployment
8070	Fehlender Parameter in Anfrage an Frontend API Server für findPage	Stellen Sie die benötigten Parameter bereit
8080	Fehlender Parameter in Anfrage an Frontend API Server für fetchNavigation	Stellen Sie die benötigten Parameter bereit
8090	Seite kann nicht angelegt werden (unbekannter Grund)
8100	Kann Seite nicht im CaaS finden	Überprüfen Sie, ob die Seite im CaaS existiert

Code

Beschreibung

Mögliche Lösung

0000

Unbekannter Fehler

1020

Vorlage nicht zugewiesen

Überprüfen Sie die Vorlagenzuweisung

1030

Feld nicht eindeutig

Verwenden Sie einen anderen Wert

1040

Pflichtfeld nicht gefüllt

Geben Sie einen Wert an

2010

Seite existiert bereits in FirstSpirit

Prüfen Sie, ob sich die Seite im CaaS befindet

2020

Vorlage nicht zugewiesen

Überprüfen Sie die Vorlagenzuweisung

2030

Ungültiger Seitentyp

Verwenden Sie "product", "category" oder "content"

2040

Falsch formatierte displayNames

Überprüfen Sie das Format der displayNames beim Erstellen einer Shop-getriebenen Seite

2050

Ein notwendiger Parameter fehlt

Überprüfen Sie, ob die Anfrage alle notwendigen Parameter enthält beim Erstellen einer Shop-getriebenen Seite

3010

FirstSpirit kann sich nicht mit der Bridge verbinden

Überprüfen Sie die Konfiguration

3020

FirstSpirit erhält 401 von der Bridge

Überprüfen Sie die Konfiguration

3030

FirstSpirit erhält 500 von der Bridge

Überprüfen Sie die Bridge Logs

3040

FirstSpirit erhält 408 von der Bridge

Überprüfen Sie den Bridge Service

3050

FirstSpirit kann sich nicht mit der ContentCreator Extension verbinden

Überprüfen Sie die Konfiguration

8010

Frontend API Server kann sich nicht mit CaaS verbinden

Überprüfen Sie die Konfiguration

8020

Frontend API Server erhält 401 vom CaaS

Überprüfen Sie den konfigurierten API-Schlüssel

8030

Frontend API Server kann sich nicht mit dem Navigation Service verbinden

Überprüfen Sie die Konfiguration

8040

Frontend API Server erhält 401 vom Navigation Service

Überprüfen Sie den konfigurierten API-Schlüssel

8050

Kann Absatz nicht mittels TPP anlegen

Prüfen Sie, ob die Seite in FirstSpirit existiert

8060

Seite nach Erstellung nicht in CaaS gefunden

Überprüfen Sie das CaaS-Deployment

8070

Fehlender Parameter in Anfrage an Frontend API Server für findPage

Stellen Sie die benötigten Parameter bereit

8080

Fehlender Parameter in Anfrage an Frontend API Server für fetchNavigation

Stellen Sie die benötigten Parameter bereit

8090

Seite kann nicht angelegt werden (unbekannter Grund)

8100

Kann Seite nicht im CaaS finden

Überprüfen Sie, ob die Seite im CaaS existiert

9. Rechtliche Hinweise

FirstSpirit Connect for Commerce ist ein Produkt der Crownpeak Technology GmbH, Dortmund, Germany.
Für die Verwendung des Moduls gilt nur die mit der Crownpeak Technology GmbH vereinbarte Lizenz.

10. Hilfe

Der Technical Support der Crownpeak Technology GmbH 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.

Dokumentation

für die Version 24.4.0
Aktualisiert: 18.04.2024

Unternehmen

Kontakt

Crownpeak Technology GmbH
Stockholmer Allee 24
44269 Dortmund, DE
+49 231 477 77 0
Kontaktieren Sie uns