FirstSpirit Connect

For SAP Commerce Cloud

e-Spirit AG

29.07.2021
Inhaltsverzeichnis

1. Einleitung

FirstSpirit dient der Erstellung vielseitiger und projektspezifischer Inhalte. Mit dem Modul FirstSpirit Connect for SAP Commerce Cloud wurde die Möglichkeit geschaffen, diese Inhalte in das E-Commerce-Shopsystem SAP Commerce Cloud zu übertragen und dort zu nutzen.

Im restlichen Dokument wird anstelle von "SAP Commerce Cloud" die Kurzform "Commerce Cloud" benutzt. Damit ist immer ausschließlich die SAP Commerce Cloud gemeint.

Das Modul kombiniert die funktionalen Stärken beider Systeme, um so die besten Vorteile zu erzielen und ein erfolgreiches Gesamtsystem zu schaffen. Dieses Gesamtsystem besteht aus zwei Bereichen, die parallel und größtenteils entkoppelt voneinander arbeiten:

FirstSpirit-seitige Komponenten
Diese Komponenten dienen der Erstellung und Pflege der redaktionellen Daten. Sie werden im JSON-Format und in Form von Medien an die jeweilige Content as a Service-Instanz übermittelt und aus dieser von der Commerce Cloud abgefragt.
Commerce Cloud-seitige Komponenten
Diese Komponenten dienen der Einbindung der in FirstSpirit erstellten redaktionellen Inhalte. Die Commerce Cloud integriert diese Daten in den Shop.

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

Das vorliegende Dokument richtet sich an Serveradministratoren 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 for SAP Commerce Cloud beschrieben.

1.1. Funktionsumfang

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

  • Erstellung von Commerce Cloud-Inhalten mit FirstSpirit für eine oder mehrere Sites einer Commerce Cloud-Instanz
  • Zugriff auf Produkt- und Kategorieinformationen
  • gleichzeitige Darstellung von Shop-Elementen und redaktionellen Inhalten in der FirstSpirit-Vorschau
  • Übertragung von Inhalten in die Commerce Cloud

Die entsprechenden Funktionalitäten werden mit der Installation und Konfiguration des Moduls im ContentCreator bereitgestellt.

Die Pflege der Inhalte findet über die gewohnten FirstSpirit-Mittel statt. Mit FirstSpirit vertraute Redakteure benötigen daher keine darüber hinausgehenden Kenntnisse. Die Inhalte werden der Commerce Cloud im Rahmen eines Deployments zum Import bereitgestellt. Diese integriert die Informationen in den Shop.

Für die Commerce Cloud ergibt sich somit bei der Auslieferung redaktioneller Inhalte in den Live-Stand keinerlei Unterschied. Auch wenn der FirstSpirit-Server beispielsweise aufgrund von Wartungsarbeiten heruntergefahren wird, beeinflusst dies die Commerce Cloud nicht.

1.2. Architektur

Die Verbindung von FirstSpirit und der Commerce Cloud wird über eine Architektur aus verschiedenen Komponenten realisiert (vgl. Abbildung Architektur).

Diese Komponenten sind:

  • die auf dem FirstSpirit-Server installierten Module:

    • FirstSpirit Connect
    • Omnichannel Manager
    • Content as a Service
  • Commerce Cloud-Instanz
Architektur
Abbildung 1. Architektur


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

  1. Die Erstellung und Bearbeitung redaktioneller Inhalte findet FirstSpirit-seitig im ContentCreator statt. In diesem ist mithilfe des Omnichannel Managers die Staged Storefront der Commerce Cloud eingebettet.
  2. Die Staged Storefront greift ihrerseits auf den Preview CaaS zu und ermittelt aus diesem die aktuellen FirstSpirit-Inhalte. Gleichzeitig bindet er das Omnichannel Manager JavaScript ein, das die Bearbeitung und das Highlighting der Inhalte im ContentCreator ermöglicht.
  3. Die Bereitstellung von Produkt- und Kategorieinformationen erfolgt über einen Report. Dieser greift dafür über die CMS WebServices-Schnittstelle der Commerce Cloud auf deren Product Catalog zu und fragt so die notwendigen Daten ab.
  4. Neben dem Report nutzt außerdem das Modul die CMS WebServices-Schnittstelle. Es veranlasst die automatische Synchronisation FirstSpirit-seitig erstellter bzw. veränderter Inhaltsseiten im Content Catalog der Staged Storefront. Eine automatische Synchronisation der Informationen in die Online Storefront ist stets projektspezifisch zu entwickeln und existiert daher nicht.
  5. Die Übertragung der freigegebenen redaktionellen Inhalte in den Online CaaS erfolgt mithilfe einer Generierung. Dieser macht die Inhalte für die Online Storefront verfügbar, über den sie in den Shop integriert werden.

Die Commerce Cloud stellt somit die Hauptkomponente dieser Architektur dar. Neben der Bereitstellung sämtlicher Shop-Funktionalitäten fragt sie die in FirstSpirit erstellten bzw. gepflegten Inhalte aus dem Online CaaS ab und liefert sie an die Kunden aus. Zwischen beiden Systemen existiert lediglich eine lose Kopplung. Sie arbeiten hauptsächlich parallel zueinander. Wird der FirstSpirit-Server beispielsweise aufgrund von Wartungsarbeiten heruntergefahren, beeinflusst dies die Commerce Cloud nicht.

1.3. Technische Voraussetzungen

Für den Einsatz des FirstSpirit Connect-Moduls müssen die folgenden technischen Voraussetzungen erfüllt sein:

  • die Module FirstSpirit Connect und Content as a Service in der jeweils aktuellen Version
  • Omnichannel Manager in der Version 1.2.27 oder höher
  • FirstSpirit 2018-11 (Legacy oder Isolated Modus)
  • Java 8 oder 11
  • SAP Commerce Cloud 18.08

Bei der Verwendung des mitgelieferten Referenzprojekts FirstSpirit Connect Reference Project ist außerdem das BasicWorkflows-Modul in der jeweils aktuellen Version erforderlich.

Die Versionsnummer der Auslieferung unterscheidet sich von den Versionsnummern der einzelnen Bestandteile der Auslieferung. Sie folgt einem Schema aus zweistelliger Jahreszahl, Monatszahl und der Nummer des Releases innerhalb des jeweiligen Monats (zum Beispiel: 20.10.0 für das erste Release im Oktober 2020). Im Gegensatz dazu erhalten das Modul, das Referenzprojekt und das Add-on eigene Versionsnummern, die von der Versionsnummer der Auslieferung losgelöst sind.

2. Installation und Konfiguration

Für die Verwendung der Funktionalitäten des FirstSpirit Connect-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-Moduls werden zusätzlich die Module Content as a Service 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 und der CXT ContentCreator Extension erforderlich.

Die Auslieferung enthält nur das FirstSpirit Connect-Modul. Das Content as a Service- und das Omnichannel Manager-Modul sowie die BasicWorkflows und die CXT ContentCreator Extension sind über den Technical Support zu beziehen.

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

Server-Eigenschaften - Modulinstallation
Abbildung 2. 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 mit Öffnen:

  • contentconnect-sap-module-<Versionnumber>.fsm
  • caas-<Versionnumber>.fsm
  • fs-tpp-api-<Versionnumber>.fsm
  • cxt-cc-extension-<Versionsnummer>.fsm (nur in Verbindung mit dem Referenzprojekt)
  • basicworkflows-fsm-<Versionsnummer>.fsm (nur bei der Verwendung der BasicWorkflows erforderlich)

Nach der erfolgreichen Installation wurden der Liste die Ordner FirstSpirit Connect for SAP Commerce Cloud, Content as a Service, FirstSpirit ThirdPartyPreview und optional die Ordner BasicWorkflows und CXT ContentCreator Extension hinzugefügt. Alle diese Ordner müssen jeweils Alle Rechte erhalten.

Das Content as a Service-Modul enthält einen Service, über den eine Standardkonfiguration anzugeben ist. Die dafür notwendigen Schritte sind in der Content as a Service-Dokumentation beschrieben.

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

2.2. 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 ProjektImportieren und wählen Sie über den Button Lokal die Datei referenceproject-<VERSIONSNUMMER>.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.

Importiertes Projekt im ServerManager
Abbildung 3. 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.3. Hinzufügen der Web-Komponenten

Die FirstSpirit Connect-Integration erfordert verschiedene Web-Komponenten, die dem verwendeten Projekt hinzuzufügen sind. Öffnen Sie hierfür den ServerManager und wählen Sie den Bereich Projekt-EigenschaftenWeb-Komponenten.

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 Extension: WebApp for ContentCreator (nur in Verbindung mit dem Referenzprojekt)
  • FirstSpirit Connect 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.

Web-Komponenten in den Projekt-Eigenschaften
Abbildung 4. Web-Komponenten in den Projekt-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.

3. Rechtliche Hinweise

FirstSpirit Connect for SAP Commerce Cloud ist ein Produkt der e-Spirit AG, Dortmund, Germany.
Für die Verwendung des Moduls gilt gegenüber dem Anwender nur die mit der e-Spirit AG vereinbarte Lizenz.

4. Hilfe

Der Technical Support der e-Spirit AG bietet qualifizierte technische Unterstützung zu allen Themen, die FirstSpirit als Produkt betreffen. Weitere Hilfe zu vielen relevanten Themen erhalten und finden Sie in auch in unserer Community.