Plugin-Download (erfordert Anmeldung)
6.5.0+ Für das Gewinnspiel-Portal-Plugin wird mindestend FORMCYCLE in der Version 6.5.0 benötigt
Das kostenpflichtige Gewinnspiel-Portal bietet die Möglichkeit, Portale für eine beliebige Anzahl an Gewinnspielen innerhalb von FORMCYCLE zu erstellen und verwalten. Diese Gewinnspiele nutzen für die Dateneingabe der Teilnehmer FORMCYCLE Formulare. Das Gewinnspiel-Portal kann auf allen Mandanten auf dem FORMCYCLE-Server genutzt werden, wobei auf jedem Mandanten ein eigenes Gewinnspiel-Portal eingerichtet werden kann.
Installation
Das Gewinnspiel-Portal kann nur als Systemplugin installiert werden und ist daher automatisch für alle Mandanten auf dem FORMCYCLE Server nutzbar. Das Gewinnspiel-Portal besteht aus zwei separaten Plugins, contest-view-portal.jar und contest-management-portal.jar, welche zwingend zusammen installiert werden müssen. Es ist dabei egal, in welcher Reihenfolge die beiden Plugins installiert werden.
Rollenrechte
Die Menüeinträge des Gewinnspielportals sind auf der FORMCYCLE Oberfläche standardmäßig nicht sichtbar. Es müssen daher bei den entsprechenden Nutzergruppen unter Rollen die Rechte für das Konfigurieren und für das Öffnen des Gewinnspielportals gesetzt werden. Diese Rechte sind wie folgt untergliedert:
Gewinnspiel-Portal verwalten
Unter diesem Hauptpunkt können alle für die Administration des Gewinnspiel-Portals nötigen Rechte vergeben werden.
Gewinnspiele verwalten
- Gewinnspiel anlegen (leer)
- Berechtigung ein neues Gewinnspiel anzulegen, welches nicht auf einer Vorlage beruht
- Gewinnspiel importieren
- Berechtigung ein exportiertes Gewinnspiel importieren zu dürfen
- Gewinnspiel aus Vorlage anlegen
- Berechtigung ein neues Gewinnspiel anzulegen, welches auf einer Vorlage aufbaut
- Gewinnspiel kopieren
- Berechtigung ein vorhandenes Gewinnspiel kopieren zu dürfen
- Gewinnspiel exportieren
- Berechtigung ein vorhandenes Gewinnspiel exportieren zu dürfen
- Gewinnspiel löschen
- Berechtigung ein vorhandenes Gewinnspiel löschen zu dürfen
- Gewinnspiel-Formular bearbeiten
- Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
- Gewinner ermitteln 1.4.0+
- Berechtigung, um nach Ablauf des Gewinnspiels Gewinner zu ermitteln, diese ggf. inkl Verarbeitung in einen anderen Status zu verschieben und anschließend per Excel zu explorieten.
- Teilnehmer exportieren 1.5.0+
- Berechtigung zum Exportieren der aktuellen Liste der Gewinnspiel-Teilnahmer
- Ersatzgewinner ermitteln 1.4.0+
- Ermöglicht es, wiederholt Ersatzgewinner zu ermitteln.
- Gewinne verwalten 1.6.0+
- Berechtigung, um neue Gewinne zu erstellen und vorhandene Gewinne bearbeiten und löschen zu dürfen.
- Gewinnbild hochladen 1.6.0+
- Berechtigung das vorhandene Gewinnbild eines Gewinns hochladen zu dürfen.
- Gewinnbild löschen 1.6.0+
- Berechtigung das vorhandene Gewinnbild eines Gewinns löschen zu dürfen.
- Verknüpfung Gewinnervorgang aufheben 1.6.0+
- Berechtigung die vorhandene Verknüpfung eines Gewinnvorgangs am Gewinn aufheben zu dürfen.
- Löschfristen verwalten 1.7.0+
- Berechtigung, um Löschfristen zu erstellen, zu bearbeiten oder löschen zu dürfen.
Vorlagen verwalten
Notwendige Berechtigung, um neue Gewinnspielvorlagen erstellen und vorhandene Gewinnspielvorlagen bearbeiten und löschen zu dürfen. Nur wenn dieses Recht aktiv ist, kann der Nutzer ein vorhandenes Gewinnspiel als Vorlage speichern.
Konfigurieren
Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen
Gewinnspiel-Portal öffnen
Berechtigung, das Gewinnspiel-Portal aus FORMCYCLE heraus direkt öffnen zu dürfen
Menüpunkte auf der Verwaltungsoberfläche
Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
Gewinnspiele
Nachdem das Gewinnspiel-Portal installiert wurde und der entsprechende Nutzer die Berechtigungen erhalten hat, befinden sich auf der FORMCYCLE Verwaltungsoberfläche ein neuer Menüpunkt Gewinnspiele mit den folgenden drei Unterpunkten:
- Gewinnspiele verwalten
- Unter diesem Punkt können Gewinnspiele angelegt und die Einstellungen von vorhandenen Gewinnspielen eingesehen und angepasst werden. Siehe Gewinnspiele verwalten.
- Vorlagen verwalten
- Unter diesem Punkt können neue Vorlagen für Gewinnspiele angelegt und vorhandene Vorlagen eingesehen und angepasst werden. Siehe Vorlagen verwalten.
- Konfiguration
- Unter diesem Punkt können Stuktur, Aussehen und Verhalten des Gewinnspiel-Portals konfiguriert werden. Siehe Portal konfigurieren.
Gewinnspiel öffnen
Wenn für den Benutzer in den Rollenrechten die Berechtigung zum Öffnen des Gewinnspiel-Portals gegeben wurde, erscheint im Hauptmenü auf der FORMCYCLE Verwaltungsoberfläche eine zusätzliche Schaltfläche Gewinnspiel öffnen.
Grundstruktur des Gewinnspiel-Portals
Mit dem Gewinnspiel-Portal kann aus mehreren vorgegebenen Elementen eine Portal-Webseite konfiguriert werden, in welcher die für ein Gewinnspiel-Portal benötigten Elemente enthalten sind. Die Webseite untergliedert sich in die folgenden Elemente:
- (1) Kopfbereich, (7) Fußbereich und (4) Trenner vom Portal
- Diese Elemente werden einmal konfiguriert und werden für alle Gewinnspiele im Gewinnspiel-Portal genutzt.
- (2) Bannergrafik, (3) Inhalt (Formular, Beschreibung, ggf. Ankündigungen oder Mitteilungen über den Beginn oder das Ende des Gewinnspiels), (5) Teilnahmebedingungen und (6) Datenschutz
- Diese Elemente können für jedes Gewinnspiel individuell konfiguriert werden.
Verwaltungsoberfläche im FORMCYCLE Backend
Gewinnspiele verwalten
Unter diesem Menüpunkt können die vorhandenen Gewinnspiele verwaltet und neue Gewinnspiele angelegt werden.
Menü
Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert , exportiert , als Vorlage gespeichert oder gelöscht werden. Über die Suchen-Schaltfläche kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinnspiel-Liste automatisch gefiltert wird. Beim Anlegen eines neuen Gewinnspiels kann entweder ein neues leeres Gewinnspiel angelegt, ein zuvor exportiertes Gewinnspiel wieder geladen oder eine Vorlage als Grundlage für das Gewinnspiel verwendet werden.
Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
- Ein ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist und sich aktuell innerhalb des konfigurierten Online-Zeitraumes befindet
- Ein nicht ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist, sich aber aktuell nicht innerhalb des konfigurierten Online-Zeitraumes befindet. Das heißt dass das Gewinnspiel entweder nicht mehr oder noch nicht online ist.
- Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
Metadaten
Nachdem auf die Neues Gewinnspiel-Schaltfläche geklickt oder ein Gewinnspiel in der Liste ausgewählt wurde, erscheint rechts die Konfigurationsseite für das Gewinnspiel. Hier können im oberen Bereich die Metadaten des Gewinnspiels konfiguriert werden. Die folgenden Optionen können konfiguriert werden:
- Aktiviert (Das Gewinnspiel ist aufrufbar)
- Das Gewinnspiel kann über einen Link aufgerufen werden
- Gewinnspiel im Portal anzeigen
- Das Gewinnspiel wird im Portal angezeigt; Nur anwählbar, wenn die Option Aktiviert (Das Gewinnspiel ist aufrufbar) zuvor angewählt wurde; Anderenfalls ist diese Option ausgegraut und das Gewinnspiel wird nicht im Portal angezeigt
- Name des Gewinnspiels
- Im Portal angezeigter Name des Gewinnspiels. Wird zudem als title-Attribut für das FORMCYCLE-Formular des Gewinnspiels verwendet.
- UUID des Gewinnspiels
- Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.
- Online von
- Zeitpunkt, ab dem das Gewinnspiel online geschaltet wird. Falls die Option Aktiviert (Das Gewinnspiel ist aufrufbar) angewählt wurde, wird vor dem an dieser Stelle konfigurierten Zeitpunkt beim Öffnen des Gewinnspiels nur die Ankündigung des Gewinnspiels angezeigt. Sofern Gewinnspiel im Portal anzeigen angewählt wurde, wird das Gewinnspiel auch vor dem hier konfigurierten Zeitpunkt bereits im Gewinnspiel-Portal angezeigt. Auch in diesem Fall wird beim Öffnen des Gewinnspiels die Ankündigung gezeigt.
- Online bis
- Zeitpunkt, ab dem das Gewinnspiel offline geschaltet wird. Falls die Option Aktiviert (Das Gewinnspiel ist aufrufbar) angewählt wurde, wird ab dem an dieser Stelle konfigurierten Zeitpunkt beim Öffnen des Gewinnspiels nur die Abgelaufen-Mitteilung des Gewinnspiels angezeigt. Sofern Gewinnspiel im Portal anzeigen angewählt wurde, wird das Gewinnspiel auch vor dem hier konfigurierten Zeitpunkt bereits im Gewinnspiel-Portal angezeigt. Auch in diesem Fall wird beim Öffnen des Gewinnspiels die Ankündigung gezeigt.
- Microsite
- An dieser Stelle werden drei Schaltflächen angezeigt, mit denen das ausgewählte Gewinnspiel geöffnet oder ein Link zum Gewinnspiel ermittelt werden kann. Die Buttons haben dabei die folgenden Funktionen:
- Öffnen
- Öffnet das Gewinnspiel so, wie es aktuell sichtbar ist. Dabei werden alle durch das Gewinnspiel konfigurieten Inhalte angezeigt. Die durch das Gewinnspiel-Portal bereitgestellten Inhalte wie Kopfbereich, Furßbereich, usw. werden nicht mit dargestellt.
- Vorschau
- Selbe Funktion wie die Öffnen-Schaltfläche, allerdings wird das Formular im Vorschaumodus geöffnet. Beim Absenden des Formulars wird inneralb des zuvor vom Formualar verwendeten Bildschirmbereichs die Zusammenfassung über die an den Server übertragenen Daten angezeigt, welche auch bei einem normalen FORMCYCLE-Formular nach dem Absenden aus der Vorschau angezeigt. Am rechten Rand der Schaltfläche kann durch den Klick auf den nach unten gerichteten Pfeil ein Menü geöffnet werden, welches zwei weitere Vorschau-Optionen enthält. Diese sind:
- Vorschau als angekündigt
- Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
- Vorschau als abgelaufen
- Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
- Bereitstellen
- Öffnet einen Dialog, in dem die URL zum Öffnen des Gewinnspiels ermittelt werden kann. Hierbei können die folgenden Optionen konfiguriert werden, welche das Aussehen des Gewinnspiels beeinflussen:
- Kopfbereich des Gewinnspiels ausblenden (Bilder)
- Wenn diese Option gewählt wird, wird die Bannergrafik nicht angezeigt.
- Beschreibung des Gewinnspiels ausblenden
- Wenn diese Option gewählt wird, wird die Beschreibung des Gewinnspiels nicht angezeigt, unabhängig davon, was unter Layout konfiguriert wurde.
- Fußbereich des Gewinnspiels ausblenden (Datenschutz & Teilnahmebedingungen)
- Wenn diese Option gewählt wird, werden die für das Gewinnspiel konfigurierten Inhalte für Datenschutz und Teilnahmebedingungen nicht angezeigt.
- Zu verwendender Server
- Auswahl, über welchen Server das Gewinnspiel geöffnet werden soll. Zur Auswahl stehen Master- und eventuell vorhande Frontend-Server.
- Darunter wird die sich aufgrund der selektierten Optionen ergebende URL angezeigt. Durch einen Klick auf die Quellcode kopieren-Schaltfläche rechts kann diese in die Zwischenablage kopiert werden.
- Alternativ kann durch einen Klick auf den nach unten gerichteten Pfeil am rechten Rand der Schaltfläche ein Menü geöffnet werden, welches drei weitere Optionen enthält. Diese öffnen jeweils einen Dialog, dessen Konfigurationsmöglichkeiten den bereits beschriebenen entsprecht. Anstelle einer URL werden allerdings in eine Webseite einzufügende Inhalte zum Einbinden des Gewinnspiels angezeigt. Die drei Optionen sind:
- Bereitstellen als HTML Link
- Generiert Quellcode, mit dem das Gewinnspiel direkt als HTML-Code in eine Webseite eingebunden werden kann.
- Bereitstellen als Inlineframe
- Generiert Quellcode, mit dem das Gewinnspiel als Inlineframe in eine Webseite eingebunden werden kann.
- Bereitstellen als Ajax/JavaScript
- Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
- Löschfristen des Gewinnspiels 1.7.0+
- Im Bereich der Metadaten befindet sich auf der rechten Seite eine Tabelle zur Verwaltung der Löschfristen eines Gewinnspiels. Diese Löschfristen fungieren zur Beschreibung des Vorgehens der automatisierten Löschung von Gewinnspielvorgängen im Postfach. Damit die Löschfristen aller Gewinnspiele angewandt werden können, muss vorher in den Properties des Plugins der Quartz-Job konfiguriert werden (Siehe Konfiguration des Quartz-Jobs) . Eine Löschfrist kann konfiguriert werden, wenn die Berechtigung zur Verwaltung der Löschfristen aktiviert ist. Jede Löschfrist besitzt drei Eigenschaften: den Löschtyp, den Löschstatus und die Tage bis zur Löschung.
- Löschtyp
- nach Ende des Gewinnspiels
- Eine Löschfrist dieses Typs wird erst angewandt, wenn das konfigurierte Ende des Gewinnspiels eingetreten ist und die eingestellten Tage bis zur Löschung vergangen sind.
- nach Formulareingang
- Eine Löschfrist dieses Typs wird erst angewandt, wenn die eingestellten Tage der Löschfrist nach Eingang des Vorgangs in das Postfach vergangen sind.
- Löschstatus
- Der Löschstatus gibt an, in welchem Status sich ein Vorgang im Postfach befinden muss, um gelöscht zu werden. Falls die Option beliebiger Status ausgewählt ist, werden alle Vorgänge des Gewinnspiels in der eingestellten Frist gelöscht, unabhängig vom Status eines Vorgangs.
- Tage bis zur Löschung
- Tage die es benötigt in Abhängigkeit zum Löschtyp bis Ausführung der Löschfrist.
- Löschtyp
- Durch den Knopf + Löschfrist hinzufügen kann eine neue Löschfrist konfiguriert werden, welche gespeichert wird durch das Drücken auf den Knopf zum Speichern des Gewinnspiels. Jede Löschfrist besitzt am Ende den -Knopf, wodurch die Löschfrist nach Bestätigung endgültig entfernt wird. Sobald es zur Ausführung und Löschung von Vorgängen durch eine Löschfrist gekommen ist, wird dies als System-Protokolleintrag dokumentiert.
Inhalt
- Layout
- An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte Beschreibungstextangezeigt werden soll. Zur Auswahl stehen:
- Formular links
- Der Beschreibungstext wird rechts neben dem Formular angezeigt
- Formular rechts
- Der Beschreibungstext wird links neben dem Formular angezeigt
- Formular oben
- Der Beschreibungstext wird unter dem Formular angezeigt
- Formular unten
- Der Beschreibungstext wird über dem Formular angezeigt
- ohne Beschreibung
- Es wird nur das Formular und kein Beschreibungstext angezeigt
- Bannergrafiken
- Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels und auf der Microsite angezeigten Bannergrafiken konfiguriert werden. Für unterschiedliche Geräteklassen bzw. Bildschirmauflösungen können dabei verschiedene Grafiken genutzt werden. Zur Auswahl stehen die folgenden Größen:
- Desktop - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
- Tablet - zwischen 642 px und 1025 px Bildschirmbreite
- Mobile - bei 641 px oder weniger Bildschirmbreite
- Ab Version 1.8.0+wurden die Typen der Bannergrafiken überarbeitet und um die Pfelge von Grafiken für Fall eines Gewinns erweitert.
- Desktop (1280px) - ab 1280 px Bildschirmbreite 1.8.0+
- Tablet (960px) - zwischen 960 px und 1280 px Bildschirmbreite 1.8.0+
- Mobile (600px) - zwischen 600 px und 960 px Bildschirmbreite 1.8.0+
- Mobile (320px) - bei 600 px oder weniger Bildschirmbreite 1.8.0+
- Wenn eine Bannergrafik für eine Geräteklasse nicht explizit konfiguriert wird, wird bei der Anzeige die Grafik des nächstgrößeren Formats verwendet. Dementsprechend sollte die Grafik für Desktop immer konfiguriert werden, während Tablet und Mobile optional sind. Unterstützt werden alle im Browser zulässigen Bildformate.
- Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
- Desktop, Tablet und Mobile
- Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
- + Bannergrafik ändern
- Öffnet einen Dateiauswahldialog zum selektieren einer lokal gespeicherten Grafik. Nach dem Bestätigen der Auswahl wird die Datei hochgeladen. Falls bereits zuvor eine Grafik vorhanden war, wird dieser ersetzt.
- -Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
- Löschen der Grafik
- Inhalt
- An dieser Stelle wird der eigentliche Inhalt des Gewinnspiels konfiguriert. Die einzelnen Inhaltselemente des Gewinnspiels können über die oben befindlichen Schaltflächen ausgewählt werden. Danach kann in dem darunter befindlichen WYSIWYG-Editor der jeweilige Inhalt eingefügt werden. Bei den HTML-Inhalten kann durch einen Klick auf Quellcode jeweils in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden. Falls das Gewinnspiel nicht im Portal geöffnet werden soll, aber zusätzlicher JavaScript- und CSS-Code dafür benötigt wird, kann dieser unter JavaScript (Microsite) bzw. unter CSS (Microsite) definiert werden.
- Folgende Inhalte können an dieser Stelle konfiguriert werden:
- Beschreibung
- Beschreibungstext zum Gewinnspiel. Wird neben bzw. über oder unter dem Formular angezeigt.
- Teilnahmebedingungen
- Teilnahmebedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben dem Datenschutz angezeigt.
- Datenschutz
- Datenschutzbedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben den Teilnahmebedingungen angezeigt.
- Ankündigung
- Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
- Abgelaufen
- Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
- CSS (Microsite)
- Zusätzlicher CSS-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
- JavaScript (Microsite)
- Zusätzlicher JavaScript-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
- HTML header (Microsite)
- Zusätzlicher HTML-Code, welcher nur im Headerbereich dieses Gewinnspiels verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
Fußzeile
Hier befinden sich die folgenden zwei Schaltflächen:
- Formular bearbeiten
- Öffnet den Formulardesigner für den Formularteil des Gewinnspiels. Da es sich um ein normales FORMCYCLE-Formular handelt, erfolgt die Erstellung und Konfiguration des Formulars analog. Vom Designer aus kann dementsprechend auch die Statusverarbeitung des Formulars konfiguriert werden.
- Gewinner ermitteln 1.4.0+
- Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar, sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist. Ferner ist er auch nicht mehr verfügbar, sobald eine Gewinnerziehung durchgeführt wurde. Er öffnet den Dialog zu Konfiguration und zum Starten der Gewinnerziehung.
- Ersatzgewinner ermitteln 1.4.0+
- Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar, sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist sowie bereits eine Gewinnerziehung stattgefunden hat. Er öffnet den Dialog zur Konfiguration und zum Starten der Nachziehung von Gewinnern.
- Teilnehmer exportieren 1.5.0+
- Diese Schaltfläche ist bei entsprechender Berechtigung nur verfügbar, wenn zum ausgewählten Gewinnspiel eine projektspezifische Postfachansicht definiert wurde. Beim Betätigen dieser Schaltfläche wird ein EXCEL-Export angestoßen, welcher die dort definierten Formularfelder inkl. aller Metadaten-Felder exportiert. Je nach Anzahl der Teilnehmer kann dieser Export mehrere Sekunden lang dauern.
- Gewinne verwalten 1.6.0+
- Diese Schaltfläche ist erst bei entsprechender Berechtigung verfügbar. Sie öffnet den Dialog zur Verwaltung der Gewinne des ausgewählten Gewinnspiels.
- Speichern
- Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
Gewinner ermitteln 1.4.0+
Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde, ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
Konfiguration
Startet man über die entsprechenden Schaltflächen die Ermittlung der Gewinner eines Gewinnspiels, so öffnet sich hierbei ein Konfigurationdialog. In diesem wird angegeben, aus welchem Status die Teilnehmer-Datensätze herangezogen werden, sowie die Anzahl der eigentlichen Gewinner in ihren Ausprägungen. Hierbei wird unterschieden zwischen Hauptgewinnern, Nebengewinnern und zusätzlichen Ersatzgewinnern. Die Datensätze, die für die jeweilige Ausprägung gezogen werden, werden anschließen je nach Auswahl mit oder ohne ausgeführter Statusverarbeitgung in den zugehörigen Zielstatus überführt.
Auswertung
Nach der Ziehung wird eine Übersicht mit den ermittelten Gewinnern angezeigt. Hierbei werden je nach Verfügbarkeit Spalten der projektspezifischen Postfachansicht oder der Betreff inkl. von Standard-Spalten angezeigt. Ferner sind die Spalten über die zugehörige Auswahl anpassbar. Über die Schlatfläche "Export" steht zusätzlich diese Tabelle mit allen vorhandenen Spalten als Excel-Datei zur Verfügung. Ferner kann über "Export" > "... mit kompletten Datensätzen" das Excel auch um alle im Formular vorhandenen Eingabedaten erweitert werden.
Gewinner nachziehen
Nach einer initial durchgeführen Gewinnerziehung steht diese Option nicht mehr zur Verfügung. Ferner gibt es mit der entsprechenden Berechtigung die Möglichkeit, weitere Ersatzgewinner zu ermitteln. Hierbei kommt der selbe Dialog zum Einsatz, jedoch ist nur die Konfiguration der Ersatzgewinner verfügbar.
Gewinne verwalten 1.6.0+
Unter dieser Schaltfläche öffnet sich ein Dialogfenster, in dem vorhandene Gewinne eines Gewinnspiels verwaltet und neue Gewinne angelegt werden können, wenn die entsprechenden Berechtigungen aktiviert sind.
Menü
Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinne. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden oder ein zuvor ausgewähltes Gewinnspiel kopiert oder gelöscht werden. Zusätzlich besitzt jeder Gewinn einen eigenen Button zum Löschen des Gewinns. Über die Suchen-Schaltfläche kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinn-Liste automatisch gefiltert wird.
Gewinndetails
Nachdem auf die Schaltfläche Gewinn hinzufügen geklickt oder ein Gewinn in der Liste ausgewählt wurde, erscheinen rechts die konfigurierbaren Gewinndetails. Die folgenden Optionen können konfiguriert werden oder werden als Information angezeigt:
- UUID des Gewinns
- Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.
- Gewinnname
- Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.
- Kategorie
- Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion Gewinn ermitteln genutzt für eine möglichen Limitierung der Gewinnziehung auf eine Kategorie.
- Gruppe
- Frei definierbare Gruppe eines Gewinns. Wird für das Ausspielen der Meta-Daten eines Preises innerhalb des Formulars benutzt. Ein Preis ohne Gruppe steht für die Visualisierung innerhalb des Formulars nicht zur Verfügung. Bei gleichen Gruppen-Namen werden ausschließlich die Daten des ersten Preises bereitgestellt.
- Gewinncode
- Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion Gewinn ermitteln einen Gewinner-Vorgang zuzuweisen.
- Gewinn-Link
- Benutzerdefinierter Link für den Gewinn, um bspw. eine URL als Link in das Gewinnbild einzubinden.
- UUID des Gewinner-Vorgangs
- Falls ein Gewinn über die Plugin-Aktion Gewinn ermitteln ausgewählt wurde, wird die eindeutige UUID des Gewinner-Vorgangs in den Gewinndetails angezeigt, um diesen identifizieren zu können. Bei Existenz dieser UUID in den Gewinndetails kann über den Button Verknüpfung aufheben bei vorhandenen Berechtigungen die Verknüpfung zwischen dem Gewinner-Vorgang und dem ausgewählten Gewinn aufgehoben werden.
- Gewinnbeschreibung
- An dieser Stelle wird die Beschreibung des Gewinns über einen WYSIWYG-Editor konfiguriert. Durch einen Klick auf Quellcode kann in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden.
- Gewinnbild
- Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:
- Über eine Bild-Ressource
- Für diese Möglichkeit kann bei bestehender Berechtigung durch den Button + Gewinnbild hochladen über einen Dateiauswahldialog eine lokal gespeicherte Grafik selektiert werden. Nach dem Bestätigen der Auswahl wird die Bilddatei hochgeladen und als Datei am Gewinnspiel-Formular gespeichert. Falls eine Bild-Datei mit dem identischen Dateinamen hochgeladen wird, erhält diese Bild-Datei eine Laufnummer. Durch das Auswahlmenü über dem Gewinnbild wird das hochgeladene Bild automatisch ausgewählt, wodurch ggf. auch eine bereits existierende Bild-Ressource selektiert werden kann.
- Über eine Bild-URL
- Die Bild-URL kann durch Eingabe oder Einfügen in das Auswahlfeld konfiguriert werden. Beim Ausklappen des Auswahlfeldes werden alle Bild-URLs angezeigt, die von Gewinnen im Gewinnspiel verwendet werden.
Des Weiteren dient das -Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik, zum Löschen dieser Grafik bei bestehender Berechtigung.
- Speichern
- Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.
Fußzeile
Hier befinden sich die folgenden zwei Schaltflächen:
- + Excel-Import
- Import von Gewinnen aus Excel-Datei.
- Schließen
- Schließen des Dialogfensters.
Excel-Import von Gewinnen
Auf der linken Seite der Fußzeile im Verwaltungsdialog der Gewinne befindet sich die Schaltfläche + Excel Import. Nach dem Klicken auf die Schaltfläche öffnet sich ein Dateiauswahldialog, über den eine bereits bestehende lokale Excel-Datei selektiert werden kann. Die Excel-Datei muss weder vom Dateityp .xls oder .xlsx sein.
Falls es sich bei der ausgewählten Datei um eine Excel-Datei handelt, öffnet sich ein Dialog zur Konfiguration des Imports der Gewinne aus der Excel-Datei. Hierbei kann zuerst das Excel-Blatt ausgewählt werden, in welchem sich die Gewinne in der Excel-Datei befinden. Über das Ankreuzfeld Erste Zeile ignorieren kann bei ggf. bestehenden Spaltenbeschriftungen der Gewinne die erste Zeile des Excel-Blatts ignoriert werden.
Über die fünf Eingabefelder können die zugehörigen Spaltennummern der Exceltabelle angegeben werden. Jedes Gewinnattribut (Name, Kategorie, Gruppe, Gewinncode, Gewinn-Link, Beschreibung, Bild-URL) wird genau einer Spalte in der Exceltabelle zugeordnet. Nach dem Drücken auf den Button Importieren werden die Gewinne erstellt auf Grundlage der Exceltabelle und sind danach im Verwaltungsdialog der Gewinne zu sehen.
Vorlagen verwalten
Unter diesem Menüpunkt können die vorhandenen Vorlagen für Gewinnspiele verwaltet und neue Vorlagen angelegt werden. An der Oberfläche kann eine Teilmenge der bei Gewinnspiele verwalten vorhandenen Optionen konfiguriert werden.
Menü
Auf der linken Seite befindet sich die Liste aller vorhandenen Vorlagen. Über die Schaltfläche über der Liste kann eine neue Vorlage angelegt werden, indem ein zuvor exportiertes Gewinnspiel oder eine zuvor exportierte Vorlage wieder importiert wird. Eine vorhandene Vorlage kann mit der sich daneben befindenden Schaltfläche kopiert, mit exportiert und mit gelöscht werden. Über die Suchen-Schaltfläche kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Vorlagen-Liste automatisch gefiltert wird.
Einstellungen
Nachdem eine Vorlage angelegt bzw. in der Liste ausgewählt wurde, erscheint rechts die Konfigurationsseite für diese. Die foldenden Optionen können konfiguriert werden:
- Name der Vorlage:
- Innerhalb von FORMCYCLE angezeigter Name der Vorlage.
- Layout:
- An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte Beschreibungstextangezeigt werden soll. Zur Auswahl stehen:
- Formular links
- Der Beschreibungstext wird rechts neben dem Formular angezeigt
- Formular rechts
- Der Beschreibungstext wird links neben dem Formular angezeigt
- Formular oben
- Der Beschreibungstext wird unter dem Formular angezeigt
- Formular unten
- Der Beschreibungstext wird über dem Formular angezeigt
- ohne Beschreibung
- Es wird nur das Formular und kein Beschreibungstext angezeigt
- Microsite
- An dieser Stelle wird nur eine Schaltflächen angezeigt, mit der die ausgewählte Vorlage wie ein normales Gewinnspiel im Vorschaumodus geöffnet werden kann. Der Button hat dabei die folgenden Funktionen:
- Vorschau
- Die Gewinnspiel-Vorlage bzw. das Formular wird im Vorschaumodus geöffnet. Beim Absenden des Formulars wird inneralb des zuvor vom Formualar verwendeten Bildschirmbereichs die Zusammenfassung über die an den Server übertragenen Daten angezeigt, welche auch bei einem normalen FORMCYCLE-Formular nach dem Absenden aus der Vorschau angezeigt. Am rechten Rand der Schaltfläche kann durch den Klick auf den nach unten gerichteten Pfeil ein Menü geöffnet werden, welches zwei weitere Vorschau-Optionen enthält. Diese sind:
- Vorschau als angekündigt
- Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
- Vorschau als abgelaufen
- Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
- Inhalt
- An dieser Stelle wird der eigentliche Inhalt der Gewinnspiel-Vorlage konfiguriert. Die vorhandenen Optionen entsprechen exakt dem, was im Menüpunkt Gewinnspiele verwalten konfiguriert werden kann. Die einzelnen Inhaltselemente der Gewinnspiel-Vorlage können über die oben befindlichen Schaltflächen ausgewählt werden. Danach kann in dem darunter befindlichen WYSIWYG-Editor der jeweilige Inhalt eingefügt werden. Bei den HTML-Inhalten kann durch einen Klick auf Quellcode jeweils in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden. Falls das in der Gewinnspiel-Vorlage konfigurierte Gewinnspiel später nicht im Portal geöffnet werden soll, aber zusätzlicher JavaScript- und CSS-Code dafür benötigt wird, kann dieser unter JavaScript (Microsite) bzw. unter CSS (Microsite) definiert werden.
- Folgende Inhalte können an dieser Stelle konfiguriert werden:
- Beschreibung
- Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.
- Teilnahmebedingungen
- Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem Datenschutz angezeigt.
- Datenschutz
- Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den Teilnahmebedingungen angezeigt.
- Ankündigung
- Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
- Abgelaufen
- Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
- CSS (Microsite)
- Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
- JavaScript (Microsite)
- Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
- HTML header (Microsite)
- Zusätzlicher HTML-Code, welcher nur im Headerbereich dieses Gewinnspiels verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
- Bannergrafiken
- Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels und auf der Microsite angezeigten Bannergrafiken für diese Gewinnspiel-Vorlage konfiguriert werden. Für unterschiedliche Geräteklassen bzw. Bildschirmauflösungen können dabei verschiedene Grafiken genutzt werden. Zur Auswahl stehen die folgenden Größen:
- Desktop - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
- Tablet - zwischen 642 px und 1025 px Bildschirmbreite
- Mobile - bei 641 px oder weniger Bildschirmbreite
- Ab Version 1.8.0+wurden die Typen der Bannergrafiken überarbeitet und um die Pfelge von Grafiken für Fall eines Gewinns erweitert.
- Desktop (1280px) - ab 1280 px Bildschirmbreite 1.8.0+
- Tablet (960px) - zwischen 960 px und 1280 px Bildschirmbreite 1.8.0+
- Mobile (600px) - zwischen 600 px und 960 px Bildschirmbreite 1.8.0+
- Mobile (320px) - bei 600 px oder weniger Bildschirmbreite 1.8.0+
- Wenn eine Bannergrafik für eine Geräteklasse nicht explizit konfiguriert wird, wird bei der Anzeige die Grafik des nächstgrößeren Formats verwendet. Dementsprechend sollte die Grafik für Desktop immer konfiguriert werden, während Tablet und Mobile optional sind. Unterstützt werden alle im Browser zulässigen Bildformate.
- Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
- Desktop, Tablet und Mobile
- Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
- Bannergrafik ändern
- Öffnet einen Dateiauswahldialog zum selektieren einer lokal gespeicherten Grafik. Nach dem Bestätigen der Auswahl wird die Datei hochgeladen. Falls bereits zuvor eine Grafik vorhanden war, wird dieser ersetzt.
- Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
- Löschen der Grafik
Fußzeile
Hier befinden sich die folgenden zwei Schaltflächen:
- Formular bearbeiten
- Öffnet den Formulardesigner für den Formularteil der Gewinnspiel-Vorlage. Da es sich um ein normales FORMCYCLE-Formular handelt, erfolgt die Erstellung und Konfiguration des Formulars analog. Vom Designer aus kann dementsprechend auch die Statusverarbeitung des Formulars konfiguriert werden.
- Speichern
- Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
Konfiguration
In diesem Menüpunkt kann das Aussehen des Gewinnspiel-Portals angepasst werden. Die folgenden Reiter stehen für die Konfiguration des Portals zur Verfügung:
- Kopfbereich
- Über dem Formular angezeigter Inhalt.
- Trenner
- Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.
- Fußbereich
- Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.
- Abgelaufen-Overlay
- Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.
- CSS (Portal)
- Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.
- JavaScript (Portal)
- Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.
- HTML header (Portal)
- Zusätzlicher HTML-Code, welcher im Headerbereich des Gewinnspiel-Portals verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
Speicherort der Inhalte des Gewinnspiel-Portals
Die unter Konfiguration getätigten Einstellungen werden in FORMCYCLE als Dateien hinterlegt. Diese befinden sich unter Dateien und Templates.
Es handelt sich um die folgenden Dateien:
Dateiname | Inhalt |
---|---|
contest-portal.css.txt | CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird |
contest-portal.footer.html | Inhalt des Fußbereiches der Gewinnspiel-Portalseite |
contest-portal.header.html | Inhalt des Kopfbereiches der Gewinnspiel-Portalseite |
contest-portal.js.txt | JavaScript der Gewinnspiel-Portalseite |
contest-portal.meta.html | HTML header der Gewinnspiel-Portalseite |
contest-portal.separator.html | Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite |
contest-portal.title.html | Titel der Gewinnspiel-Portalseite |
expired-overlay.png | Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist |
Konfiguration des Quartz-Jobs 1.7.0+
Das automatisierte Löschen und die damit verbundene Überprüfung der Löschfristen aller Gewinnspiele wird durch einen Quartz-Job ermöglicht, welcher eine Cron-Expression benötigt, die angibt, wann dieser Job ausgeführt wird. Standardmäßig ist kein Quartz-Job mit Cron-Expression hinterlegt.
- portal.contestent.deletion.cron
- Über die Plugin-Property portal.contestent.deletion.cron kann eine Cron-Expression angegeben werden, damit ein Job mit dieser Cron-Expression angelegt wird. Um die Erstellung einer Cron-Expression zu erleichtern kann beispielsweise das Online-Tool CronMaker verwendet werden: cronmaker.com. In der Beschreibung des Portalplugins wird nach Speicherung der Plugin-Property noch einmal erfasst, ob der Quartz-Job angelegt werden konnte bzw. ob die Cron-Expression damit valide ist und wann der Job als Nächstes ausgeführt wird.
Plugin-Aktion: Gewinn ermitteln 1.6.0+
Die Plugin-Aktion Gewinn ermitteln ermöglicht es, durch Eingabe eines Gewinncodes im Gewinnspiel-Formular oder durch eine konfigurierbare Wahrscheinlichkeit, Gewinne für eingegangene Vorgänge zu ermitteln.
Parameter
Ziehmodus
- Gewinncode
- Beim Zieh-Modus Gewinncode muss über das Gewinnspiel-Formular ein Gewinncode eingegeben werden, wobei bei Übereinstimmung mit dem Gewinncode eines bestehenden Gewinns des Gewinnspiels dies am Gewinn vermerkt wird. Hierfür muss über das Textfeld Gewinncodefeld das zugehörige Eingabetextfeldelement des Formulars für den Gewinncode angegeben werden.
- Gewinnchance
- Durch den Zieh-Modus Gewinnchance kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü Limitieren auf Kategorie.
Die konfigurierbare Wahrscheinlichkeit wird über das Textfeld Gewinnchance 1 zu angegeben. Hierbei wird z.B. bei Eingabe einer 100 die Gewinnchance 1 zu 100 genutzt.
Falls ein Gewinner über die Gewinnchance ermittelt wird, wird in der ausgewählten limitierten Kategorie ebenfalls ein zufälliger Gewinn aus der Gewinnkategorie ausgewählt.
Rückgabewert der Plugin-Aktion
Rückgabewert der Aktion sind die Attribute des möglichen Gewinns, welche über Aktionsplatzhalter ausgelesen werden können. So können sie zum Beispiel in HTML-Templates im Gewinnspiel-Portal angezeigt werden. Ein weiterer Anwendungsfall wäre die Verwendung als Abarbeitungsbedingung einer Aktion vom Typ Statusänderung bei Erfolg der Aktion Gewinn ermitteln. Hier könnte im geänderten Status nun über eine Aktion vom Typ Abschlussseite ein bestimmtes HTML-Template angezeigt werden.
Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:
Rückgabewert | Beschreibung |
---|---|
[%$Aktionsname.SUCCESS%] | Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein |
[%$Aktionsname.RESULT[0].uuid%] | Eindeutige UUID des erhaltenen Gewinns |
[%$Aktionsname.RESULT[0].description%] | Beschreibung des erhaltenen Gewinns |
[%$Aktionsname.RESULT[0].category%] | Kategorie des erhaltenen Gewinns |
[%$Aktionsname.RESULT[0].process%] | Eindeutige UUID des Gewinner-Vorgangs |
[%$Aktionsname.RESULT[0].picture%] | Bild-URL des erhaltenen Gewinns |
[%$Aktionsname.RESULT[0].link%] | Gewinn-Link des erhaltenen Gewinns |
JavaScript-Schnittstellen
Allgemein
Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:
Scrollen zum Seitenanfang:
// Innerhalb des Kontextes Contest.scrollToTop(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToTop(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToTop', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToTop', '*');
Scrollen zu den Teilnahmebedingungen:
// Innerhalb des Kontextes Contest.scrollToTerms(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToTerms(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToTerms', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToTerms', '*');
Scrollen zur Datenschutz-Erklärung:
// Innerhalb des Kontextes Contest.scrollToPrivacy(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToPrivacy(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToPrivacy', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToPrivacy', '*');
Scrollen zum Formular: 1.4.0+
// Innerhalb des Kontextes Contest.scrollToForm(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToForm(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToForm', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToForm', '*');
Scrollen zum Anfang des Gewinnspiels: 1.4.0+
// Innerhalb des Kontextes Contest.scrollToContestTop(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToContestTop(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToContestTop', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToContestTop', '*');
Scrollen zum Anfang des Inhaltbereichs: 1.4.0+
// Innerhalb des Kontextes Contest.scrollToContent(); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Contest.scrollToContent(); // - falls dies nicht in der selben Domaine betrieben wird window.parent.postMessage('scrollToContent', '*'); // Allgemein ansprechbar über postMessage: <window>.postMessage('scrollToContent', '*');
Berechnung eines Scroll-Offsets: 1.5.0+
Mit der Funktion Contest.calcScrollOffset() steht eine überschreibbare Schnittstelle zur Verfügung, welche innerhalb der Scroll-Funktionen (außer scrollToTop()) gerufen wird um den berechneten Offset anzupassen. So ist es z.B. ggf. nötig bei mobilen Ansichten absolut positionierte Header in diesem mit zu berücksichtigen. Der zurückgegebene Wert wird zum Offset addiert. Die Überlagerung kann innerhalb des Portal-JavaScripts oder innerhalb einer einbettenden Seite stattfinden.
// Liefert standardmäßig 0 zurück Contest.calcScrollOffset(); // Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px). Contest.calcScrollOffset = function(){ if(window.matchMedia('(min-width: 960px)').matches){ return 0; }else{ return -60; } }
Umschalten der Einzeige eines Gewinnspiels in den Gewonnen-Status: 1.8.0+
Um im Falle eines Gewinns die Anzeige des Gewinnspiels abzuändern (z.B. Austausch der Banner-Grafik) ist die Funktion Contest.markAsWon() gedacht. Diese erwartet als Parameter die ID des Gewinnspiel-Projektes und das window in welchem das eigentliche Formular z.B. als IFrame ausgeliefert wird. Der Haupteinsatzort dieser Funktion ist das HTML-Template welches im Falle eines Gewinns ausgeliefert werden soll.
// Snippet für eine HTML-Abschlussseite welches die Anzeige des aktuellen Gewinnspiels in den Gewonnen-Status schaltet. // Funktioniert für die Bereitstellung als Micro-Site und innerhalb des Portals. if (window.parent && window.parent.Contest) { window.parent.Contest.markAsWon([%$PROJECT_ID%], window); }
Portal-spezifisch
Innerhalb des Portals wird für die Carousel-Darstellung die Bibliothekt slick verwendet. Dies lässt sich hierbei wie folgt ansprechen und umkonfigurieren:
// Abholen des entsprechenden Carousel-Objekts var carousel = $('.portal-carousel-images'); // Beispielhafte konfiguration des Autoplay-Features if (carousel && carousel.length > 0) { carousel.slick('slickSetOption', 'speed', 1000) carousel.slick('slickSetOption', 'autoplaySpeed', 5000); carousel.slick('slickPlay'); }
Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:
// Innerhalb des Kontextes Portal.goToContest(<uuid>); // Innerhalb des Formulares // - falls dies in der selben Domaine betrieben wird window.parent.Portal.goToContest(<uuid>); // - falls dies nicht in der selben Domaine betrieben wird var data = { msg: 'goToContest', uuid: <uuid> }; window.parent.postMessage(data, '*') // Allgemein ansprechbar über postMessage: var data = { msg: "goToContest", uuid: <uuid> }; <window>.postMessage(data , '*')
Microsite-spezifisch
Die Microsite besitzt neben den allgemeinen Funkationalitäten einen postMessage-Proxy welcher alle Nachrichten an das Formular-Fenster weiterreicht. Ferner wird die Bibliothek iFrame Resizer bereitgestellt.
Einbinden als Microsite
Für die Integration einer Gewinnspiel-Microsite als IFrame stehen verschiedene Hilfsmethoden für das Anpassen der Fenstergröße sowie das Scrolling der Site zur Verfügung. Diese sind hierbei folgende:
Resizing der IFrame anhand ihres Inhaltes
Hier kommt die Bibliothekt iFrame Resizer zum Einsatz. Es muss hierfür auf der Seite die die Microsite einbindet die Datei iframeResizer.min.js einbgebunden und der Resizer beispielsweise wie folgt initialisiert werden:
iFrameResize({log: false}, '<CSS-Selektor der iframe>');
Scrolling zu gewünschten Stellen auf der Microsite
Für diese Funktionalität werden an die Zielseite durch die Microsite entsprechende postMessages gesendet. Unter der Verwendung von jQuery kann dessen Auswertung wie folgt stattfinden:
// Behandelt Messages der Microsite function _handleMessage(event){ // Prüfung ob es sich um eine Scroll-Message handelt if(event.data.scrollTarget || event.data.scrollOffset){ // Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich. var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top; // Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame $('html, body').animate({ scrollTop : event.data.scrollOffset + frameOffset }, 'slow'); // Weiterleitung aller weiteren postMessages an die Microsite }else{ $('<CSS-Selektor der iFrame>').each(function(){ var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView; iframewindow.postMessage(event.data,"*"); }); } } // Registireren der Message-Behandlung if (window.addEventListener) { window.addEventListener('message', _handleMessage, false); } else if (window.attachEvent) { // ie8 window.attachEvent('onmessage', _handleMessage); }
Wie in diesem Beispiel erkennbar werden alle nicht postMessage-Nachrichten der Zielseite an die Microsite weitergegeben. Dies ist wichtig um z.B. interne Resize-Nachrichten des Formulars bis in die Microsite zu geben!
Versionshistorie
1.8.0
- Funktionalität der Pflege Bannergrafiken um weitere responsive Stufe und spezielle Grafiken für den Fall des Gewinns erweitert
- JavaScript-Schnittstelle um die Banner-Grafik im Falle eines Gewinns umzuschalten hinzugefügt
1.7.1
- Funktionalität zum Bereitstellen der MetaDaten von Preisen für die Visualisierung innerhalb des Formulars (PreRender-Plugin)
- Preis-Gruppen für die Zusammenfassung der zu visualisierenden Preise
1.7.0
- Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen
1.6.0
- Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien
- Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit
1.5.0
- Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
- JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
1.4.0
- Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
- Erweiterung der scrollTo-Funktionen
- Kleinere CSS-Anpassungen
1.3.4
- CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
1.3.3
- Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies
- Korrektur der Formular- und iFrameResizer-URL in der Vorschau
1.3.2
- Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht
1.3.1
- Über den Plugin-Parameter portal.usebaseurl kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.
- Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite
1.3.0
- Fehlerbehebung beim Ausliefern über den Frontend-Server
- Einbau eines iFrame-Resizer für Microseiten
- Weitergabe von scroll-Nachrichten an top-window
1.2.4
- Weiterleitung von postMessage an iframe innerhalb von Microsites
1.2.3
- Durchreichen von URL-Parametern an IFames im Portal
- Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter
1.2.2
- Undo/Redo-Funktionalität an Editoren aktiviert
- Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut
- Kleinere Anpassungen/Bugfixes
1.2.0
- Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren
- Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints
- Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen
1.1.0
- Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8
1.0.1
- Anpassungen für FORMCYCLE Version 6.4.x
War dieser Artikel hilfreich?
Das ist großartig!
Vielen Dank für das Feedback
Leider konnten wir nicht helfen
Vielen Dank für das Feedback
Feedback gesendet
Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren