Gutscheinvorlage

Gutscheinvorlage im Backend

Die Gutscheinvorlage steuert das PDF, das beim Verkauf eines Gutscheinartikels fuer neu erzeugte Wertgutscheine entsteht. Als Druckvorlage vom Typ print_gutschein wird sie ueber die Wertgutschein-Einstellungen ausgewaehlt.

Inhaltsverzeichnis

Einsatzbereich

Diese Vorlage gehoert zum automatischen Wertgutscheinverkauf. Beim Einloesen eines bereits vorhandenen Gutscheins in einer Bestellung kommt sie nicht zum Einsatz. Das Backend nutzt sie, wenn aus einer offenen Bestellposition vom Artikeltyp Gutschein ein neuer Wertgutschein angelegt und als PDF ausgegeben wird.

  • Der Vorlagentyp ist print_gutschein und wird als Gutscheinverkauf (Wertgutschein) gefuehrt.
  • Die Vorlage wird in den Einstellungen zur automatischen Erstellung von Wertgutscheinen als Feld druckvorlage ausgewaehlt.
  • Die Funktion greift nur, wenn die automatische Wertgutschein-Erstellung fuer den jeweiligen Shop aktiv ist.
  • Als Ausloeser kommen Statuswechsel, Rechnungserstellung oder ein manueller Versand aus der Bestellung heraus in Frage.
  • Pro gekaufter Menge wird ein eigener Wertgutschein mit eigener Gutscheinnummer erzeugt.

Bei einer Gutscheinposition mit Menge 3 entstehen drei einzelne Wertgutscheine und damit drei PDF-Anhaenge. Die Vorlage sollte deshalb fuer einen einzelnen Gutschein gestaltet sein.

Formular fuer automatische Wertgutscheine

Die Gutscheinvorlage wird nicht direkt an der allgemeinen Gutscheintabelle konfiguriert, sondern im Formular form_gutscheinsetup der Wertgutschein-Einstellungen. Die Einstellungen werden pro Shop gespeichert.

Backend-Feld Formularbereich Bedeutung Auswirkung auf die Vorlage
multishop_id Shopauswahl Bestimmt, fuer welchen Shop die Einstellung gespeichert wird. Die ausgewaehlte Vorlage gilt fuer die automatische Gutschein-Erstellung dieses Shops.
aktiv Funktion ist aktiv Schaltet die automatische Erstellung ein oder aus. Nur bei aktivem Wert wird die Druckvorlage geladen und ein Gutschein-PDF erzeugt.
aktiv_typ Ausfuehren wenn Legt den Ausloeser fest. 0 steht fuer Statuswechsel, 1 fuer Rechnungserstellung. Bestimmt, bei welchem Bestellereignis die Vorlage zum Einsatz kommt.
send_email E-Mail versenden Steuert, ob die erzeugten PDFs an die Gutschein-E-Mail angehaengt werden. Die PDF-Erzeugung erfolgt vor dem Versand; ohne E-Mail-Versand wird kein Mailanhang verschickt.
orderstatus_aktion_check Statusauswahl bei Statuswechsel Mehrfachauswahl der Bestellstatus, die bei Ausloeser Statuswechsel erlaubt sind. Die Vorlage wird nur bei passenden Statuswerten verwendet.
orderstatus_nach_aktion_voll Bestellstatus bei vollstaendigem Versand Optionaler Folgestatus, wenn alle betroffenen Gutscheinpositionen verarbeitet wurden. Hat keinen direkten Einfluss auf das PDF, steuert aber den Ablauf nach der Erzeugung.
orderstatus_nach_aktion_teil Bestellstatus bei teilweisem Versand Optionaler Folgestatus, wenn nur ein Teil der Bestellung verarbeitet wurde. Hat keinen direkten Einfluss auf das PDF, steuert aber den Ablauf nach einer Teilerzeugung.
laufzeit Laufzeit in Jahren Legt fest, wie lange der neu erzeugte Wertgutschein gueltig ist. Bestimmt die Variable GUTSCHEIN_GUELTIG_BIS.
custgroup_ids Kundengruppen des Gutscheins Mehrfachauswahl der Kundengruppen, fuer die der neue Wertgutschein gilt. Beeinflusst die spaetere Einloesbarkeit, nicht den sichtbaren PDF-Inhalt.
druckvorlage Druckvorlage Auswahl einer vorhandenen Vorlage vom Typ print_gutschein. Dieser HTML-Inhalt wird gerendert und als PDF ausgegeben.

Die automatische Erstellung setzt die Warenwirtschaft voraus. Ist sie nicht aktiv, zeigt das Backend einen Setup-Hinweis und das Formular wird nicht weiter genutzt.

Erzeugungsablauf

  1. Das Backend laedt die Wertgutschein-Einstellungen des Shops.
  2. Bei Statuswechsel prueft es aktiv_typ und orderstatus_aktion_check; bei Rechnungserstellung prueft es den Rechnungsausloeser.
  3. Bereits versendete oder nicht passende Bestellungen werden nicht verarbeitet.
  4. Offene Bestellpositionen vom Artikeltyp Gutschein werden ermittelt.
  5. Fuer jede Einheit der Position wird ein neuer Wertgutschein erzeugt.
  6. Der Betrag des Wertgutscheins entspricht dem Positionsgesamtpreis geteilt durch die Menge.
  7. Die Vorlage aus druckvorlage wird geladen und mit den Gutscheinvariablen befuellt.
  8. Aus dem gerenderten HTML erzeugt der PDF-Manager die PDF-Datei.
  9. Wenn send_email aktiv ist, werden die erzeugten PDFs als Anhaenge an die Gutschein-E-Mail gesetzt.
  10. Nach erfolgreichem Versand entfernt das Backend die temporaer erzeugten PDF-Dateien wieder.

Variablen in der PDF-Vorlage

Die PDF-Druckvorlage bekommt beim Rendern exakt die Gutscheinvariablen aus der PDF-Erzeugung. Allgemeine Bestell-, Kunden- und Shopvariablen gehoeren zur E-Mail-Vorlage und sind fuer diese PDF-Vorlage nicht automatisch gesetzt.

Variable Quelle im Backend Bedeutung im PDF
GUTSCHEIN_NUMMER Neu erzeugter Wertgutschein Gutscheincode, der spaeter eingeloest wird.
GUTSCHEIN_GUELTIG_BIS Laufzeit aus den Wertgutschein-Einstellungen Gueltigkeitsdatum im deutschen Datumsformat.
GUTSCHEIN_BETRAG Restbetrag des neu erzeugten Wertgutscheins Formatierter Gutscheinbetrag.

Der alte oder naheliegende Variablenname GUTSCHEIN_WERT wird in dieser PDF-Erzeugung nicht gesetzt. Fuer den Betrag muss GUTSCHEIN_BETRAG verwendet werden.

Zusammenspiel mit der Gutschein-E-Mail

Die Druckvorlage bestimmt nur den Inhalt des einzelnen PDF-Anhangs. Wenn send_email aktiv ist, laedt das Backend zusaetzlich die E-Mail-Vorlage gutschein. Dort werden Kundendaten, Bestelldaten, Shopdaten und eine Liste der erzeugten Gutscheine verarbeitet.

  • Die PDF-Druckvorlage gestaltet jeden Gutscheinanhang einzeln.
  • Die E-Mail-Vorlage gestaltet Betreff, Text und die Darstellung mehrerer erzeugter Gutscheine.
  • Die erzeugten PDF-Dateien werden nur temporaer fuer den Versand gehalten.
  • Fehler beim Versand werden in der Bestellhistorie beziehungsweise als Systemmeldung dokumentiert.

Pruefung nach Aenderungen

  1. Eine aktive Wertgutschein-Konfiguration fuer den passenden Shop waehlen.
  2. Als Druckvorlage eine Vorlage vom Typ print_gutschein hinterlegen.
  3. Eine Testbestellung mit Gutscheinartikel und Menge groesser 1 anlegen.
  4. Den konfigurierten Ausloeser ausfuehren: Statuswechsel, Rechnungserstellung oder manueller Versand aus der Bestellung.
  5. Die erzeugten PDFs auf Gutscheinnummer, Gueltigkeit, Betrag und Layout pruefen.
  6. Bei aktivem E-Mail-Versand auch Betreff, Mailtext und Anhaenge gemeinsam pruefen.

Shopvariablen

Variable Beschreibung
SHOPNAME Firmenname o. Rechtsform
FIRMEN_LOGO das hinterlegte Firmenlogo als HTML Tag des (Multi-) Shops
EMAIL_SIG_TXT die TXT E-Mailsignatur des (Multi-) Shops
EMAIL_SIG_HTML die HTML E-Mailsignatur des (Multi-) Shops
MY_BANK eigener Bankname der Bankverbindung
MY_EMPFAENGER eigener Empfängername der Bankverbindung
MY_BLZ eigene BLZ der Bankverbindung
MY_KONTO_NR eigene Konto-Nr. der Bankverbindung
MY_IBAN eigene IBAN der Bankverbindung
MY_BIC eigene BIC der Bankverbindung
MY_NNAME eigener Nachname
MY_VNAME eigener Vorname
MY_STRASSE eigene Straße
MY_PLZ eigene PLZ
MY_ORT eigener Ort
MY_LAND eigenes Land
MY_TEL eigene Tel-Nr
MY_FAX eigene Fax-Nr
MY_EMAIL eigene E-Mail-Adresse
MY_USTID eigene USt-Id

Nach Aenderungen an der Gutscheinvorlage immer mit einem echten Gutscheinartikel testen. Nur dadurch werden Menge, Laufzeit, Gutscheinbetrag, PDF-Erzeugung und optionaler E-Mail-Anhang gemeinsam sichtbar.

War diese Seite hilfreich?

Hilf uns, das Handbuch weiter zu verbessern. Wenn etwas fehlt oder unverständlich ist, kannst Du direkt einen kurzen Kommentar senden.