Bootstrap

tfm_garan_label

Plugin bestellen

Frage stellen

Garantie-Label automatisch generieren in xt:Commerce

Das Plugin "tfm_garan_label" generiert automatisiert individuelle Garantie-Label für Ihre Produkte – über die 4tfm Guarantee Label API. Aus Hersteller, Artikelnummer und einer je Produkt hinterlegten Garantiedauer wird ein passendes PNG-Label erzeugt, heruntergeladen und im Shop gespeichert.

Die Generierung läuft vollständig automatisch per Cronjob im Hintergrund – Sie aktivieren pro Produkt lediglich eine Checkbox und hinterlegen die Garantiedauer, den Rest übernimmt das Plugin. Das generierte Label kann anschließend direkt auf der Produktseite angezeigt werden.

Screenshots

Installation & Konfiguration

Führen Sie die generelle Installationsanleitung für 4tfm-Plugins aus.

Nachdem das Plugin installiert und aktiviert ist, laden Sie den Administrationsbereich mit der F5-Taste neu.

Tragen Sie anschließend Ihren API-Key ein (siehe Plugin-Optionen) und aktivieren Sie den Cronjob "TFM Garan-Label Generator" unter Konfiguration > Cronjobs im xtAdmin-Bereich – dieser ist nach der Installation standardmäßig deaktiviert.

 

Plugin-Optionen:

OptionBeschreibungStandardwert
AktivierenAktiviert das Pluginfalse
API-KeyIhr persönlicher Zugangsschlüssel für die Guarantee Label API. Ohne gültigen API-Key generiert der Cronjob keine Label.leer
Log aktivierenAktiviert das Logging für den Cronjob (API-Requests/-Antworten und alle Verarbeitungsschritte).false
Anzeige Garan-LabelLegt fest, an welcher Stelle im Shop das generierte Label auf der Produktseite angezeigt wird (siehe Liste unten).Deaktiviert

 

Verfügbare Anzeigepositionen

Für "Anzeige Garan-Label" stehen folgende Positionen zur Auswahl, getrennt nach Theme:

Positionxt_responsiveew_evelations
Produktseite – "In Warenkorb"xt_responsive: Produktseite "In Warenkorb"ew_evelations: Produktseite "In Warenkorb"
Produktseite – "Unter Produktbeschreibung"xt_responsive: Produktseite "Unter Produktbeschreibung"ew_evelations: Produktseite "Unter Produktbeschreibung"

Zusätzlich steht die Position "Hookpoint tfm_guarantee_label_tab" zur Verfügung. Diese Option erscheint in der Auswahlliste nur, wenn zusätzlich das Plugin tfm_guarantee_label installiert und aktiviert ist. Wie diese funktioniert, lesen Sie unter "Einbinden an tfm_guarantee_label Stelle im Template".

WICHTIG: Es kann jeweils nur eine Anzeigeposition gleichzeitig gewählt werden. „Nach dem Ändern einer Option, sollten Sie Ihren Cache im xtAdmin Bereich leeren.

 

Produktoptionen

Im Produkt-Editor finden Sie unter dem Tab "Garan-Label" folgende Felder:

FeldBeschreibung
Garan-Label generierenCheckbox. Nur Produkte mit gesetztem Haken werden vom Cronjob berücksichtigt.
Hersteller überschreiben (optional)Ist dieses Feld gefüllt, wird sein Wert statt des am Produkt hinterlegten Herstellers als Marke an die API übergeben.
Garantiedauer (Jahre)Ganzzahliger Wert zwischen 1 und 99. Wird zusammen mit Hersteller und Artikelnummer an die API übergeben.
Garan-Label URLWird automatisch vom Cronjob befüllt, sobald ein Label generiert wurde. Enthält die relative Bild-URL innerhalb des Shops (z.B. media/images/garan-label/label-xyz.png). Nicht manuell befüllen.

WICHTIG: „Nach dem Ändern einer Option, sollten Sie Ihren Cache im xtAdmin Bereich leeren.

 

Datenherkunft für die Label-Generierung

Für den API-Aufruf werden ausschließlich bereits im Shop vorhandene bzw. am Produkt gepflegte Werte verwendet:

API-ParameterQuelle im Shop
brandFeld "Hersteller überschreiben" im Garan-Label Tab, falls gefüllt – sonst Hersteller des Produkts
modelArtikelnummer des Produkts
durationFeld "Garantiedauer (Jahre)" am Produkt

Ist bei einem aktivierten Produkt kein Hersteller hinterlegt, keine Artikelnummer gepflegt oder die Garantiedauer ungültig (leer oder außerhalb von 1–99), wird das Produkt übersprungen und im Log vermerkt.

 

Funktionsweise

Der Cronjob "TFM Garan-Label Generator" läuft standardmäßig alle 15 Minuten und verarbeitet je Durchlauf bis zu 20 Produkte, bei denen "Garan-Label generieren" aktiv und "Garan-Label URL" noch leer ist. Für jedes dieser Produkte wird die API aufgerufen, das zurückgelieferte PNG heruntergeladen und im Shop unter media/images/garan-label/ gespeichert. Die relative URL zur Bilddatei wird anschließend im Produktfeld "Garan-Label URL" hinterlegt.

Sobald für ein Produkt einmal eine URL gespeichert wurde, wird es bei künftigen Cronjob-Durchläufen nicht erneut verarbeitet – auch dann nicht, wenn sich Hersteller, Artikelnummer oder Garantiedauer nachträglich ändern. Um ein Label neu zu erzeugen, muss das Feld "Garan-Label URL" am Produkt manuell geleert werden; beim nächsten Cronjob-Lauf wird das Label dann neu generiert.

Sobald "Anzeige Garan-Label" auf eine Position gesetzt ist, erscheint das Label automatisch an der gewählten Stelle im Shop – aber ausschließlich bei Produkten, für die bereits ein Label generiert wurde (Feld "Garan-Label URL" nicht leer). Bei Produkten ohne generiertes Label erscheint an der Stelle nichts.

Fehler & Logging

Fehler und Statusmeldungen (fehlender API-Key, fehlender Hersteller/Artikelnummer, ungültige Garantiedauer, API-Fehler, erreichtes Rate-Limit/Kontingent, Verbindungsfehler) werden in die Datei xtLogs/tfm_garan_label.log geschrieben, wenn die Plugin-Option "Log aktivieren" aktiv ist.

 

Einbinden an tfm_guarantee_label Stelle im Template

Möchten Sie das Label an einer Stelle anzeigen, wo bereits das tfm_guarantee_label angezeigt wird, wählen Sie bei "Anzeige Garan-Label" die Position "Hookpoint tfm_guarantee_label_tab" (verfügbar, sofern zusätzlich das Plugin tfm_guarantee_label installiert und aktiviert ist).

×