Installation

Diese Anleitung basiert auf dem aktuellen SFRA-Code und der Referenzsite RefArchGlobal. Wenn Ihre SFCC-Einrichtung abweicht oder Sie eine alternative Einrichtung verwenden, können einzelne Schritte variieren, das grundlegende Installationsvorgehen bleibt jedoch gleich.

Schrittweise Installation

1. Client-seitige Abhängigkeiten installieren und Assets erstellen

Dieser Schritt ist nur erforderlich, wenn Sie SFRA verwenden und die Cartridge int_dqe_sfra einsetzen möchten. Wenn Sie SFRA oder die Cartridge int_dqe_sfra nicht verwenden, kann dieser Schritt übersprungen werden.

So gehen Sie vor:

1. Installieren Sie die npm-Abhängigkeiten, indem Sie folgenden Befehl ausführen:

   npm install

2. Öffnen Sie die Datei package.json und ändern Sie die Eigenschaft paths.base so, dass sie auf Ihr lokales SFRA-Verzeichnis verweist.

3. Führen Sie folgende Befehle aus, um JavaScript und SCSS zu kompilieren. Dadurch werden die clientseitigen Assets erstellt:

   npm run compile:js && npm run compile:scss

2. Cartridges hochladen

Sobald die Abhängigkeiten installiert und die clientseitigen Assets erstellt sind, laden Sie die Cartridges auf Ihre SFCC-Instanz hoch.

So laden Sie die Cartridges hoch:

• Laden Sie den Ordner cartridges mit CyberDuck oder einem anderen WebDAV-Client an den WebDAV-Speicherort Ihrer Sandbox hoch.
• Alternativ können Sie B2C Commerce UX Studio oder die Prophet-Debugger-Erweiterung für VS Code verwenden.

Weitere Anweisungen zum Hochladen von Cartridges in SFCC finden Sie in der offiziellen SFCC-Dokumentation.

3. Die Cartridge bei den einzelnen SFCC-Sites registrieren

Um die DQE-Integration für Ihren Storefront zu aktivieren, registrieren Sie die Cartridge im SFCC Business Manager.

So registrieren Sie die Cartridge:

1. Navigieren Sie im SFCC Business Manager zu Administration > Sites > Manage Sites.
2. Klicken Sie auf den Site-Namen der Storefront-Site, für die Sie die DQE-Engagement-Funktionalität hinzufügen möchten.
3. Wählen Sie den Tab Settings.

4. Fügen Sie Folgendes zum Effective Cartridge Path hinzu:

   • Wenn Sie SFRA verwenden, fügen Sie hinzu:

     int_dqe_sfra:int_dqe:

   • Wenn Sie SFRA nicht verwenden, fügen Sie nur hinzu:

     :int_dqe:

   Für einen SFRA-basierten Site-Pfad sollte es wie folgt aussehen:

   int_dqe_sfra:int_dqe:app_storefront_base

   

5. Klicken Sie auf Apply.
6. Wiederholen Sie die Schritte 2 bis 5 für jede Storefront-Site, auf der DQE Engagement implementiert werden soll.

Die BM-Cartridge global in SFCC registrieren

Um die DQE Business Manager (BM)-Erweiterung zu nutzen, registrieren Sie die BM-Cartridge bei der Business-Manager-Site.

So registrieren Sie die BM-Cartridge global:

1. Gehen Sie im Business Manager zu Administration > Sites > Manage Sites.
2. Klicken Sie auf den Link Manage the Business Manager site für die Site, bei der Sie die BM-Cartridge registrieren möchten.
3. Fügen Sie im Bereich Effective Cartridge Path bm_dqe: zur Liste der Cartridges hinzu.
4. Klicken Sie auf Apply, um die Änderungen zu speichern und die BM-Cartridge global zu registrieren.

Metadaten und Dienste in SFCC importieren

Um DQE-Metadaten und -Dienste in Ihre Salesforce-Commerce-Cloud(SFCC)-Instanz zu integrieren, importieren Sie die erforderlichen Konfigurationen wie unten beschrieben.

1. Zu Site Development navigieren

   Gehen Sie im SFCC Business Manager zu Administration > Site Development > Site Import & Export.

2. Metadaten-Dateien vorbereiten

   Alle Metadaten befinden sich im Ordner data/site_template.

   • Der Ordner data/site_template enthält Beispiel-DQE-Codezuordnungen und Validierungskonfigurationen für SFRA-Sites, einschließlich RefArch und RefArchGlobal.
   • Wenn Sie die Site ändern möchten, gehen Sie zu data/site_template/sites und benennen Sie den Ordner entsprechend Ihrer Site-ID um.
   • Um die Beispielkonfigurationen zu entfernen, öffnen Sie data/site_template/sites und löschen Sie alle Ordner und deren Inhalt.

3. Metadaten-Ordner archivieren

   Archivieren Sie den Ordner data/site_template aus dem Repository und bereiten Sie ihn für den Upload vor.

4. Archiv hochladen

   Wählen Sie im Bereich Upload Archive der Seite Site Import & Export den archivierten Ordner data/site_template aus und klicken Sie auf Select Upload.

5. Seite neu laden und Site-Template auswählen

   Wählen Sie nach dem Neuladen der Seite das Optionsfeld site_template, um zu bestätigen, dass Sie die richtigen Metadaten importieren.

6. Import

   Klicken Sie auf Import, um die DQE-Metadaten und -Dienste in Ihre SFCC-Instanz zu importieren.

Metadaten, Dienste und benutzerdefinierte Objekte in SFCC importieren

Je nach Ihrer Salesforce-Commerce-Cloud(SFCC)-Umgebung können Sie Metadaten, Dienste und benutzerdefinierte Objekte separat importieren.

1. Metadaten importieren

Metadaten-Dateien befinden sich im Ordner data/site_template/meta und sollten über den Business Manager hochgeladen werden.

Schritte:

1. Navigieren Sie zu BM > Administration > Site Development > Import & Export.
2. Laden Sie die XML-Metadaten-Dateien aus dem Ordner data/site_template/meta hoch.
3. Klicken Sie nach dem Hochladen auf Import Meta Data, um die Metadaten-Dateien zu importieren.

2. Dienste importieren

Die Datei data/site_template/services.xml enthält Dienste, die separat importiert werden können.

Schritte:

1. Navigieren Sie zu BM > Administration > Operations > Import & Export.
2. Laden Sie die Datei services.xml aus data/site_template hoch.
3. Klicken Sie nach dem Hochladen auf Import Services, um die Dienste zu importieren.

3. Benutzerdefinierte Objekte importieren

Die Definitionen der benutzerdefinierten Objekte für jede Site befinden sich unter data/site_template/sites/[site_id]/custom-objects/[custom_object_type].xml.

Schritte:

1. Navigieren Sie im Business Manager zu Merchant Tools > Custom Objects > Import & Export.
2. Laden Sie die XML-Dateien der benutzerdefinierten Objekte aus data/site_template/sites/[site_id]/custom-objects/ hoch.
3. Klicken Sie nach dem Hochladen auf Import Custom Objects, um die benutzerdefinierten Objekte zu importieren.

Cartridge-Metadaten nach dem Import

Nach dem Import der Metadaten, Dienste und benutzerdefinierten Objekte sollten die folgenden Attribute, Definitionen und Dienste im System erscheinen.

Systemobjektdefinitionen

• Site Preferences: DQE-Gruppe mit Attributen. Die spezifischen Attribute sind im entsprechenden Dokumentationsabschnitt aufgeführt.

Definitionen benutzerdefinierter Objekte und Beispielzuordnung für Sites

• dqeAddressValidationConfigs
• dqeEmailValidationConfigs
• dqePhoneValidationConfigs

Dienste

• dqe.http.address.suggestions.complete
• dqe.http.address.suggestions.search
• dqe.http.address.validate
• dqe.http.email.validate
• dqe.http.phone.validate

BM-Erweiterungszugriff gewähren

Standardmäßig wird kein BM-Benutzer für den Zugriff auf die DQE-Business-Manager-Module freigegeben. Gehen Sie wie folgt vor, um Zugriff zu gewähren:

1. Gehen Sie im SFCC Business Manager zu Administration > Organization > Roles.
2. Wählen Sie die Benutzerrolle aus, der Sie Zugriff gewähren möchten.
3. Gehen Sie zum Tab Business Manager Modules.
4. Wählen Sie den Sites Context aus und wählen Sie entweder alle Sites oder nur die gewünschten Sites aus.
5. Aktivieren Sie die Module im Abschnitt DQE.
6. Klicken Sie auf Update, um die Änderungen zu speichern.