Wiki-Quellcode von Gewinnspiel-Portal-Plugin

Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/Gewinnspiel-Portal (fc-portal-contest)&fileid=13794||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 {{info}}
6 {{version major="6" minor="5"}}{{/version}}Für das Gewinnspiel-Portal-Plugin wird mindestend {{formcycle/}} in der Version 6.5.0 benötigt
7 {{/info}}
8
9 {{figure image="beispiel_de.jpg" clear="h2"}}
10 Beispiel für ein mit dem Plugin erstelltes Gewinnspiel-Portal.
11 {{/figure}}
12
13 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 {{fcserver/}} genutzt werden, wobei auf jedem Mandanten ein eigenes Gewinnspiel-Portal eingerichtet werden kann.
14
15 == Installation ==
16
17 Das Gewinnspiel-Portal kann nur als [[Systemplugin>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] 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.
18
19 == Rollenrechte ==
20
21 {{figure image="rollenrechte_de.png" clear="h2"}}
22 Nach der Installation des Plugins zusätzlich konfigurierbare [[Rollenrechte>>doc:Formcycle.UserInterface.UserSettings.Roles]] in der Benuterverwaltung.
23 {{/figure}}
24
25 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>>doc:Formcycle.UserInterface.UserSettings.Roles]] die Rechte für das Konfigurieren und für das Öffnen des Gewinnspielportals gesetzt werden. Diese Rechte sind wie folgt untergliedert:
26
27 === Gewinnspiel-Portal verwalten ===
28
29 Unter diesem Hauptpunkt können alle für die Administration des Gewinnspiel-Portals nötigen Rechte vergeben werden.
30
31 ==== Gewinnspiele verwalten ====
32
33 ; Gewinnspiel anlegen (leer)
34 : Berechtigung ein neues Gewinnspiel anzulegen, welches nicht auf einer Vorlage beruht
35
36 ; Gewinnspiel importieren
37 : Berechtigung ein exportiertes Gewinnspiel importieren zu dürfen
38
39 ; Gewinnspiel aus Vorlage anlegen
40 : Berechtigung ein neues Gewinnspiel anzulegen, welches auf einer Vorlage aufbaut
41
42 ; Gewinnspiel kopieren
43 : Berechtigung ein vorhandenes Gewinnspiel kopieren zu dürfen
44
45 ; Gewinnspiel exportieren
46 : Berechtigung ein vorhandenes Gewinnspiel exportieren zu dürfen
47
48 ; Gewinnspiel löschen
49 : Berechtigung ein vorhandenes Gewinnspiel löschen zu dürfen
50
51 ; Gewinnspiel-Formular bearbeiten
52 : Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
53
54 ; Gewinner ermitteln {{version major="1" minor="4"}}{{/version}}
55 : 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.
56
57 ; Teilnehmer exportieren {{version major="1" minor="5"}}{{/version}}
58 : Berechtigung zum Exportieren der aktuellen Liste der Gewinnspiel-Teilnahmer
59
60 ; Ersatzgewinner ermitteln {{version major="1" minor="4"}}{{/version}}
61 : Ermöglicht es, wiederholt Ersatzgewinner zu ermitteln.
62
63 ; Gewinne verwalten {{version major="1" minor="6"}}{{/version}}
64 : Berechtigung, um neue Gewinne zu erstellen und vorhandene Gewinne bearbeiten und löschen zu dürfen.
65
66 ; Gewinnbild hochladen {{version major="1" minor="6"}}{{/version}}
67 : Berechtigung das vorhandene Gewinnbild eines Gewinns hochladen zu dürfen.
68
69 ; Gewinnbild löschen {{version major="1" minor="6"}}{{/version}}
70 : Berechtigung das vorhandene Gewinnbild eines Gewinns löschen zu dürfen.
71
72 ; Verknüpfung Gewinnervorgang aufheben {{version major="1" minor="6"}}{{/version}}
73 : Berechtigung die vorhandene Verknüpfung eines Gewinnvorgangs am Gewinn aufheben zu dürfen.
74
75 ; Löschfristen verwalten {{version major="1" minor="7"}}{{/version}}
76 : Berechtigung, um Löschfristen zu erstellen, zu bearbeiten oder löschen zu dürfen.
77
78 ==== Vorlagen verwalten ====
79
80 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.
81
82 ==== Konfigurieren ====
83
84 Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen
85
86 === Gewinnspiel-Portal öffnen ===
87
88 Berechtigung, das Gewinnspiel-Portal aus {{formcycle/}} heraus direkt öffnen zu dürfen
89
90 == Menüpunkte auf der Verwaltungsoberfläche ==
91
92 {{figure image="portal_menue_elemente_de.png" clear="h2" width="150"}}
93 Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.
94 {{/figure}}
95
96
97 Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
98
99
100 === Gewinnspiele ===
101
102 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:
103
104 ; Gewinnspiele verwalten
105 : Unter diesem Punkt können Gewinnspiele angelegt und die Einstellungen von vorhandenen Gewinnspielen eingesehen und angepasst werden. Siehe [[Gewinnspiele verwalten>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_gewinnspiele"]].
106
107 ; Vorlagen verwalten
108 : Unter diesem Punkt können neue Vorlagen für Gewinnspiele angelegt und vorhandene Vorlagen eingesehen und angepasst werden. Siehe [[Vorlagen verwalten>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_vorlagen"]].
109
110 ; Konfiguration
111 : Unter diesem Punkt können Stuktur, Aussehen und Verhalten des Gewinnspiel-Portals konfiguriert werden. Siehe [[Portal konfigurieren>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_portal"]].
112
113 === Gewinnspiel öffnen ===
114
115 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//.
116
117 == Grundstruktur des Gewinnspiel-Portals ==
118
119 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:
120
121 ; (1) Kopfbereich, (7) Fußbereich und (4) Trenner vom Portal
122 : Diese Elemente werden einmal konfiguriert und werden für alle Gewinnspiele im Gewinnspiel-Portal genutzt.
123
124 ; (2) Bannergrafik, (3) Inhalt (Formular, Beschreibung, ggf. Ankündigungen oder Mitteilungen über den Beginn oder das Ende des Gewinnspiels), (5) Teilnahmebedingungen und (6) Datenschutz
125 : Diese Elemente können für jedes Gewinnspiel individuell konfiguriert werden.
126
127 {{lightbox image="portal_aufbau_de.jpg" group="g0" width="800"/}}
128
129 == Verwaltungsoberfläche im FORMCYCLE Backend ==
130
131 {{id name="backend_gewinnspiele"/}}
132
133 === Gewinnspiele verwalten ===
134
135 {{figure image="gewinnspiele_uiv2_de.jpg" clear="h2"}}
136 Verwaltungsoberfläche für den Menüpunkt //Gewinnspiele verwalten//
137 {{/figure}}
138
139 Unter diesem Menüpunkt können die vorhandenen Gewinnspiele verwaltet und neue Gewinnspiele angelegt werden.
140
141 ==== Menü ====
142
143 Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}}, exportiert {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}}, als Vorlage gespeichert {{icon name="fa-save" title="Als Vorlage speichern" size="1x" cssClass="fa-save"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} 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.
144
145 Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
146
147 ; {{ficon name="checkbox-marked-circle"/}}
148 : Ein ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist und sich aktuell innerhalb des konfigurierten Online-Zeitraumes befindet
149 ; {{ficon name="checkbox-marked-circle-outline"/}}
150 : 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.
151 ; {{ficon name="circle-outline"/}}
152 : Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
153
154 ==== Metadaten ====
155
156 {{figure image="gs_onlineeinstellungen_de.png" clear="h2"}}
157 Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes
158 {{/figure}}
159
160
161 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 links konfiguriert werden, wann und wie das Gewinnspiel sichtbar sein soll. Die folgenden Optionen können konfiguriert werden:
162
163
164 ; **Aktiviert (Das Gewinnspiel ist aufrufbar)**
165 : Das Gewinnspiel kann über einen Link aufgerufen werden
166
167 ; **Gewinnspiel im Portal anzeigen**
168 : 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
169
170 ; **Name des Gewinnspiels**
171 : Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.
172
173 ; **UUID des Gewinnspiels**
174 : Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.
175
176 ; **Online von**
177 : 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.
178
179 ; **Online bis**
180 : 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.
181
182 {{figure image="gs_microsite_de.png" clear="h2"}}
183 Mögliche Optionen zum Öffnen des Gewinnspiels bzw. zum Generieren von Code zum Einbetten des Gewinnspiels im Punkt //Microsite//
184 {{/figure}}
185
186 ; **Microsite**
187 : 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:
188 :; **Öffnen**
189 :: Ö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.
190 :; **Vorschau**
191 :: 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:
192 :; **Vorschau als angekündigt**
193 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
194 :; **Vorschau als abgelaufen**
195 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
196 :; **Bereitstellen**
197 :: Ö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:
198 ::; **Kopfbereich des Gewinnspiels ausblenden (Bilder)**
199 ::: Wenn diese Option gewählt wird, wird die Bannergrafik nicht angezeigt.
200 ::; **Beschreibung des Gewinnspiels ausblenden**
201 ::: Wenn diese Option gewählt wird, wird die Beschreibung des Gewinnspiels nicht angezeigt, unabhängig davon, was unter //Layout// konfiguriert wurde.
202 ::; **Fußbereich des Gewinnspiels ausblenden (Datenschutz & Teilnahmebedingungen)**
203 ::: Wenn diese Option gewählt wird, werden die für das Gewinnspiel konfigurierten Inhalte für //Datenschutz// und //Teilnahmebedingungen// nicht angezeigt.
204 ::; **Zu verwendender Server**
205 ::: Auswahl, über welchen Server das Gewinnspiel geöffnet werden soll. Zur Auswahl stehen Master- und eventuell vorhande Frontend-Server.
206 :: 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.
207 :: 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:
208 :; **Bereitstellen als HTML Link**
209 :: Generiert Quellcode, mit dem das Gewinnspiel direkt als HTML-Code in eine Webseite eingebunden werden kann.
210 :; **Bereitstellen als Inlineframe**
211 :: Generiert Quellcode, mit dem das Gewinnspiel als Inlineframe in eine Webseite eingebunden werden kann.
212 :; **Bereitstellen als Ajax/JavaScript**
213 :: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
214
215 ; **Löschfristen des Gewinnspiels** {{version major="1" minor="7"}}{{/version}}
216 : Im Bereich der Metadaten befindet sich auf der rechten Seite eine Tabelle zur Verwaltung der Löschfristen eines Gewinnspiels. 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>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="config_quartz"]]) . Eine Löschfrist kann konfiguriert werden zur automatisierten Löschung von Gewinnspielvorgängen im Postfach, wenn die Berechtigung zur Verwaltung der Löschfristen aktiviert ist. Dabei besitzt jede Löschfrist drei Eigenschaften: den Löschtyp, den Löschstatus und die Tage bis zur Löschung.
217 :: **Löschtyp**
218 ::; **nach Ende des Gewinnspiels**
219 ::: 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.
220 ::; **nach Formulareingang**
221 ::: Eine Löschfrist dieses Typs wird erst angewandt, wenn die eingestellten Tage der Löschfrist nach Eingang des Vorgangs in das Postfach vergangen sind.
222 :; **Löschstatus**
223 :: 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 gelöscht in der eingestellten Frist, unabhängig vom Status eines Vorgangs.
224 :; **Tage bis zur Löschung**
225 :: Tage die es benötigt in Abhängigkeit zum Löschtyp bis Ausführung der Löschfrist.
226
227 : 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 {{ficon name="trash-alt2"/}}-Knopf, wodurch die Löschfrist nach Bestätigung endgültig entfernt wird.
228
229 ==== Inhalt ====
230
231
232 ; **Layout**
233 : An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte //Beschreibungstext// angezeigt werden soll. Zur Auswahl stehen:
234 :; **Formular links**
235 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
236 :; **Formular rechts**
237 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
238 :; **Formular oben**
239 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
240 :; **Formular unten**
241 :: Der //Beschreibungstext// wird über dem Formular angezeigt
242 :; **ohne Beschreibung**
243 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
244
245 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
246 Vorhandene Schaltflächen unter //Bannergrafiken//.
247 {{/figure}}
248
249 ; Bannergrafiken
250 : 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:
251 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
252 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
253 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
254 : 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.
255
256 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
257 :; **Desktop**, **Tablet** und **Mobile**
258 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
259 :; **+ Bannergrafik ändern**
260 :: Ö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.
261 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
262 :: Löschen der Grafik
263
264 {{figure image="gs_inhalt_de.png" clear="h2"}}
265 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
266 {{/figure}}
267
268 ; **Inhalt**
269 : 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.
270 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
271 :; **Beschreibung**
272 :: Beschreibungstext zum Gewinnspiel. Wird neben bzw. über oder unter dem Formular angezeigt.
273 :; **Teilnahmebedingungen**
274 :: Teilnahmebedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
275 :; **Datenschutz**
276 :: Datenschutzbedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
277 :; **Ankündigung**
278 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
279 :; **Abgelaufen**
280 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
281 :; **CSS (Microsite)**
282 :: Zusätzlicher CSS-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
283 :; **JavaScript (Microsite)**
284 :: Zusätzlicher JavaScript-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
285 :; **HTML header (Microsite)**
286 :: 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.
287
288 ==== Fußzeile ====
289
290 Hier befinden sich die folgenden zwei Schaltflächen:
291
292 ; **Formular bearbeiten**
293 : Ö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.
294
295 ; **Gewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
296 : 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.
297
298 ; **Ersatzgewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
299 : 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.
300
301 ; **Teilnehmer exportieren** {{version major="1" minor="5"}}{{/version}}
302 : 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.
303
304 ; **Gewinne verwalten** {{version major="1" minor="6"}}{{/version}}
305 : Diese Schaltfläche ist erst bei entsprechender Berechtigung verfügbar. Sie öffnet den Dialog zur Verwaltung der Gewinne des ausgewählten Gewinnspiels.
306
307 ; **Speichern**
308 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
309 \\\\{{id name="backend_vorlagen"/}}
310
311 === Gewinner ermitteln {{version major="1" minor="4"}}{{/version}} ===
312
313 Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde, ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
314
315 {{figure image="dialog_1_de.png" clear="h2"}}
316 Dialog zu Konfiguration der Gewinnerziehung.
317 {{/figure}}
318
319 ==== Konfiguration ====
320
321 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.
322
323 {{figure image="dialog_2_de.png" clear="h2"}}
324 Anzeige der ermittelten Gewinner
325 {{/figure}}
326
327 ==== Auswertung ====
328
329 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.
330
331
332 ==== Gewinner nachziehen ====
333
334 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.
335 \\{{id name="backend_prizes"/}}
336
337
338
339
340
341 === Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===
342
343 {{figure image="dialog_prize_de.PNG" clear="h2"}}
344 Verwaltungsdialog für Gewinne
345 {{/figure}}
346
347 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.
348
349 ==== Menü ====
350
351 Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinne. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Zusätzlich besitzt jeder Gewinn einen eigenen Button zum Löschen {{ficon name="trash-alt2"/}} des Gewinns. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinn-Liste automatisch gefiltert wird.
352
353 ==== Gewinndetails ====
354
355 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:
356
357 ; **UUID des Gewinns**
358 : Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.
359
360 ; **Gewinnname**
361 : Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.
362
363 ; **Kategorie**
364 : Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion //Gewinn ermitteln// genutzt für eine möglichen Limitierung der Gewinnziehung auf eine Kategorie.
365
366 ; **Gewinncode**
367 : Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen.
368
369 ; **Gewinn-Link**
370 : Benutzerdefinierter Link für den Gewinn, um bspw. eine URL als Link in das Gewinnbild einzubinden.
371
372 ; **UUID des Gewinner-Vorgangs**
373 : 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.
374
375 ; **Gewinnbeschreibung**
376 : 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.
377
378 ; **Gewinnbild**
379 : Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:
380 :; **Über eine Bild-Ressource**
381 :: 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.
382 :; **Über eine Bild-URL**
383 :: 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.
384 Des Weiteren dient das {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik, zum Löschen dieser Grafik bei bestehender Berechtigung.
385
386 ; **Speichern**
387 : Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.
388
389 ==== Fußzeile ====
390
391 Hier befinden sich die folgenden zwei Schaltflächen:
392
393 ; **+ Excel-Import**
394 : Import von Gewinnen aus Excel-Datei.
395
396 ; **Schließen**
397 : Schließen des Dialogfensters.
398
399 {{figure image="dialog_import_excel_de.PNG" clear="h2"}}
400 Dialog zur Konfiguration des Excel-Imports
401 {{/figure}}
402
403 ==== Excel-Import von Gewinnen ====
404
405 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.
406
407 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.
408 Über die fünf Eingabefelder können die zugehörigen Spaltennummern der Exceltabelle angegeben werden. Jedes Gewinnattribut (Name, Kategorie, 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.
409 \\{{id name="backend_prize_import"/}}
410
411
412
413
414 === Vorlagen verwalten ===
415
416 {{figure image="vorlagen_ui_de.png" clear="h2"}}
417 Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
418 {{/figure}}
419
420 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.
421
422 ==== Menü ====
423
424 Auf der linken Seite befindet sich die Liste aller vorhandenen Vorlagen. Über die Schaltfläche {{ficon name="plus-circle-outline"/}} ü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 {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}} kopiert, mit {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}} exportiert und mit {{ficon name="trash-alt2"/}} gelöscht werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Vorlagen-Liste automatisch gefiltert wird.
425
426 ==== Einstellungen ====
427
428 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:
429
430 ; **Name der Vorlage:**
431 : Innerhalb von {{formcycle/}} angezeigter Name der Vorlage.
432
433 ; **Layout:**
434 : An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte //Beschreibungstext// angezeigt werden soll. Zur Auswahl stehen:
435 :; **Formular links**
436 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
437 :; **Formular rechts**
438 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
439 :; **Formular oben**
440 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
441 :; **Formular unten**
442 :: Der //Beschreibungstext// wird über dem Formular angezeigt
443 :; **ohne Beschreibung**
444 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
445
446 ; **Microsite**
447 : 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:
448 :; **Vorschau**
449 :: 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:
450 :; **Vorschau als angekündigt**
451 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
452 :; **Vorschau als abgelaufen**
453 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
454
455 {{figure image="gs_inhalt_de.png" clear="h2"}}
456 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
457 {{/figure}}
458
459 ; **Inhalt**
460 : 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.
461 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
462 :; **Beschreibung**
463 :: Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.
464 :; **Teilnahmebedingungen**
465 :: Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
466 :; **Datenschutz**
467 :: Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
468 :; **Ankündigung**
469 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
470 :; **Abgelaufen**
471 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
472 :; **CSS (Microsite)**
473 :: Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
474 :; **JavaScript (Microsite)**
475 :: Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
476 :; **HTML header (Microsite)**
477 :: 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.
478
479 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
480 Vorhandene Schaltflächen unter //Bannergrafiken//.
481 {{/figure}}
482
483 ; Bannergrafiken
484 : 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:
485 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
486 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
487 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
488 : 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.
489
490 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
491 :; **Desktop**, **Tablet** und **Mobile**
492 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
493 :; **+ Bannergrafik ändern**
494 :: Ö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.
495 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
496 :: Löschen der Grafik
497
498 ==== Fußzeile ====
499
500 Hier befinden sich die folgenden zwei Schaltflächen:
501
502 ; **Formular bearbeiten**
503 : Ö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.
504
505 ; **Speichern**
506 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
507 \\\\{{id name="backend_portal"/}}
508
509 === Konfiguration ===
510
511 {{figure image="portal_ui_de.png" clear="h2"}}
512 Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//.
513 {{/figure}}
514
515 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:
516
517 ; Kopfbereich
518 : Über dem Formular angezeigter Inhalt.
519
520 ; Trenner
521 : Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.
522
523 ; Fußbereich
524 : Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.
525
526 ; Abgelaufen-Overlay
527 : Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.
528
529 ; CSS (Portal)
530 : Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.
531
532 ; JavaScript (Portal)
533 : Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.
534
535 ; HTML header (Portal)
536 : 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.
537
538 == Speicherort der Inhalte des Gewinnspiel-Portals ==
539
540 Die unter //Konfiguration// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].
541
542 **Es handelt sich um die folgenden Dateien:**
543
544 |=Dateiname|=Inhalt
545 |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
546 |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
547 |contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite
548 |contest-portal.js.txt|JavaScript der Gewinnspiel-Portalseite
549 |contest-portal.meta.html|HTML header der Gewinnspiel-Portalseite
550 |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
551 |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
552 |expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist
553
554 == Konfigurationsmöglichkeiten des Plugins ==
555
556 {{id name="config_quartz"/}}
557
558 === Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} ===
559
560 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.
561
562 ; portal.contestent.deletion.cron
563 : Ü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>>url:http://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.
564
565 == Plugin-Aktion: Gewinn ermitteln {{version major="1" minor="6"}}{{/version}} ==
566
567 {{figure image="aktion_prize_chance.png" clear="h2"}}
568 Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln//
569 {{/figure}}
570
571 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.
572
573 === Parameter ===
574
575 ==== Ziehmodus ====
576
577 ; **Gewinncode**
578 : 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.
579
580 ; **Gewinnchance**
581 : Durch den Zieh-Modus //Gewinnchance// kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü //Limitieren auf Kategorie//.
582 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.
583 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.
584
585 === Rückgabewert der Plugin-Aktion ===
586
587 Rückgabewert der Aktion sind die Attribute des möglichen Gewinns, welche über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables||anchor="HAktionsplatzhalter"]] ausgelesen werden können. So können sie zum Beispiel in [[HTML-Templates>>Formcycle.UserInterface.FilesAndTemplates.HTML]] im Gewinnspiel-Portal angezeigt werden. Ein weiterer Anwendungsfall wäre die Verwendung als [[Abarbeitungsbedingung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] einer Aktion vom Typ [[Statusänderung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ChangeState]] bei Erfolg der Aktion //Gewinn ermitteln//. Hier könnte im geänderten Status nun über eine Aktion vom Typ [[Abschlussseite>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ResponsePage]] ein bestimmtes HTML-Template angezeigt werden.
588
589 **Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:**
590
591 |=Rückgabewert|=Beschreibung
592 |[%$Aktionsname.SUCCESS%]|Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein
593 |[%$Aktionsname.RESULT[0].uuid%]|Eindeutige UUID des erhaltenen Gewinns
594 |[%$Aktionsname.RESULT[0].description%]|Beschreibung des erhaltenen Gewinns
595 |[%$Aktionsname.RESULT[0].category%]|Kategorie des erhaltenen Gewinns
596 |[%$Aktionsname.RESULT[0].process%]|Eindeutige UUID des Gewinner-Vorgangs
597 |[%$Aktionsname.RESULT[0].picture%]|Bild-URL des erhaltenen Gewinns
598 |[%$Aktionsname.RESULT[0].link%]|Gewinn-Link des erhaltenen Gewinns
599
600 == JavaScript-Schnittstellen ==
601
602 === Allgemein ===
603
604 Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:
605
606 ==== Scrollen zum Seitenanfang: ====
607
608 {{code language="none"}}
609 // Innerhalb des Kontextes
610 Contest.scrollToTop();
611
612 // Innerhalb des Formulares
613 // - falls dies in der selben Domain betrieben wird
614 window.parent.Contest.scrollToTop();
615
616 // - falls dies nicht in der selben Domain betrieben wird
617 window.parent.postMessage('scrollToTop', '*');
618
619 // Allgemein ansprechbar über postMessage:
620 <window>.postMessage('scrollToTop', '*');
621 {{/code}}
622
623 ==== Scrollen zu den Teilnahmebedingungen: ====
624
625 {{code language="none"}}
626 // Innerhalb des Kontextes
627 Contest.scrollToTerms();
628
629 // Innerhalb des Formulares
630 // - falls dies in der selben Domain betrieben wird
631 window.parent.Contest.scrollToTerms();
632
633 // - falls dies nicht in der selben Domain betrieben wird
634 window.parent.postMessage('scrollToTerms', '*');
635
636 // Allgemein ansprechbar über postMessage:
637 <window>.postMessage('scrollToTerms', '*');
638 {{/code}}
639
640 ==== Scrollen zur Datenschutz-Erklärung: ====
641
642 {{code language="none"}}
643 // Innerhalb des Kontextes
644 Contest.scrollToPrivacy();
645
646 // Innerhalb des Formulares
647 // - falls dies in der selben Domain betrieben wird
648 window.parent.Contest.scrollToPrivacy();
649
650 // - falls dies nicht in der selben Domain betrieben wird
651 window.parent.postMessage('scrollToPrivacy', '*');
652
653 // Allgemein ansprechbar über postMessage:
654 <window>.postMessage('scrollToPrivacy', '*');
655
656 {{/code}}
657
658 ==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====
659
660 {{code language="none"}}
661 // Innerhalb des Kontextes
662 Contest.scrollToForm();
663
664 // Innerhalb des Formulares
665 // - falls dies in der selben Domain betrieben wird
666 window.parent.Contest.scrollToForm();
667
668 // - falls dies nicht in der selben Domain betrieben wird
669 window.parent.postMessage('scrollToForm', '*');
670
671 // Allgemein ansprechbar über postMessage:
672 <window>.postMessage('scrollToForm', '*');
673
674 {{/code}}
675
676 ==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====
677
678 {{code language="none"}}
679 // Innerhalb des Kontextes
680 Contest.scrollToContestTop();
681
682 // Innerhalb des Formulares
683 // - falls dies in der selben Domain betrieben wird
684 window.parent.Contest.scrollToContestTop();
685
686 // - falls dies nicht in der selben Domain betrieben wird
687 window.parent.postMessage('scrollToContestTop', '*');
688
689 // Allgemein ansprechbar über postMessage:
690 <window>.postMessage('scrollToContestTop', '*');
691
692 {{/code}}
693
694 ==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====
695
696 {{code language="none"}}
697 // Innerhalb des Kontextes
698 Contest.scrollToContent();
699
700 // Innerhalb des Formulares
701 // - falls dies in der selben Domain betrieben wird
702 window.parent.Contest.scrollToContent();
703
704 // - falls dies nicht in der selben Domain betrieben wird
705 window.parent.postMessage('scrollToContent', '*');
706
707 // Allgemein ansprechbar über postMessage:
708 <window>.postMessage('scrollToContent', '*');
709
710 {{/code}}
711
712 ==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====
713
714 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.
715
716 {{code language="none"}}
717 // Liefert standardmäßig 0 zurück
718 Contest.calcScrollOffset();
719
720 // Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).
721 Contest.calcScrollOffset = function(){
722 if(window.matchMedia('(min-width: 960px)').matches){
723 return 0;
724 }else{
725 return -60;
726 }
727 }
728 {{/code}}
729
730
731 === Portal-spezifisch ===
732
733 Innerhalb des Portals wird für die Carousel-Darstellung die Bibliothekt [[slick>>https://kenwheeler.github.io/slick/||rel="noopener noreferrer" target="_blank"]] verwendet. Dies lässt sich hierbei wie folgt ansprechen und umkonfigurieren:
734
735 {{code language="none"}}
736 // Abholen des entsprechenden Carousel-Objekts
737 var carousel = $('.portal-carousel-images');
738
739 // Beispielhafte konfiguration des Autoplay-Features
740 if (carousel && carousel.length > 0) {
741 carousel.slick('slickSetOption', 'speed', 1000)
742 carousel.slick('slickSetOption', 'autoplaySpeed', 5000);
743 carousel.slick('slickPlay');
744 }
745 {{/code}}
746
747 (% class="wikigeneratedid" id="HSelektioneinesbestimmtenGewinnspiels:" %)
748 Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:
749
750 {{code language="none"}}
751 // Innerhalb des Kontextes
752 Portal.goToContest(<uuid>);
753
754 // Innerhalb des Formulares
755 // - falls dies in der selben Domain betrieben wird
756 window.parent.Portal.goToContest(<uuid>);
757
758 // - falls dies nicht in der selben Domain betrieben wird
759 var data = {
760 msg: 'goToContest',
761 uuid: <uuid>
762 };
763 window.parent.postMessage(data, '*')
764
765 // Allgemein ansprechbar über postMessage:
766 var data = {
767 msg: "goToContest",
768 uuid: <uuid>
769 };
770 <window>.postMessage(data , '*')
771 {{/code}}
772
773 === Microsite-spezifisch ===
774
775 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>>https://github.com/davidjbradshaw/iframe-resizer||rel="noopener noreferrer" target="_blank"]] bereitgestellt.
776
777 == Einbinden als Microsite ==
778
779 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:
780
781 ==== Resizing der IFrame anhand ihres Inhaltes ====
782
783 Hier kommt die Bibliothekt [[iFrame Resizer>>https://github.com/davidjbradshaw/iframe-resizer||rel="noopener noreferrer" target="_blank"]] 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:
784
785 {{code language="none"}}
786 iFrameResize({log: false}, '<CSS-Selektor der iframe>');
787 {{/code}}
788
789 ==== Scrolling zu gewünschten Stellen auf der Microsite ====
790
791 Für diese Funktionalität werden an die Zielseite durch die Microsite entsprechende postMessages gesendet. Unter der Verwendung von [[jQuery>>https://jquery.com/||rel="noopener noreferrer" target="_blank"]] kann dessen Auswertung wie folgt stattfinden:
792
793 {{code language="none"}}
794 // Behandelt Messages der Microsite
795 function _handleMessage(event){
796
797 // Prüfung ob es sich um eine Scroll-Message handelt
798 if(event.data.scrollTarget || event.data.scrollOffset){
799
800 // Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich.
801 var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top;
802
803 // Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame
804 $('html, body').animate({
805 scrollTop : event.data.scrollOffset + frameOffset
806 }, 'slow');
807
808 // Weiterleitung aller weiteren postMessages an die Microsite
809 }else{
810 $('<CSS-Selektor der iFrame>').each(function(){
811 var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView;
812 iframewindow.postMessage(event.data,"*");
813 });
814 }
815 }
816
817 // Registireren der Message-Behandlung
818 if (window.addEventListener) {
819 window.addEventListener('message', _handleMessage, false);
820 } else if (window.attachEvent) { // ie8
821 window.attachEvent('onmessage', _handleMessage);
822 }
823
824 {{/code}}
825
826
827 {{info}}
828 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!
829 {{/info}}
830
831 == Versionshistorie ==
832
833 === 1.7.0 ===
834
835 * Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen
836
837 === 1.6.0 ===
838
839 * Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien
840 * Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit
841
842 === 1.5.0 ===
843
844 * Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
845 * JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
846
847 === 1.4.0 ===
848
849 * Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
850 * Erweiterung der scrollTo-Funktionen
851 * Kleinere CSS-Anpassungen
852
853 === 1.3.4 ===
854
855 * CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
856
857 === 1.3.3 ===
858
859 * Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies
860 * Korrektur der Formular- und iFrameResizer-URL in der Vorschau
861
862 === 1.3.2 ===
863
864 * Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht
865
866 === 1.3.1 ===
867
868 * Über den Plugin-Parameter //portal.usebaseurl// kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.
869 * Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite
870
871 === 1.3.0 ===
872
873 * Fehlerbehebung beim Ausliefern über den Frontend-Server
874 * Einbau eines iFrame-Resizer für Microseiten
875 * Weitergabe von scroll-Nachrichten an top-window
876
877 === 1.2.4 ===
878
879 * Weiterleitung von postMessage an iframe innerhalb von Microsites
880
881 === 1.2.3 ===
882
883 * Durchreichen von URL-Parametern an IFames im Portal
884 * Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter
885
886 === 1.2.2 ===
887
888 * Undo/Redo-Funktionalität an Editoren aktiviert
889 * Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut
890 * Kleinere Anpassungen/Bugfixes
891
892 === 1.2.0 ===
893
894 * Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren
895 * Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints
896 * Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen
897
898 === 1.1.0 ===
899
900 * Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8
901
902 === 1.0.1 ===
903
904 * Anpassungen für FORMCYCLE Version 6.4.x

Navigation

Copyright 2000-2025