Gambio Modul Popup Fabrik / v1.0.x

Konzept Popup Ausgabepunkt/-ereignis/-einschränkung

Mit dem Modul Popup Fabrik werden von Ihnen erstellte Popups zielgerichtet im Gambio-Shop ausgegeben. Gesteuert wird dies über die nachfolgenden Ausgabeparameter - welche von Ihnen bei Anlage eines Popups festgelegt werden. Das Modul stellt eine entsprechende Parameterauswahl bereit. Um Ihr Popup an einer gewünschten Stelle und unter geforderten Bedingungen im Shop ausgeben zu lassen, wählen Sie einfach relevante Parameter aus der Liste vorgegebener Werte aus.

Ausgabepunkt (Pflichteingabe)

Der Ausgabepunkt bestimmt den Ort, an dem das Popup angezeigt wird. Ein Ausgabepunkt entspricht in etwa einer Seite im Gambio Shop, z. B. die Produkt-Detailseite. Es kann aber auch ein abstrakter Bereich sein. Beispielsweise der Kunden-Login - welcher an mehreren Stellen des Shops (Kunden-Login-Seite, Kassenweg, etc.) angeboten wird. Die Angabe eines Ausgabepunktes ist bei Erstellung eines Popups eine Pflichteingabe.

Ausgabeereignis (Pflichteingabe)

Das Modul stellt für jeden Ausgabepunkt 1:n Ausgabeereignisse zur Auswahl bereit. Dabei hat jeder Ausgabepunkt eigene Ereignisse. Der Ausgabepunkt Kunden-Login hat u. a. das Ausgabeereignis Erfolgreicher Login, der Ausgabepunkt Produkt-Detailseite das Ausgabeereignis Anzeige Seite. Mit einem Ausgabeereignis wird für die Anzeige eines Popups eine eine erste Bedingung festgelegt. Das heißt, das Popup wird an dem Ausgabepunkt nur dann angezeigt, wenn das Ereignis (die Bedingung) eintritt (erfüllt ist). Die Angabe eines Ausgabeereignisses ist bei Erstellung eines Popups eine Pflichteingabe.

Ausgabeeinschränkung (optional)

Mit einer Ausgabeeinschränkung wird eine weitere Bedingung festgelegt. Diese muss ebenso erfüllt sein muss, damit es zur Anzeige des Popups kommt. Jedes Ausgabeereignis stellt dabei eigenen Ausgabeeinschränkungen zur Auswahl bereit. Eine Ausgabeeinschränkung wird über zwei Werte bestimmt: Ein auswählbarer Ausgabeeinschränkungsschlüssel und eine Liste an gültigen Ausgabeeinschränkungswerten. Die auswählbaren Ausgabeeinschränkungsschlüssel sind fest vorgebene Werte, z. B. Kunden-Id, Kundengruppen-Id, Produkt-Id, Kategorie-Id, etc. Die dazu passenden Ausgabeeinschränkungswerten müssen von Ihnen als kommagetrennt Liste eingegeben werden.

Beispiel:
Sie wählen als Ausgabeeinschränkungsschlüssel den Wert Artikel-Id. Als Ausgabeeinschränkungswert geben Sie nun eine kommagetrennte Liste an gültigen Artikel-Ids an. Gültig bedeutet in diesem Fall, dass das Popup nur dann angezeigt wird, wenn die Id des im Shop aufgerufenen Artikels in dieser Liste enthalten ist.

Um entsprechende Ausgabeeinschränkungswerte finden zu können, stellt die Popup-Konfigurationsseite entsprechende Suchfunktionen bereit. Mit deren Hilfe können Sie bequem gültige Werte für Ihre Liste ermitteln.

Beispielkonfigurationen

Mit Hilfe der nachfolgenden Beispiele soll das Konzept und das Zusammenspiel von Ausgabepunkt + Ausgabeereignis + Ausgabeeinschränkung an Hand von praxisnahen Anforderungen vermittelt werden.

Anforderung: Anzeige eines Popups, wenn sich ein Shop-Kunde aus der Kundengruppe Händler oder Admin im Shop einloggt

Um ein Popup unter diesen Vorgaben anzeigen zu lassen ist folgende Popup-Konfiguration nötig:

• Ausgabepunkt = Kunden-Login
• Ausgabeereignis = Erfolgreicher Login
• Ausgabeeinschränkung = Kundengruppen-Id
• Liste an gültigen Ausgabeeinschränkungswerten = 0,3 (0 = Kundengruppen-Id für Admins; 3 = Kundengruppen-Id für Händler)

Anforderung: Anzeige eines Popups, wenn die Produkt-Detailseite zu einem Produkt aus der Kategorie x oder y aufgerufen wird

Um ein Popup unter diesen Vorgaben anzeigen zu lassen ist folgende Popup-Konfiguration nötig:

• Ausgabepunkt = Produkt-Detailseite
• Ausgabeereignis = Anzeige Seite
• Ausgabeeinschränkung = Kategorie-Id
• Liste an gültigen Ausgabeeinschränkungswerten = x-id,y-id (x-id = Kategorie-Id von Kategorie x; y-id = Kategorie-Id von Kategorie y)

Anforderung: Anzeige eines Popups auf allen Shop-Seiten - aber nur einmal pro Session

Um ein Popup unter diesen Vorgaben anzeigen zu lassen ist folgende Popup-Konfiguration nötig:

• Ausgabepunkt = Alle Seiten
• Ausgabeereignis = Anzeige Seite
• Ausgabeeinschränkung = Keine Einschränkung
• Liste an gültigen Ausgabeeinschränkungswerten bleibt leer
• Anzeige einmal pro Session = aktiv

Übersicht verfügbarer Ausgabekonfigurationswerte

In dieser Modul-Version stehen für ein Popup folgende Ausgabekonfigurationswerte zur Verfügung:

Ausgabe­punkt	Ausgabe­ereignis	Ausgabe­einschränkungs­schlüssel
Alle Seiten	Anzeige Seite	Keine Einschränkung
Kunden-Login	Erfolgreicher Login	Keine Einschränkung Kunden-Id Kundengruppen-Id
Kunden-Registrierung	Erfolgreiche Registrierung	Keine Einschränkung
Produkt-Detailseite	Anzeige Seite	Keine Einschränkung Kategorie-Id Artikel-Id

Modul-Installation

Hochladen der Modul-Dateien

Entpacken Sie das Modul-zip-Paket.

In diesem zip-Paket finden Sie einen Datei-Ordner mit den Unterverzeichnissen admin und GXModules.

Ordner 'admin'

Laden Sie per FTP-Programm die Dateien aus Ihrem lokalen Ordner /admin/ in den Ordner [root]/admin/ am Server auf dem Ihr Shop installiert ist.

Ordner 'GXModules'

Laden Sie per FTP-Programm die Dateien aus Ihrem lokalen Ordner /GXModules/ in den Ordner [root]/GXModules/ am Server auf dem Ihr Shop installiert ist.

Caches leeren

Rufen Sie im Shop den Gambio-Admin-Bereich auf. Leeren Sie unter Toolbox > Cache die Caches in der nachfolgenden Reihenfolge:

1. Cache für Modulinformationen
2. Cache für Text
3. Cache für Seitenausgabe

Modul installieren

Wechseln Sie nach Module > Modul-Center. In der Liste der verfügbaren Module finden Sie einen Eintrag mit der Bezeichnung Lenk GmbH | Popup Fabrik. Markieren Sie diese Zeile. Durch einen Klick auf den Button Installieren installiert sich das Modul in den Shop.

Caches leeren

Nach der Installation müssen ein weiteres mal folgende Caches geleert werden:

1. Cache für Modulinformationen
2. Cache für Text
3. Cache für Seitenausgabe

Modul-Konfiguration

In der Modul-Konfiguration nehmen Sie Einstellungen vor, welche sich auf das globale Verhalten des Moduls auswirken. Die Modul-Konfiguration können Sie auf folgendem Weg aufrufen:

Öffnen Sie im Gambio-Admin-Bereich das Modul-Center. Suchen Sie in der Liste der verfügbaren Module nach dem Modul Lenk GmbH | Popup Fabrik. Markieren Sie die Zeile. Durch einen Klick auf den Button Bearbeiten öffnet sich die Modul-Konfiguration.

Allgemeine Einstellungen

Der Bereich Allgemeine Einstellungen hat aktuell nur eine Einstellmöglichkeit - den Schalter Modul aktivieren?. Mit dem Schalter wird die komplette Modul-Funktionalität ein- respektive ausgeschaltet. Steht der Status-Schalter auf aus/deaktiviert, werden neben der inaktiven Modul-Funktionalität auch alle Modul-Erweiterungen im Shop-Admin-Bereich sowie im Shop-Frontend nicht mehr angezeigt. Folglich werden im Shop auch keine Popups mehr ausgegeben, welche über das Modul konfiguriert wurden. Schalten Sie den Schalter auf ein/aktiviert. Vergessen Sie nicht Ihre Einstellung zu speichern!

Optional: Modul-Texte anpassen

Die vom Modul verwendeten Texte lassen sich im Shop anpassen. Wechseln Sie hierfür im Admin-Bereich zu Inhalte > Texte anpassen. Geben Sie unter Suchtext die Textpassage ein die Sie ändern möchten. Führen Sie anschließend die Suche aus. Jeder Suchtreffer lässt sich nach einen Klick auf Bearbeiten individuell anpassen.

Popups verwalten

Nach der Installation des Moduls finden Sie im Admin-Menü unter Inhalte den neuen Eintrag Popups. Über dieses Menüelement erreichen Sie die Verwaltung der Modul-Popups.

Popup-Übersicht

Ein Klick auf das Admin-Menüelement Inhalte > Popups öffnet die Übersicht über alle angelegten Popups. Dies ist der zentrale Verwaltungsbereich für Ihre Popups. Sie können neue Popups hinzufügen, bestehende Popups bearbeiten oder löschen.

Popup hinzufügen

Ein Klick auf den Button Hinzufügen öffnet die Seiten, in der Sie ein neues Popup anlegen können.

Interner Name (Pflichteingabe)

In das Feld Interner Name geben Sie einen Namen für das neue Popup ein. Der interne Name dient dazu, ein Popup in der Popup-Übersicht eindeutig identifizieren zu können. Das heißt, ein interner Name darf nicht doppelt vergeben werden. Ist der interne Name schon vergeben, wird eine Speicherung verweigert und es erscheint eine Fehlermeldung. Der interne Name wird nicht im Shop mit dem Popup angezeigt. Der interne Name ist eine Pflichteingabe.

aktiv

Mit dem Schalter aktiv entscheiden Sie, ob das Popup im Shop angezeigt wird (Schalter = aktiv) oder nicht (Schalter = inaktiv).

Ausgabepunkt (Pflichteingabe)

Mit diesem Wert legen Sie den Ausgabepunkt des Popups im Shop fest. Sie können aus einer Liste fest definierter Ausgabepunkte auswählen. Lesen Sie hierzu bitte das 1. Kapitel dieser Dokumentation über das Konzept. Die Angabe eines Ausgabepunktes ist eine Pflichteingabe.

Ausgabeereignis (Pflichteingabe)

Mit diesem Wert legen Sie das Ausgabeereignis fest, welches im Shop am Popup-Ausgabepunkt eintreten muss, damit das Popup im Shop angezeigt wird. Sie können aus einer Liste fest definierter Ausgabeereignisse auswählen. Die Auswahlmöglichkeit an Ausgabeereignissen ist dabei abhängig vom ausgewählten Ausgabepunkt. Das Ausgabeereignis-Auswahlfeld wird erst aktiv, wenn ein Ausgabepunkt ausgewählt wurde. Lesen Sie hierzu bitte auch das 1. Kapitel dieser Dokumentation über das Konzept. Die Angabe eines Ausgabeereignisses ist eine Pflichteingabe.

Ausgabeeinschränkung (bedingte Pflichteingabe)

Die Sektion Ausgabeeinschränkung besteht aus 3 Aktionsbereichen, welche nachfolgend erklärt werden. In dieser Sektion definieren Sie nach dem Ausgabeereignis optional eine weitere Bedingung, welche beim Eintreten des Popup-Ausgabeereignisses erfüllt sein muss, damit das Popup im Shop am Popup-Ausgabepunkt angezeigt wird. Lesen Sie hierzu bitte auch das 1. Kapitel dieser Dokumentation über das Konzept.

Ausgabeeinschränkungsschlüssel

Der Ausgabeeinschränkungsschlüssel definiert den Wert, auf den Sie die Ausgabe des Popups zusätzlich einschränken können. Ausgabeeinschränkungsschlüssel sind z. B. Kunden-Id, Artikel-Id, Kategorie-Id. Síe können aus vordefinierten Ausgabeeinschränkungsschlüsseln auswählen. Die Auswahlmöglichkeit ist dabei abhängig vom ausgewählten Ausgabeereignis. Das Ausgabeeinschränkungsschlüssel-Auswahlfeld wird erst aktiv, wenn ein Ausgabeereignis ausgewählt wurde. Lesen Sie hierzu bitte auch das 1. Kapitel dieser Dokumentation über das Konzept.

Ausgabeeinschränkungswert (bedingte Pflichteingabe)

In das Feld Ausgabeeinschränkungswert tragen Sie eine kommagetrennte Liste an gültigen Werten ein. Wählen Sie im Feld Ausgabeeinschränkungsschlüssel den Wert Artikel-Id aus, so tragen Sie hier eine kommagetrennte Liste an Artikel-Ids ein. Wählen Sie im Feld Ausgabeeinschränkungsschlüssel den Wert Kunden-Id aus, so tragen Sie hier eine kommagetrennte Liste an Kunden-Ids ein.

Im Shop wird ein Popup nur dann angezeigt, wenn am Popup-Ausgabepunkt das Popup-Ausgabeereignis eintritt und während des Ereignisses im Shop der Wert des ausgewählten Popup-Ausgabeeinschränkungsschlüssel in der Liste der Popup-Ausgabeeinschränkungswerte enthalten ist.

Das Ausgabeeinschränkungswerte-Inputfeld wird erst aktiv, wenn ein Ausgabeeinschränkungsschlüssel ausgewählt wurde. Wurde ein Ausgabeeinschränkungsschlüssel ausgewählt, so ist die Eingabe von Ausgabeeinschränkungswerte eine Pflichteingabe. Lesen Sie hierzu bitte auch das 1. Kapitel dieser Dokumentation über das Konzept.

Button zum Start einer Suche nach Ausgabeeinschränkungswerte

Ein Klick auf den Suche-Button (Button mit dem Lupe-Icon) öffnet die Suchfunktion. Mit dieser können Sie bequem nach Ausgabeeinschränkungswerten für den Eintrag in Ihre Liste gültiger Werte suchen. Die aufgerufene Suchfunktion ist davon abhängig, welcher Wert im Feld Ausgabeeinschränkungsschlüssel ausgewählt wurde. Ist kein Ausgabeeinschränkungsschlüssel ausgewählt, wird der Suche-Button nicht angezeigt.

Suche nach Kunden-Id

Die Suchfunktion leitet zur Gambio-Kundenverwaltung. Geben Sie dort in das Suchfeld den Namen des Kunden ein. Führen Sie die Suche aus. In der Ergebnisliste rufen Sie aus der relevanten Zeile die Kunden-Detailansicht auf. Unter der Sektion Persönliche Informationen wird mit # die Kunden-Id angegeben. Übernehmen Sie die Kunden-Id ohne #.

Suche nach Kundengruppen-Id

Die Suchfunktion öffnet eine übersichtliche Liste mit allen Kundengruppen. In der ersten Spalte finden Sie die Kundengruppen-Id.

Suche nach Kategorie-Id

Die Suchfunktion öffnet eine übersichtliche Liste mit allen Kategorien. In der ersten Spalte finden Sie die Kategorie-Id.

Suche nach Artikel-Id

Die Suchfunktion öffnet ein Suchformular. Geben Sie in dem Eingabefeld einen Suchbegriff ein und führen Sie die Suche mit 'Enter' aus. Beim Ausführen der Suche wird der von Ihnen eingegebene Suchbegriff im Artikelnamen und in der Artikelnummer gesucht. In der Ergebnisliste finden Sie die Artikel-Id in der ersten Spalte.

Anzeige einmal pro Session

Mit diesem Schalter entscheiden Sie, ob ein Popup nur einmal pro Session (Schalter = aktiv) oder unlimitiert pro Session (Schalter = inaktiv) angezeigt werden soll. Konfigurieren Sie ein Popup auf alle Seiten des Shops, so sollten Sie den Schalter aktivieren - sonst bekommt Ihr Shop-Kunde auf jeder Seite das Popup eingeblendet.

Der Schalter wirkt auf das komplette Popup - unabhängig von den konfigurierten Ausgabeeinschränkungen. Das heißt, ist ein Popup z. B. auf zwei Artikel und den Aufruf der Produkt-Detailseite konfiguriert, so wird das Popup auch nur beim ersten Aufruf der Produkt-Detailseite (wenn einer der Artikel matcht) angezeigt. Beim Aufruf der Produkt-Detailansicht des zweiten Artikels würde dann das Popup nicht mehr angezeigt werden.

Popup-Inhalt für aktive Sprachen

Für jede aktive Sprache wird ein Tab angezeigt. Innerhalb eines Tabs wird der Inhalt eines Popups für die entsprechende Sprache festgelegt. Hierbei handelt es sich um die Inhalte, die im Rahmen eines Popups im Shop angezeigt werden.

Popup-Überschrift (optional)

Definieren Sie hier den Inhalt des Popup-Headers. HTML-Tags sind nicht erlaubt - werden herausgefiltert. Das Feld kann auch leer bleiben.

Popup-Inhalt (Pflichteingabe)

Zur Erstellung des Popup-Inhalts steht Ihnen der aus dem Content Manager bekannte Editor zur Verfügung. Mit seiner Hilfe können Sie Ihren Popup-Inhalt frei gestalten. Es muss mindestens für eine Sprache ein Popup-Inhalt eingegeben werden, sonst würde eine Speicherung des Popups verweigert werden.

Popup bearbeiten

Aus der Popup-Übersicht heraus können Sie ein bestehendes Popup bearbeiten. Beim Bearbeiten eines Popups gelten die selben Regeln wie beim Hinzufügen eines Popups.

Popup löschen

Aus der Popup-Übersicht heraus können Sie ein bestehendes Popup löschen. Bevor ein Popup endgültig gelöscht wird, müssen Sie eine Sicherheitsabfrage bestätigen.

Ausgabe Popups

Im Shop wird an den vorgegebenen Ausgabepunkten und Ausgabeereignissen geprüft, ob es entsprechend konfigurierte aktive Popups gibt. Zur Anzeige kommen alle Popups, welche bei den Ausgabeeinschränkungen matchen und einen Popup-Inhalt haben. Mehrere Popups werden in einer einzigen Lightbox übereinander angezeigt. Der Shop-Besucher muss alle Popups wegklicken!

Modul-Deinstallation

Wechseln Sie im Shop-Admin-Bereich nach Module > Modul-Center. In der Liste der verfügbaren Module markieren Sie den Eintrag mit der Bezeichnung Lenk GmbH | Popup Fabrik. Nach Klick auf den Button Deinstallieren und bestätigen der nachfolgenden Sicherheitsabfrage wird das Modul deinstalliert.

Nach Deinstallation müssen im Shop-Admin-Bereich unter Toolbox > Cache die Caches geleert werden:

1. Cache für Modulinformationen
2. Cache für Text
3. Cache für Seitenausgabe

Entfernen der Moduldateien

Möchten Sie nach Deinstallation die Moduldaten aus dem Shop entfernen, verbinden Sie sich mittels eines FTP-Programms mit Ihrem Server. Wechseln Sie in das Verzeichnis in das Ihr Shop installiert ist. Rufen Sie dort den Ordner /GXModules/LW/ auf. Die Moduldaten können gelöscht werden, in dem der Unterordner /PopupFactory/ und sein kompletter Inhalt entfernt wird. Befinden sich in dem /LW/ Ordner keine weiteren Daten, kann auch dieser gelöscht werden.

Wechseln Sie in den Ordner [root]/admin/ löschen Sie folgende Dateien:

• lw-validcustomerstatus.php
• lw-validproducts.php

Wechseln Sie in den Ordner [root]/admin/html/assets/styles/LW/ löschen Sie folgenden Ordner:

• PopupFactory

Befindet sich im Ordner [root]/admin/html/assets/styles/LW/ kein weiterer Unterordner, so kann auch der Ordner [root]/admin/html/assets/styles/LW/ gelöscht werden.

Nach Löschen der Ordner müssen im Shop-Admin-Bereich unter Toolbox > Cache die Caches geleert werden:

1. Cache für Modulinformationen
2. Cache für Text
3. Cache für Seitenausgabe

Häufige Fehler

Fehler
Ein Popup wird im Shop nicht angezeigt.
Ursache 1
Das Modul ist inaktiv.
Lösung 1
Im Modul-Center die Modul-Konfiguration aufrufen und das Modul aktivieren.
Ursache 2
In der Popup-Konfiguration steht der Schalter aktiv auf inaktiv.
Lösung 2
In der Popup-Konfiguration den Schalter aktiv auf aktiv setzen.
Ursache 3
Im Shop matcht der Ausgabepunkt und/oder das Ausgabeereignis und/oder die Ausgabeeinschränkungen nicht mit der Popup-Konfiguration.
Lösung 3
Überarbeitung der Ausgabeparameter in der Popup-Konfiguration.
Ursache 4
Der Schalter Anzeige einmal pro Session steht in der Popup-Konfiguration auf aktiv - das Popup wurde schon einmal angezeigt und dann weggeklickt.
Lösung 4
In der Popup-Konfiguration den Schalter Anzeige einmal pro Session auf inaktiv setzen.
Ursache 5
Das Popup hat für die aktuelle Shop-Sprache keinen Inhalt.
Lösung 5
In der Popup-Konfiguration für die entsprechende Sprache einen Popup-Inhalt anlegen.