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ß.

Die FirstSpirit Connect (Headless): For SAP Commerce Cloud (Headless) for SAP Commerce Cloud-Integration verknüpft die Digital Experience Platform FirstSpirit mit dem E-Commerce-Shopsystem SAP Commerce Cloud in Verbindung mit der Spartacus Storefront. Sie schafft dadurch ein leistungsstarkes Gesamtsystem, das die funktionalen Vorteile dieser Systeme kombiniert und die Bereitstellung moderner und personalisierter Inhalte ermöglicht.

Das vorliegende Dokument richtet sich an Serveradmins und beschreibt daher lediglich die Installation und Konfiguration des Moduls sowie den Import des Referenzprojekts auf dem FirstSpirit-Server. Alle im Projekt durchzuführenden Schritte sowie die mit der Integration zur Verfügung gestellten Funktionalitäten sind in der FirstSpirit Connect (Headless): For SAP Commerce Cloud (Headless) for Commerce Cloud-Dokumentation beschrieben.

Wird im restlichen Dokument die Formulierung "Commerce Cloud" verwendet, ist damit immer ausschließlich die SAP Commerce Cloud gemeint.
Dies gilt auch für die Kurzform "FirstSpirit Connect (Headless): For SAP Commerce Cloud", mit der innerhalb dieser Dokumentation grundsätzlich die FirstSpirit Connect (Headless): For SAP Commerce Cloud (Headless) for SAP Commerce Cloud-Integration gemeint ist.

Des Weiteren ist die gesamte Dokumentation auf die Anbindung der Spartacus Storefront ausgerichtet. Die Erwähnung der Storefront bezieht sich somit ausschließlich auf die Spartacus Storefront.

1.1. Funktionsumfang

FirstSpirit Connect (Headless): For SAP Commerce Cloud 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 werden mit der Installation und Konfiguration des Moduls innerhalb des WYSIWYG-Clients bereitgestellt.

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 aus der Commerce Cloud 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 beeinflusst weder die Storefront noch die Commerce Cloud.

1.2. Architektur

Die SAP-Shop-Architektur setzt sich standardmäßig aus der Commerce Cloud und der Spartacus Storefront zusammen. Während die Commerce Cloud in diesem System sämtliche Shopfunktionalitäten bereitstellt und alle Shopinhalte persistiert, dient die Spartacus Storefront der Auslieferung dieser Inhalte.

Mit der FirstSpirit Connect (Headless): For SAP Commerce Cloud (Headless) for SAP Commerce Cloud-Lösung integrieren sich FirstSpirit und der CaaS in diese Architektur und erweitern die Shopfunktionalitäten der Commerce Cloud. Die Integration schafft dadurch ein Gesamtsystem, das die funktionalen Stärken der einzelnen Systeme kombiniert. Innerhalb dieses Gesamtsystems repräsentieren FirstSpirit und die Commerce Cloud das Backend, während der CaaS die Middleware und die Storefront das Frontend bilden.

Die folgende Grafik zeigt die Highlevel-Architektur dieses Gesamtsystems:

sp architecture simple
Abbildung 1. Highlevel-Architektur

Innerhalb des neu geschaffenen Gesamtsystems übernimmt die Storefront weiterhin die Auslieferung der Inhalte, die sie standardmäßig aus der Commerce Cloud bezieht. Zusätzlich fragt sie jedoch die Inhalte der jeweiligen CaaS-Instanz ab und verknüpft sie mit denen der Commerce Cloud. Zu diesem Zweck wird sie durch die fs-spartacus-bridge-Bibliothek erweitert.

Im Gegensatz zur Auslieferung der Inhalte verlagert sich deren Erstellung und Pflege von der Commerce Cloud 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 Vorschau und Bearbeitung externer Inhalte im ContentCreator erlaubt (vgl. Abbildung Lowlevel-Architektur).

Durch die Einbettung der Staged Storefront in den Omnichannel Manager wird eine kombinierte Vorschau der Inhalte bereitgestellt, die in diesem Fall aus dem Preview CaaS und der Commerce Cloud 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, wie z.B. Shoppable-Videos, zur Verfügung.

Die Bereitstellung der Produkt- und Kategorieinformationen erfolgt über einen Report im ContentCreator. Dieser greift dafür über die CMS WebServices-Schnittstelle der Commerce Cloud auf den Product Catalog zu und ermittelt so die notwendigen Daten.

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 Commerce Cloud-Inhalten in den Shop integriert. Für die Darstellung der aus dem Referenzprojekt stammenden Inhalte muss die Storefront neben der Bridge die fs-spartacus-view-components-Bibliothek einbinden.

Das Gesamtsystem aus FirstSpirit, Spartacus und der Commerce Cloud besitzt damit eine Architektur, in der das redaktionelle Backend FirstSpirits klar von der Storefront getrennt ist. Eine Wartung FirstSpirits beeinflusst weder die Storefront noch die Commerce Cloud.

sp architecture
Abbildung 2. Lowlevel-Architektur

2. Installation und Konfiguration

Für die Verwendung der Funktionalitäten des FirstSpirit Connect (Headless): For SAP Commerce Cloud-Moduls ist FirstSpirit-seitig die Installation und Konfiguration unterschiedlicher Komponenten erforderlich. Die folgenden Unterkapitel erläutern die dafür notwendigen Schritte.

2.1. Installation der Module

Für die Bereitstellung der Funktionen des FirstSpirit Connect (Headless): For SAP Commerce Cloud-Moduls werden zusätzlich die Module CaaS Connect und Omnichannel Manager benötigt, die ebenfalls auf dem FirstSpirit-Server zu installieren sind. Beim Einsatz des mitgelieferten Referenzprojekts FirstSpirit Connect Reference Project ist darüber hinaus die Installation der BasicWorkflows, der CXT ContentCreator Extension und optional TranslationStudios erforderlich.

Die Auslieferung enthält nur das FirstSpirit Connect (Headless): For SAP Commerce Cloud-Modul. Das CaaS Connect- und das Omnichannel Manager-Modul sowie die BasicWorkflows, die CXT ContentCreator Extension und das TranslationStudio-Modul sind über den Technical Support zu beziehen.

Öffnen Sie für die Installation der Module den ServerManager und wählen Sie den Bereich Server-Eigenschaften  Module.

modules
Abbildung 3. Server-Eigenschaften - Modulinstallation

Im Hauptpanel ist eine Liste aller auf dem FirstSpirit-Server installierten Module zu sehen. Wählen Sie nach dem Klicken auf Installieren nacheinander die folgenden Dateien aus und bestätigen Sie die Auswahl jeweils mit Öffnen:

  • contentconnect-sap-module-<Versionsnummer>.fsm

  • caas-connect-<Versionsnummer>.fsm

  • fs-tpp-api-<Versionsnummer>.fsm

  • cxt-cc-extension-<Versionsnummer>.fsm (nur in Verbindung mit dem Referenzprojekt)

  • basicworkflows-fsm-<Versionsnummer>.fsm (nur bei der Verwendung der BasicWorkflows erforderlich)

  • translationstudio-<Versionsnummer>.fsm (nur bei der Verwendung TranslationStudios erforderlich)

Nach der erfolgreichen Installation wurden der Liste die Ordner FirstSpirit Connect (Headless): For SAP Commerce Cloud for SAP Commerce Cloud, CaaS Connect, FirstSpirit ThirdPartyPreview und optional die Ordner BasicWorkflows CXT ContentCreator Extension und FirstSpirit TranslationStudio hinzugefügt. Alle diese Ordner müssen jeweils Alle Rechte erhalten.

Die Module FirstSpirit Connect (Headless): For SAP Commerce Cloud, CaaS Connect und CXT ContentCreator Extension erfordern eine Konfiguration. Die dafür notwendigen Schritte sind in der FirstSpirit Connect (Headless): For SAP Commerce Cloud (Headless) for Commerce Cloud-Dokumentation und in der CaaS Connect-Dokumentation beschrieben.

Nach jeder Installation oder Aktualisierung eines Moduls ist ein Neustart des FirstSpirit-Servers notwendig.

2.2. Konfiguration des FirstSpirit Connect (Headless): For SAP Commerce Cloud-Moduls

Beim Aufruf der Commerce Cloud API wird ein Application Interface Key benötigt, der abhängig von der genutzten Anwendungsumgebung ist. Diese ist dem Modul über die Konfiguration des AIR Key Configuration Services anzugeben.

airkey config
Abbildung 4. Server-Eigenschaften - Modulkonfiguration

Zur Auswahl stehen die beiden folgenden Optionen:

  • PRODUCTION: Es liegt ein produktiver Einsatz der Commerce Cloud vor. Dies ist in der Regel in Kundenszenarien der Fall.

  • DEVELOPMENT: Die Commerce Cloud wird zu Entwicklungs- oder Demozwecken genutzt.

Nach der Konfiguration des Moduls ist ein Neustart des FirstSpirit-Servers notwendig.

2.3. Projekt-Import

Ein Bestandteil der Auslieferung ist das Referenzprojekt FirstSpirit Connect Reference Project, das auf dem FirstSpirit-Server zu installieren ist. Öffnen Sie dafür im ServerManager den Import-Dialog über den Menüpunkt Projekt  Importieren und wählen Sie über den Button Lokal die Datei spartacus-reference-project-<VERSION>.tar.gz aus ihrem lokalen Dateisystem aus. Vergeben Sie anschließend einen Projektnamen sowie eine Beschreibung und bestätigen Sie den Import mit Ja. Nach der erfolgreichen Installation wurde das Projekt der Liste im Hauptpanel hinzugefügt.

importedproject
Abbildung 5. Importiertes Projekt im ServerManager

Neben den Standardgruppen Everyone, Administrators und Developers existieren im Referenzprojekt drei weitere externe Gruppen: Editors, ChiefEditors und ProjectAdmins. Die Gruppen besitzen verschiedene Rechte, die entsprechend ihrer Aufgaben gewählt und für die verschiedenen Verwaltungen definiert wurden. Personen außerhalb dieser Gruppen sind standardmäßig nicht berechtigt das Referenzprojekt zu verwenden.

Die Verwendung der externen Gruppen setzt eine LDAP-Anbindung voraus. Andernfalls sind sie nicht nutzbar und die für sie gesetzten Rechte greifen nicht.

2.4. Hinzufügen der Web-Komponenten

Die FirstSpirit Connect (Headless): For SAP Commerce Cloud-Integration erfordert verschiedene Web-Komponenten, die dem verwendeten Projekt hinzuzufügen sind. Öffnen Sie hierfür den Bereich Server-Eigenschaften  Web-Applikationen im ServerManager.

Innerhalb des Hauptpanels sind verschiedene Registerkarten zu sehen, die jeweils eine Liste der bereits vorhandenen Web-Komponenten enthalten. Selektieren Sie die Registerkarte ContentCreator und fügen Sie ihr die folgenden Web-Komponenten hinzu:

  • BasicWorkflows_ContentCreator_Library (nur bei der Verwendung der BasicWorkflows erforderlich)

  • CXT ContentCreator Extension: WebApp for ContentCreator

  • FirstSpirit Connect (Headless): For SAP Commerce Cloud for SAP Commerce Cloud Web App

  • FirstSpirit ThirdPartyPreview WebApp

Wählen Sie die Web-Komponenten dafür mithilfe des Buttons Hinzufügen nacheinander aus und bestätigen Sie die Auswahl jeweils mit OK.

sp webcomponents
Abbildung 6. Web-Komponenten in den Server-Eigenschaften

Selektieren Sie in der Registerkarte abschließend einen aktiven Webserver über die gleichnamige Auswahlbox und starten Sie die Installation über den Button Installieren. Nach der erfolgreichen Installation öffnet sich ein Dialog, in welchem die Aktivierung des Webservers zu bestätigen ist.

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

2.5. Hinzufügen von Sprach-Vorlagen

FirstSpirit verfolgt konsequent das Konzept der Mehrsprachigkeit und erlaubt die Ausgabe unterschiedlicher Sprachvarianten. In dem durch die FirstSpirit Connect (Headless): For SAP Commerce Cloud-Integration geschaffenen Gesamtsystem übernimmt die Storefront die Auslieferung der Inhalte und bestimmt somit die Sprache, in der diese dargestellt werden. Aus diesem Grund müssen alle in der Storefront verfügbaren Sprachen im FirstSpirit-Projekt konfiguriert sein.

Fehlen in der Storefront verfügbare Sprachen im verwendeten FirstSpirit-Projekt, ist die Erzeugung redaktioneller Inhalte für diese Sprachen nicht möglich. Aufgrund dieser Abweichung können Fehler auftreten.

Damit Sprachen in einem FirstSpirit-Projekt verwendbar sind, müssen auf dem FirstSpirit-Server die entsprechenden Sprach-Vorlagen existieren. Öffnen Sie den Bereich Server-Eigenschaften  Sprach-Vorlagen im ServerManager, um diese hinzuzufügen.

Im Hauptpanel ist eine Liste aller bereits verfügbaren Sprach-Vorlagen zu sehen. Vergeben Sie nach dem Klicken auf Hinzufügen in dem sich öffnenden Bearbeitungsdialog einen Namen, eine Abkürzung und ein Sprachkürzel sowie optional einen Anzeigenamen für die neue Sprach-Vorlage. Bestätigen Sie die Eingabe mit dem Button OK, um die Erzeugung der Sprach-Vorlage abzuschließen. Nach der erfolgreichen Konfiguration ist die neue Sprach-Vorlage ebenfalls in der Liste im Hauptpanel sichtbar.

Detaillierte Informationen zur Erzeugung von Sprach-Vorlagen sind in der Online Dokumentation für FirstSpirit enthalten.

3. Rechtliche Hinweise

FirstSpirit Connect (Headless): For SAP Commerce Cloud 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.

4. 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.