Bulk Generator ausführen

In diesem Guide beschreiben wir dir, wie du den Bulk Generator startest bzw. dieser automatisch gestartet wird.

Einführung

Der Bulk Generator baut seit der Plugin Version 6.12.0 standardmäßig auf dem Symfony Messenger bzw. dem Shopware Message Queue auf. Dieser ermöglicht es die Generierung der SEO-Felder in einzelne Jobs aufzuteilen und diese parallel abzuarbeiten.

Weitere Informationen zum Message Queue und deren Einrichtung findest du unter: Shopware Dokumentation » Message Queue

Ab der Plugin-Version 6.14.17 kann alternativ zum Message Queue die Abarbeitung der Bulk Jobs über den SEO Professional Worker erfolgen. Da die Message Queue von Shopware auf vielen Systemen über keine ausreichende Skalierung verfügt bzw. durch andere Prozesse von anderen Plugins sowie dem Core oftmals blockiert ist, wird empfohlen den SEO Professional Worker zu verwenden.

Bulk Generator starten

1. Möglichkeit: Automatische Generierung durch Speicherung

Standardmäßig werden die Bulk Generatoren immer dann ausgeführt, wenn ein neues Produkt, Kategorie usw. angelegt oder aber Anpassungen an diesem vorgenommen werden. In diesem Fall wird nach der eigentlichen Speicherung geschaut, ob ein Bulk Template für das jeweilige Element definiert ist und anschließend in diesem Fall ausgeführt.

Ist diese automatische Generierung nicht gewünscht, so kann diese in den Einstellungen abgeschaltet werden. Weitere Informationen hierzu findest du unter SEO Professional » Weitere Einstellungen » SEO Einstellungen

Wichtiger Hinweis: Der Prozess wird nicht ausgeführt, wenn bei bestehenden Elementen lediglich die "Speichern"-Schaltfläche betätigt wird, da der Shopware Speicherprozess erst angestoßen wird, wenn sich ein Wert verändert hat.

2. Möglichkeit: Bulk Generatoren über die Administration starten

Sowohl im Produkt- als auch im Kategorie Bulk Generator Modul findest du oben in der Smart Bar die Schaltfläche Generator starten. Hierüber ist es möglich den Bulk Generator für alle Produkte bzw. alle Kategorien direkt aus der Adminstration heraus zu starten.

An dieser Stelle kann auch der aktuelle Status des Generators eingesehen werden:

Sollte es zu einem Fehler kommen, so wird dieser ebenfalls an dieser Stelle angezeigt:

Fehler entstehen in der Regel durch fehlerhafte Bulk Templates. In diesem Fall wurde in dem Template "Mein Meta-Title Template" die nicht definierte Variable "productdd" verwendet. Dieser Fehler muss entsprechend im Template behoben werden.

Anschließend kann der Generator über die Schaltfläche Generierung neu starten erneut gestartet werden.

3. Möglichkeit: Bulk Generatoren per Shopware CLI starten

Um die Bulk Generatoren für alle Produkte, Kategorien usw. per Shopware CLI durchlaufen zu lassen, werden die folgenden Shopware CLI Befehle bereitgestellt, die per Shell ausgeführt werden können:

# Produkt Bulk Generator starten
bin/console dreisc-seo:bulk-generator:product

# Kategorie Bulk Generator starten
bin/console dreisc-seo:bulk-generator:category

Über die Shopware CLI Befehle können die Bulk Generatoren auch nur für bestimmte SEO-Optionen und/oder Sprachen ausgeführt werden. Hierzu einige Beispiele:

# Produkt Bulk Generator nur für die SEO-Optionen metaTitle und metaDescription starten
# Mögliche SEO-Optionen:  metaTitle, metaDescription, url, robotsTag, facebookTitle, facebookDescription, twitterTitle, twitterDescription
bin/console dreisc-seo:bulk-generator:product --seoOptions=metaTitle,metaDescription

# Produkt Bulk Generator nur die Sprache mit den unten angegebenen Sprach-IDs starten.
# Die Sprach-IDs können in der Datenbanktabelle `language` nachgeschlagen werden.
bin/console dreisc-seo:bulk-generator:product --languageIds=2fbb5fe2e29a4d70aa5854ce7ce3e20b,019179485f7572dc9931a4960cf57cb2

# Produkt Bulk Generator nur die Sprache mit den unten angegebenen Sprach-IDs und die SEO-Optionen metaTitle und metaDescription starten
bin/console dreisc-seo:bulk-generator:product --seoOptions=metaTitle,metaDescription --languageIds=2fbb5fe2e29a4d70aa5854ce7ce3e20b

Des Weiteren kann über den Parameter keepExistingJobsRunning bestimmt werden, ob bereits hinterlegte Jobs behalten bleiben sollen. Im Standard werden immer nur die neuesten Jobs beibehalten.

# Produkt Bulk Generator nur die Sprache mit den unten angegebenen Sprach-IDs starten. Bestehende Bulk Jobs nicht entfernen.
bin/console dreisc-seo:bulk-generator:product --seoOptions=metaTitle,metaDescription --languageIds=2fbb5fe2e29a4d70aa5854ce7ce3e20b --keepExistingJobsRunning=1

In manchen Fällen ist es gewünscht die Bulk Generatoren nur für bestimmte Kategorien (und deren Unterkategorien) zu starten. Dies ist über den Parameter categoryIds bei dem Produkt Bulk Generator bzw. über restrictToCategoryIds bei dem Kategorie Bulk Generator möglich. Hierzu einige Beispiele:

# Produkt Bulk Generator
bin/console dreisc-seo:bulk-generator:product --seoOptions=metaTitle,metaDescription --categoryIds=76B9A60C35274E009540CAEEC336DA82,1F4C5B082DCE4A388E7D2DF57B266C7D

# Kategorie Bulk Generator
bin/console dreisc-seo:bulk-generator:product --seoOptions=metaTitle,metaDescription --restrictToCategoryIds=76B9A60C35274E009540CAEEC336DA82,1F4C5B082DCE4A388E7D2DF57B266C7D

Diese Befehle können bei Bedarf - wie jeder andere Shopware CLI Befehl auch - in den Server Cronjobs mit aufgenommen werden.

Bulk Generator ausführen

Nachdem die Bulk Generatoren gestartet wurden, müssen diese entsprechend ausführt werden. Im Plugin Standard geschieht dies über die Shopware Message Queue.

Ab der Plugin-Version 6.14.17 kann alternativ zum Message Queue die Abarbeitung der Bulk Jobs über den SEO Professional Worker erfolgen. Da die Message Queue von Shopware auf vielen Systemen über keine ausreichende Skalierung verfügt bzw. durch andere Prozesse von anderen Plugins sowie dem Core oftmals blockiert ist, wird empfohlen den SEO Professional Worker zu verwenden.

1. Möglichkeit: Bulk Jobs über die Message Queue ausführen

Die Message Queue von Shopware wird entweder über die Administration im Hintergrund oder aber über den Shopware CLI Befehl bin/console messenger:consume gestartet.

Weitere Informationen zum Message Queue und deren Einrichtung findest du unter:
Shopware Dokumentation » Message Queue

2. Möglichkeit: Bulk Jobs über den SEO Professional Worker ausführen (empfohlen)

Der SEO Professional Worker stellt die Alternative zur Shopware Message Queue dar und wurde speziell für die Abarbeitung der Bulk Jobs entwickelt.

Um den SEO Professional Worker nutzen zu können, musst du zunächst unter Marketing » SEO Professional » Weitere Einstellungen » Bulk Generatoren die Option Abarbeitung der Bulk Generatoren über auf den Wert SEO Professional Worker stellen.

Des Weiteren müssen für den SEO Professional Worker Cronjobs auf dem Server eingerichtet werden. Eine grundlegende Ausführung kann über die folgenden Cronjobs realisiert werden:

# Produkt Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run product --time-limit=280
# Kategorie Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run category --time-limit=280
# Media Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run media --time-limit=280

Um eine asynchrone Abarbeitung der Bulk Jobs zu ermöglichen, können die Ausführungen nach Bulk Typ, SEO Einstellung und Sprache aufgeteilt werden. Für kleinere Shops wird die folgende Konfiguration empfohlen, bei der die AI und Standard Bulk Jobs aufgeteilt werden. Da die AI Bulk Jobs in der Regel deutlich länger benötigen, wird so verhindert, dass die Standard Bulk Jobs durch die AI Bulk Jobs blockiert werden.

# Produkt Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai
# Kategorie Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai
# Media Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=default
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=ai

Es ist jedoch auch möglich die Cronjobs noch weiter zu spezifizieren. Eine Aufteilung nach SEO Opionen und Bulk Typen könnte wie folgt aussehen:

# Produkt Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=metaTitle
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=metaDescription
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=url
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=facebookTitle,facebookDescription
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=default --seoOptions=twitterTitle,twitterDescription
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=metaTitle
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=metaDescription
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=url
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=facebookTitle,facebookDescription
bin/console dreisc-seo:bulk-generator:run product --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=twitterTitle,twitterDescription
# Kategorie Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=metaTitle
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=metaDescription
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=url
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=facebookTitle,facebookDescription
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=default --seoOptions=twitterTitle,twitterDescription
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=metaTitle
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=metaDescription
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=url
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=robotsTag
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=facebookTitle,facebookDescription
bin/console dreisc-seo:bulk-generator:run category --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=twitterTitle,twitterDescription
# Media Bulk Generator ausführen (Sollte alle 5 Minuten ausgeführt werden [*/5 * * * *])
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=default --seoOptions=alt
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=default --seoOptions=title
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=alt
bin/console dreisc-seo:bulk-generator:run media --time-limit=280 --bulkGeneratorTypes=ai --seoOptions=title

Fehlerbehebung, wenn der Bulk Generator nicht startet

Ist das System nicht korrekt konfiguriert, so kann es sein, dass der Bulk Generator nicht startet. In diesem Fall sollte überprüft werden, ob die Message Queue korrekt eingerichtet ist und die Jobs verarbeitet werden können.

SEO Professional erstellt für die Bulk Template Jobs sogenannte Queue Messages. Diese werden von dem Shopware Standard entsprechend angestoßen und verarbeitet. Sollten deine Jobs wie oben im Screenshot zu sehen nicht verarbeitet werden, kann dies die folgenden Gründe haben:

1. Message Queue nicht eingerichtet

Der Message Queue von Shopware wird entweder über die Administration im Hintergrund oder aber über den Shopware CLI Befehl bin/console messenger:consume gestartet. Empfohlen wird die Ausführung über die CLI, da nur so die Jos auch dann abgearbeitet werden können, ohne das die Administration geöffnet ist. Des Weiteren ist so die parallele Verarbeitung der Jobs möglich.

Einen Guide hierfür findest du unter:
https://docs.shopware.com/de/shopware-6-de/tutorials-und-faq/message-queue-und-scheduled-tasks#admin-worker-deaktivieren-und-cli-worker-einrichten

2. Message Queue basiert auf altem Quellcode

Wurde der Message Queue per CLI realisiert, so ist es erforderlich diesen nach einem Shopware- oder aber Plugin Update einmal zu stoppen und anschließend neu zu starten.

Dies ist erforderlich, da der CLI einen PHP Prozess startet, der anderenfalls noch mit dem alten Quellcode des Cores / Plugins arbeitet und zu unerwarteten Fehlern führen kann.