FirstSpirit Connect for Spryker Commerce OS

Dokumentation für Server-Administratoren

e-Spirit AG

01.04.2021
Inhaltsverzeichnis

1. Einleitung

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

Im restlichen Dokument wird anstelle von "Spryker Commerce OS" die Kurzform "Spryker" benutzt.

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 sowohl aus FirstSpirit- als auch aus Spryker-seitigen Komponenten, die parallel und größtenteils entkoppelt voneinander arbeiten.

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 Spryker Commerce OS-Dokumentation beschrieben.

1.1. Funktionsumfang

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

  • Erstellung nativer Shop-Inhalte mit FirstSpirit
  • Zugriff auf Produkt- und Kategorieinformationen
  • gleichzeitige Darstellung von Shop-Elementen und redaktionellen Inhalten in der FirstSpirit-Vorschau
  • Übertragung von Inhalten in das Spryker Commerce OS

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 Spryker im Rahmen eines Deployments zum Import bereitgestellt. Spryker integriert die Informationen in den Shop.

Für Spryker 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 Spryker nicht.

1.2. Architektur

Die Verbindung von FirstSpirit und Spryker 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
  • Spryker-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 Storefront eingebettet.
  2. Die Storefront greift ihrerseits auf den Preview CaaS zu und ermittelt aus diesem die aktuellen FirstSpirit-Inhalte. Gleichzeitig bindet sie das für den Omnichannel Manager notwendige JavaScript ein, das die Bearbeitung und das Highlighting der Inhalte im ContentCreator ermöglicht.
  3. Die Übertragung der redaktionellen Inhalte in den Preview CaaS findet automatisch bei jeder Speicheraktion statt.
  4. Die Befüllung des Online CaaS mit den freigegebenen Inhalten wird durch ein Deployment angestoßen. Der Online CaaS stellt die Inhalte für den Importer zur Verfügung, der sie nach Spryker überträgt und dort persistiert.

Spryker stellt somit die Hauptkomponente dieser Architektur dar. Neben der Bereitstellung sämtlicher Shop-Funktionalitäten importiert es die in FirstSpirit erstellten bzw. gepflegten Inhalte aus dem Online CaaS und integriert sie in den Shop. Zwischen FirstSpirit und Spryker existiert lediglich eine lose Kopplung. Die beiden Systeme arbeiten hauptsächlich parallel zueinander.

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, Content as a Service und Omnichannel Manager in der jeweils aktuellen Version
  • FirstSpirit (Legacy oder Isolated Modus) ab der Version 2020-08
  • Java 11
  • Spryker Commerce OS 202009.0 mit den Extensions Category CMS Blocks und Product CMS Blocks
  • php ab Version 7.3

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

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

Die Auslieferung enthält nur das FirstSpirit Connect-Modul. Das Content as a Service- und das Omnichannel Manager-Modul sowie das BasicWorkflows-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-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 jeweils mit Öffnen:

  • firstspirit-connect-spryker-<Versionnumber>.fsm
  • caas-<Versionnumber>.fsm
  • fs-tpp-api-<Versionnumber>.fsm
  • basicworkflows.fsm (nur bei der Verwendung der BasicWorkflows erforderlich)

Nach der erfolgreichen Installation wurden der Liste die Ordner FirstSpirit Connect for Spryker Commerce OS, Content as a Service, FirstSpirit ThirdPartyPreview und optional der Ordner BasicWorkflows 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. Projektimport

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.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 und Administrators existieren im Referenzprojekt drei weitere externe Benutzergruppen: Editors, ChiefEditors und ProjectAdmins. Die Gruppen besitzen verschiedene Rechte, die entsprechend ihrer Aufgaben gewählt und für die verschiedenen Verwaltungen definiert wurden. Benutzer 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.

Vor der aktiven Nutzung des Projekts für redaktionelle Arbeiten ist die einmalige Ausführung des Preview Deployments erforderlich. Dafür müssen sowohl die FirstSpirit- als auch die Spryker-seitigen Konfigurationsschritte vollständig durchgeführt sein.

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 Bereich Server-EigenschaftenWeb-Applikationen im ServerManager.

Innerhalb des Hauptpanels sind verschiedene Registerkarten zu sehen, die jeweils eine Liste der bereits vorhandenen Web-Komponenten enthalten. Fügen Sie den Registerkarten Vorschau und ContentCreator zunächst die FirstSpirit Connect for Spryker Commerce OS Web App hinzu. Ergänzen Sie in der Registerkarte ContentCreator darüber hinaus die FirstSpirit ThirdPartyPreview WebApp und optional die BasicWorkflows_ContentCreator_Library. Letztere ist ausschließlich bei der Nutzung der BasicWorkflows erforderlich. Wählen Sie die Web-Komponenten dafür mithilfe des Buttons Hinzufügen nacheinander aus und bestätigen Sie die Auswahl jeweils mit OK.

Selektieren Sie in beiden Registerkarten abschließend einen aktiven Webserver über die gleichnamige Auswahlbox und starten Sie die Installation in beiden Fällen ü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 {linkfsadoc}.

Web-Komponenten in den Server-Eigenschaften
Abbildung 4. Web-Komponenten in den Server-Eigenschaften


3. Rechtliche Hinweise

FirstSpirit Connect ist ein Produkt der e-Spirit AG, Dortmund, Germany.
Für die Verwendung des Moduls gilt nur die mit der e-Spirit AG vereinbarte Lizenz.

Details zu möglicherweise fremden, nicht von der e-Spirit AG hergestellten, eingesetzten Software-Produkten, deren eigenen Lizenzen und gegebenenfalls Aktualisierungsinformationen, finden Sie in der Datei THIRD-PARTY.txt, die mit dem Modul ausgeliefert wird.

Alle im ausgelieferten Referenzprojekt FirstSpirit Connect Reference Project enthaltenen Bilder stammen von dem Anbieter pixabay.