fullmetrixDocs

Installation

Verbinden Sie Ihren Sylius-Shop Schritt für Schritt mit Fullmetrix, vom Abrufen des Codes bis zur Verbindungsbestätigung, mit der Wirkung jedes Befehls.

Diese Seite folgt der tatsächlichen Reihenfolge der Verbindung. Die für Ihren Entwickler gekennzeichneten Teile können Sie unverändert an ihn weiterleiten. Das Hinzufügen des Plugins dauert einige Minuten, plus die Zeit Ihres üblichen Deployment-Prozesses. Der Import der Historie hängt danach vom Volumen Ihres Shops ab.

Halten Sie zwei Dinge bereit

Den Namen der Person, die Ihr Sylius-Projekt entwickelt (Entwickler oder Agentur), und ein Sylius-Admin-Konto. Prüfen Sie außerdem die Kompatibilität Ihres Shops.

Ihren Verbindungscode abrufen

Der Verbindungscode verknüpft Ihren Shop mit Ihrer Fullmetrix-Organisation. Er sieht so aus: FMTX-7K4M-Q2HD-9WXR. Er funktioniert nur einmal. Sobald ein Shop ihn akzeptiert hat, lässt er sich nirgendwo anders mehr verwenden.

Im Einrichtungsassistenten

Die Organisation anlegen und die Grundlagen festlegen

Geben Sie auf dem Bildschirm Willkommen bei Fullmetrix unter Shop-Name einen Namen ein und klicken Sie dann auf Erstellen und fortfahren. Wählen Sie auf dem Bildschirm Grundeinstellungen Ihre Zeitzone und Währung und klicken Sie dann auf Speichern und fortfahren, oder auf Diesen Schritt überspringen, um es später unter Allgemein zu tun.

Sylius auswählen

Klicken Sie auf dem Bildschirm Shop verbinden auf die Zeile Sylius, beschriftet mit Sylius 1.13+ / 2.0. Fullmetrix zeigt eine Sekunde lang Verbindungscode wird generiert... an.

Current Fullmetrix platform selector with the Sylius card highlighted

Den Befehl und den Code kopieren

Der Bildschirm zeigt zwei nummerierte Felder.

  • Extension installieren enthält den Composer-Befehl. Die Schaltfläche rechts kopiert ihn und zeigt Befehl kopiert an.
  • Shop verbinden enthält Ihren Verbindungscode. Ein Klick kopiert ihn und zeigt kopiert an.

Unter diesen Feldern bittet Sie das Panel Warten auf Plugin-Verbindung, die Seite geöffnet zu lassen. Es aktualisiert sich von selbst, sobald Ihr Shop den Code akzeptiert.

Sie können die Seite schließen und später zurückkehren. Wenn Sie sich wieder bei Fullmetrix anmelden, setzt der Assistent am selben Punkt mit demselben Code fort. Der Link Plattform wechseln führt Sie zur Liste zurück, falls Sie die falsche Plattform gewählt haben.

Über die Einstellungen

Wenn Sie den Assistenten schon abgeschlossen haben oder einen Shop hinzufügen, öffnen Sie Einstellungen und dann den Tab Integrationen. Klicken Sie in der Kategorie E-Commerce auf der Karte E-Commerce-Shop auf Verbinden, oder auf die Kachel Shop hinzufügen, wenn bereits ein Shop verbunden ist. Wählen Sie im Fenster Plattform verbinden den Eintrag Sylius.

Das Fenster zeigt den Verbindungscode mit einer Kopierschaltfläche, den Installationsbefehl und einen Link Anleitung an meinen Entwickler senden.

Die Installation an Ihren Entwickler übergeben

Die Anleitung per E-Mail senden

Klicken Sie im Fenster Plattform verbinden auf Anleitung an meinen Entwickler senden. Geben Sie unter E-Mail des Entwicklers seine Adresse ein und klicken Sie dann auf Anleitung senden. Die Meldung Anleitung an gefolgt von der Adresse und gesendet bestätigt den Versand.

Ihr Entwickler erhält eine E-Mail mit den Installationsschritten, Ihrem Verbindungscode und dem Pfad zum Fullmetrix-Menü in Sylius. Dieser Link wird im Einrichtungsassistenten nicht angeboten. Kopieren Sie im Assistenten den Befehl und den Code und senden Sie sie selbst, zusammen mit einem Link zu dieser Seite.

Der Code ist vertraulich

Wer Ihren Code hat, kann einen Shop damit verbinden. Senden Sie ihn nur an die Person, die das Plugin installiert, und legen Sie ihn niemals im Code-Repository, in einem öffentlichen Ticket oder in einem geteilten Screenshot ab.

Das Plugin zum Projekt hinzufügen (für Ihren Entwickler)

Das Plugin ist das Composer-Paket fullmetrix/sylius-plugin. Es wird als Symfony-Bundle hinzugefügt. Installieren Sie es in Ihrer Entwicklungsumgebung, prüfen Sie es und deployen Sie es dann mit Ihrem üblichen Prozess. Sichern Sie die Datenbank, bevor Sie die Produktionsmigration ausführen.

Das Paket installieren

Führen Sie im Projektstamm den folgenden Befehl aus.

composer require fullmetrix/sylius-plugin

Er lädt das Plugin herunter und fügt es zu composer.json und composer.lock hinzu.

Das Bundle registrieren

Prüfen Sie, dass config/bundles.php diese Zeile enthält, und fügen Sie sie hinzu, falls Composer es nicht getan hat.

Fullmetrix\SyliusPlugin\FullmetrixPlugin::class => ['all' => true],

Sie weist Symfony an, das Plugin in jeder Umgebung zu laden. Das Plugin bringt seine eigene Konfiguration mit, es ist also keine Konfigurationsdatei hinzuzufügen.

Die Routen importieren

Legen Sie die Datei config/routes/fullmetrix.yaml mit diesem Inhalt an.

fullmetrix:
    resource: '@FullmetrixPlugin/Resources/config/routing.yaml'

Diese Routen öffnen die Seite Fullmetrix des Admins, die Adressen unter /fullmetrix/api/, die Fullmetrix aufruft, um den Shop zu lesen, und den Link, mit dem ein Käufer einen abgebrochenen Warenkorb fortsetzen kann.

Die Plugin-Tabellen anlegen

bin/console doctrine:migrations:migrate

Die Migration legt zwei kleine Tabellen an, eine für die Verbindungseinstellungen und eine für das im Admin angezeigte Aktivitätsprotokoll. Sie berührt keine Sylius-Tabelle.

Den Cache leeren

bin/console cache:clear

Leeren Sie den Cache mit derselben Umgebung wie die Live-Website, meist APP_ENV=prod. Ein Befehl, der ohne Fehler endet, bestätigt, dass Symfony das Plugin lädt.

Das Plugin braucht keine geplante Aufgabe. Es sendet Änderungen an Fullmetrix direkt, nachdem jede Antwort an den Besucher gesendet wurde.

Wenn die Website auf mehreren Servern läuft, deployen Sie überall dieselbe Version, führen Sie die Migration nur einmal aus und leeren Sie den Cache auf jedem Server.

Den Code in Sylius einfügen

Dieser Teil findet im Sylius-Admin statt. Sie können ihn selbst erledigen, sobald das Plugin deployt ist. Die Fullmetrix-Seite im Admin ist auf Englisch, unabhängig von der Sprache Ihres Admins.

Die Fullmetrix-Seite öffnen

Öffnen Sie den Sylius-Admin mit der öffentlichen HTTPS-Adresse Ihres Shops, also der, die Ihre Kunden verwenden. Das Plugin speichert diese Adresse, wenn Sie die Verbindung herstellen. Klicken Sie im linken Menü auf Marketing und dann auf Fullmetrix. Je nach Sylius-Version kann der Eintrag auch direkt im Hauptmenü erscheinen. Er führt immer zur Adresse /admin/fullmetrix.

Den Code einfügen und verbinden

Die Seite fasst die drei Verbindungsschritte zusammen. Fügen Sie Ihren Code in Connection code ein und klicken Sie dann auf Connect. Groß- oder Kleinschreibung und Leerzeichen um den Code spielen keine Rolle.

Fullmetrix-Seite des Sylius-Admins mit hervorgehobenem Feld Connection code und hervorgehobener Schaltfläche Connect

Die Bestätigung lesen

Die Seite lädt neu und zeigt ein Badge Connected, den Code schreibgeschützt und eine Schaltfläche Disconnect. Darunter erscheinen zwei Felder, Sync activity für den Import und Recent activity für das Protokoll.

Erscheint stattdessen ein rotes Banner Connection failed, folgt der Grund direkt danach. Die möglichen Gründe werden unter Fehlerbehebung erklärt.

Den Import verfolgen

Kehren Sie zu Fullmetrix zurück. Im Assistenten wechselt das Panel zu Plugin verbunden, und der Bildschirm geht von selbst weiter zu Ihr Arbeitsbereich wird vorbereitet. Ein Fortschrittsbalken begleitet den Import Ihrer Bestellungen, Produkte, Kunden und Umsatzhistorie. Mit der Schaltfläche Gehen Sie trotzdem zum Dashboard gelangen Sie in die App, ohne zu warten, während der Import im Hintergrund weiterläuft.

Über die Einstellungen schließt sich das Fenster mit der Meldung Import gestartet, und die Sylius-Karte zeigt Import läuft mit einem Prozentwert.

Auf der Sylius-Seite zeigt das Feld Sync activity zuerst Waiting for sync, dann Sync in progress und schließlich Sync complete mit der Anzahl der importierten Elemente pro Typ. Das Feld Recent activity listet die letzten 30 Ereignisse mit dem Datum (When), dem Typ (Type), der Meldung (Message) und der Anzahl der Elemente (Count). Die Schaltfläche Clear logs leert dieses Protokoll, ohne die Verbindung zu berühren.

Prüfen, ob alles funktioniert

  1. Öffnen Sie in Fullmetrix Einstellungen und dann Integrationen. Die Sylius-Karte zeigt die Shop-Adresse, einen grünen Punkt und die Zeile Letzte Sync.
  2. Geben Sie eine Testbestellung auf oder bearbeiten Sie ein Produkt. Die Änderung erscheint wenige Augenblicke später in Fullmetrix.
  3. Öffnen Sie Ihren Shop, rufen Sie ein paar Seiten auf und prüfen Sie dann die Zustellung der Ereignisse unter Tracking-Skript.

Das Plugin aktualisieren

Wenn eine neue Version erscheint, holt Ihr Entwickler sie mit Composer, führt eventuelle neue Migrationen aus, leert den Cache und deployt.

composer update fullmetrix/sylius-plugin
bin/console doctrine:migrations:migrate
bin/console cache:clear

Die Verbindung bleibt bei einem Update erhalten. Es muss kein Code erneut eingegeben werden.

Auf dieser Seite