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="contest_ui_de.png" 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="contest_meta_data_de.png" clear="h2"}}
157 Mögliche Optionen zum Konfigurieren der Metadaten des Gewinnspiels.
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 {{figure image="contest_deletions_de.png" clear="h2"}}
216 Konfigurationsoberfläche zur Verwaltung der Löschfristen eines Gewinnspiels
217 {{/figure}}
218
219 ; **Löschfristen des Gewinnspiels** {{version major="1" minor="7"}}{{/version}}
220 : 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.
221 :: **Löschtyp**
222 ::; **nach Ende des Gewinnspiels**
223 ::: 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.
224 ::; **nach Formulareingang**
225 ::: Eine Löschfrist dieses Typs wird erst angewandt, wenn die eingestellten Tage der Löschfrist nach Eingang des Vorgangs in das Postfach vergangen sind.
226 :; **Löschstatus**
227 :: 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.
228 :; **Tage bis zur Löschung**
229 :: Tage die es benötigt in Abhängigkeit zum Löschtyp bis Ausführung der Löschfrist.
230
231 : 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.
232
233 ==== Inhalt ====
234
235 {{figure image="contest_content_de.png" clear="h2"}}
236 Mögliche Optionen zur Anpassung der Inhalte eines Gewinnspiels
237 {{/figure}}
238
239 ; **Layout**
240 : 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:
241 :; **Formular links**
242 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
243 :; **Formular rechts**
244 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
245 :; **Formular oben**
246 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
247 :; **Formular unten**
248 :: Der //Beschreibungstext// wird über dem Formular angezeigt
249 :; **ohne Beschreibung**
250 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
251
252 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
253 Vorhandene Schaltflächen unter //Bannergrafiken//.
254 {{/figure}}
255
256 ; Bannergrafiken
257 : 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:
258 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
259 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
260 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
261 : 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.
262
263 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
264 :; **Desktop**, **Tablet** und **Mobile**
265 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
266 :; **+ Bannergrafik ändern**
267 :: Ö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.
268 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
269 :: Löschen der Grafik
270
271 {{figure image="gs_inhalt_de.png" clear="h2"}}
272 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
273 {{/figure}}
274
275 ; **Inhalt**
276 : 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.
277 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
278 :; **Beschreibung**
279 :: Beschreibungstext zum Gewinnspiel. Wird neben bzw. über oder unter dem Formular angezeigt.
280 :; **Teilnahmebedingungen**
281 :: Teilnahmebedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
282 :; **Datenschutz**
283 :: Datenschutzbedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
284 :; **Ankündigung**
285 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
286 :; **Abgelaufen**
287 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
288 :; **CSS (Microsite)**
289 :: Zusätzlicher CSS-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
290 :; **JavaScript (Microsite)**
291 :: Zusätzlicher JavaScript-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
292 :; **HTML header (Microsite)**
293 :: 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.
294
295 ==== Fußzeile ====
296
297 Hier befinden sich die folgenden zwei Schaltflächen:
298
299 ; **Formular bearbeiten**
300 : Ö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.
301
302 ; **Gewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
303 : 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.
304
305 ; **Ersatzgewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
306 : 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.
307
308 ; **Teilnehmer exportieren** {{version major="1" minor="5"}}{{/version}}
309 : 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.
310
311 ; **Gewinne verwalten** {{version major="1" minor="6"}}{{/version}}
312 : Diese Schaltfläche ist erst bei entsprechender Berechtigung verfügbar. Sie öffnet den Dialog zur Verwaltung der Gewinne des ausgewählten Gewinnspiels.
313
314 ; **Speichern**
315 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
316 \\\\{{id name="backend_vorlagen"/}}
317
318 === Gewinner ermitteln {{version major="1" minor="4"}}{{/version}} ===
319
320 Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde, ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
321
322 {{figure image="dialog_1_de.png" clear="h2"}}
323 Dialog zu Konfiguration der Gewinnerziehung.
324 {{/figure}}
325
326 ==== Konfiguration ====
327
328 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.
329
330 {{figure image="dialog_2_de.png" clear="h2"}}
331 Anzeige der ermittelten Gewinner
332 {{/figure}}
333
334 ==== Auswertung ====
335
336 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.
337
338
339 ==== Gewinner nachziehen ====
340
341 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.
342 \\{{id name="backend_prizes"/}}
343
344
345
346
347
348 === Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===
349
350 {{figure image="dialog_prize_de.PNG" clear="h2"}}
351 Verwaltungsdialog für Gewinne
352 {{/figure}}
353
354 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.
355
356 ==== Menü ====
357
358 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.
359
360 ==== Gewinndetails ====
361
362 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:
363
364 ; **UUID des Gewinns**
365 : Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.
366
367 ; **Gewinnname**
368 : Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.
369
370 ; **Kategorie**
371 : Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion //Gewinn ermitteln// genutzt für eine möglichen Limitierung der Gewinnziehung auf eine Kategorie.
372
373 ; **Gewinncode**
374 : Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen.
375
376 ; **Gewinn-Link**
377 : Benutzerdefinierter Link für den Gewinn, um bspw. eine URL als Link in das Gewinnbild einzubinden.
378
379 ; **UUID des Gewinner-Vorgangs**
380 : 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.
381
382 ; **Gewinnbeschreibung**
383 : 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.
384
385 ; **Gewinnbild**
386 : Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:
387 :; **Über eine Bild-Ressource**
388 :: 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.
389 :; **Über eine Bild-URL**
390 :: 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.
391 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.
392
393 ; **Speichern**
394 : Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.
395
396 ==== Fußzeile ====
397
398 Hier befinden sich die folgenden zwei Schaltflächen:
399
400 ; **+ Excel-Import**
401 : Import von Gewinnen aus Excel-Datei.
402
403 ; **Schließen**
404 : Schließen des Dialogfensters.
405
406 {{figure image="dialog_import_excel_de.PNG" clear="h2"}}
407 Dialog zur Konfiguration des Excel-Imports
408 {{/figure}}
409
410 ==== Excel-Import von Gewinnen ====
411
412 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.
413
414 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.
415 Ü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.
416 \\{{id name="backend_prize_import"/}}
417
418
419
420
421 === Vorlagen verwalten ===
422
423 {{figure image="vorlagen_ui_de.png" clear="h2"}}
424 Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
425 {{/figure}}
426
427 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.
428
429 ==== Menü ====
430
431 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.
432
433 ==== Einstellungen ====
434
435 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:
436
437 ; **Name der Vorlage:**
438 : Innerhalb von {{formcycle/}} angezeigter Name der Vorlage.
439
440 ; **Layout:**
441 : 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:
442 :; **Formular links**
443 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
444 :; **Formular rechts**
445 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
446 :; **Formular oben**
447 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
448 :; **Formular unten**
449 :: Der //Beschreibungstext// wird über dem Formular angezeigt
450 :; **ohne Beschreibung**
451 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
452
453 ; **Microsite**
454 : 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:
455 :; **Vorschau**
456 :: 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:
457 :; **Vorschau als angekündigt**
458 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
459 :; **Vorschau als abgelaufen**
460 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
461
462 {{figure image="gs_inhalt_de.png" clear="h2"}}
463 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
464 {{/figure}}
465
466 ; **Inhalt**
467 : 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.
468 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
469 :; **Beschreibung**
470 :: Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.
471 :; **Teilnahmebedingungen**
472 :: Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
473 :; **Datenschutz**
474 :: Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
475 :; **Ankündigung**
476 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
477 :; **Abgelaufen**
478 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
479 :; **CSS (Microsite)**
480 :: Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
481 :; **JavaScript (Microsite)**
482 :: Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
483 :; **HTML header (Microsite)**
484 :: 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.
485
486 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
487 Vorhandene Schaltflächen unter //Bannergrafiken//.
488 {{/figure}}
489
490 ; Bannergrafiken
491 : 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:
492 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
493 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
494 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
495 : 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.
496
497 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
498 :; **Desktop**, **Tablet** und **Mobile**
499 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
500 :; **+ Bannergrafik ändern**
501 :: Ö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.
502 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
503 :: Löschen der Grafik
504
505 ==== Fußzeile ====
506
507 Hier befinden sich die folgenden zwei Schaltflächen:
508
509 ; **Formular bearbeiten**
510 : Ö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.
511
512 ; **Speichern**
513 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
514 \\\\{{id name="backend_portal"/}}
515
516 === Konfiguration ===
517
518 {{figure image="portal_ui_de.png" clear="h2"}}
519 Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//.
520 {{/figure}}
521
522 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:
523
524 ; Kopfbereich
525 : Über dem Formular angezeigter Inhalt.
526
527 ; Trenner
528 : Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.
529
530 ; Fußbereich
531 : Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.
532
533 ; Abgelaufen-Overlay
534 : Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.
535
536 ; CSS (Portal)
537 : Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.
538
539 ; JavaScript (Portal)
540 : Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.
541
542 ; HTML header (Portal)
543 : 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.
544
545 == Speicherort der Inhalte des Gewinnspiel-Portals ==
546
547 Die unter //Konfiguration// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].
548
549 **Es handelt sich um die folgenden Dateien:**
550
551 |=Dateiname|=Inhalt
552 |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
553 |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
554 |contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite
555 |contest-portal.js.txt|JavaScript der Gewinnspiel-Portalseite
556 |contest-portal.meta.html|HTML header der Gewinnspiel-Portalseite
557 |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
558 |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
559 |expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist
560
561 == Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} ==
562
563 {{id name="config_quartz"/}}
564
565 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.
566
567 ; portal.contestent.deletion.cron
568 : Ü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.
569
570 == Plugin-Aktion: Gewinn ermitteln {{version major="1" minor="6"}}{{/version}} ==
571
572 {{figure image="aktion_prize_chance.png" clear="h2"}}
573 Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln//
574 {{/figure}}
575
576 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.
577
578 === Parameter ===
579
580 ==== Ziehmodus ====
581
582 ; **Gewinncode**
583 : 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.
584
585 ; **Gewinnchance**
586 : Durch den Zieh-Modus //Gewinnchance// kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü //Limitieren auf Kategorie//.
587 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.
588 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.
589
590 === Rückgabewert der Plugin-Aktion ===
591
592 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.
593
594 **Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:**
595
596 |=Rückgabewert|=Beschreibung
597 |[%$Aktionsname.SUCCESS%]|Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein
598 |[%$Aktionsname.RESULT[0].uuid%]|Eindeutige UUID des erhaltenen Gewinns
599 |[%$Aktionsname.RESULT[0].description%]|Beschreibung des erhaltenen Gewinns
600 |[%$Aktionsname.RESULT[0].category%]|Kategorie des erhaltenen Gewinns
601 |[%$Aktionsname.RESULT[0].process%]|Eindeutige UUID des Gewinner-Vorgangs
602 |[%$Aktionsname.RESULT[0].picture%]|Bild-URL des erhaltenen Gewinns
603 |[%$Aktionsname.RESULT[0].link%]|Gewinn-Link des erhaltenen Gewinns
604
605 == JavaScript-Schnittstellen ==
606
607 === Allgemein ===
608
609 Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:
610
611 ==== Scrollen zum Seitenanfang: ====
612
613 {{code language="none"}}
614 // Innerhalb des Kontextes
615 Contest.scrollToTop();
616
617 // Innerhalb des Formulares
618 // - falls dies in der selben Domain betrieben wird
619 window.parent.Contest.scrollToTop();
620
621 // - falls dies nicht in der selben Domain betrieben wird
622 window.parent.postMessage('scrollToTop', '*');
623
624 // Allgemein ansprechbar über postMessage:
625 <window>.postMessage('scrollToTop', '*');
626 {{/code}}
627
628 ==== Scrollen zu den Teilnahmebedingungen: ====
629
630 {{code language="none"}}
631 // Innerhalb des Kontextes
632 Contest.scrollToTerms();
633
634 // Innerhalb des Formulares
635 // - falls dies in der selben Domain betrieben wird
636 window.parent.Contest.scrollToTerms();
637
638 // - falls dies nicht in der selben Domain betrieben wird
639 window.parent.postMessage('scrollToTerms', '*');
640
641 // Allgemein ansprechbar über postMessage:
642 <window>.postMessage('scrollToTerms', '*');
643 {{/code}}
644
645 ==== Scrollen zur Datenschutz-Erklärung: ====
646
647 {{code language="none"}}
648 // Innerhalb des Kontextes
649 Contest.scrollToPrivacy();
650
651 // Innerhalb des Formulares
652 // - falls dies in der selben Domain betrieben wird
653 window.parent.Contest.scrollToPrivacy();
654
655 // - falls dies nicht in der selben Domain betrieben wird
656 window.parent.postMessage('scrollToPrivacy', '*');
657
658 // Allgemein ansprechbar über postMessage:
659 <window>.postMessage('scrollToPrivacy', '*');
660
661 {{/code}}
662
663 ==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====
664
665 {{code language="none"}}
666 // Innerhalb des Kontextes
667 Contest.scrollToForm();
668
669 // Innerhalb des Formulares
670 // - falls dies in der selben Domain betrieben wird
671 window.parent.Contest.scrollToForm();
672
673 // - falls dies nicht in der selben Domain betrieben wird
674 window.parent.postMessage('scrollToForm', '*');
675
676 // Allgemein ansprechbar über postMessage:
677 <window>.postMessage('scrollToForm', '*');
678
679 {{/code}}
680
681 ==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====
682
683 {{code language="none"}}
684 // Innerhalb des Kontextes
685 Contest.scrollToContestTop();
686
687 // Innerhalb des Formulares
688 // - falls dies in der selben Domain betrieben wird
689 window.parent.Contest.scrollToContestTop();
690
691 // - falls dies nicht in der selben Domain betrieben wird
692 window.parent.postMessage('scrollToContestTop', '*');
693
694 // Allgemein ansprechbar über postMessage:
695 <window>.postMessage('scrollToContestTop', '*');
696
697 {{/code}}
698
699 ==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====
700
701 {{code language="none"}}
702 // Innerhalb des Kontextes
703 Contest.scrollToContent();
704
705 // Innerhalb des Formulares
706 // - falls dies in der selben Domain betrieben wird
707 window.parent.Contest.scrollToContent();
708
709 // - falls dies nicht in der selben Domain betrieben wird
710 window.parent.postMessage('scrollToContent', '*');
711
712 // Allgemein ansprechbar über postMessage:
713 <window>.postMessage('scrollToContent', '*');
714
715 {{/code}}
716
717 ==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====
718
719 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.
720
721 {{code language="none"}}
722 // Liefert standardmäßig 0 zurück
723 Contest.calcScrollOffset();
724
725 // Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).
726 Contest.calcScrollOffset = function(){
727 if(window.matchMedia('(min-width: 960px)').matches){
728 return 0;
729 }else{
730 return -60;
731 }
732 }
733 {{/code}}
734
735
736 === Portal-spezifisch ===
737
738 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:
739
740 {{code language="none"}}
741 // Abholen des entsprechenden Carousel-Objekts
742 var carousel = $('.portal-carousel-images');
743
744 // Beispielhafte konfiguration des Autoplay-Features
745 if (carousel && carousel.length > 0) {
746 carousel.slick('slickSetOption', 'speed', 1000)
747 carousel.slick('slickSetOption', 'autoplaySpeed', 5000);
748 carousel.slick('slickPlay');
749 }
750 {{/code}}
751
752 (% class="wikigeneratedid" id="HSelektioneinesbestimmtenGewinnspiels:" %)
753 Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:
754
755 {{code language="none"}}
756 // Innerhalb des Kontextes
757 Portal.goToContest(<uuid>);
758
759 // Innerhalb des Formulares
760 // - falls dies in der selben Domain betrieben wird
761 window.parent.Portal.goToContest(<uuid>);
762
763 // - falls dies nicht in der selben Domain betrieben wird
764 var data = {
765 msg: 'goToContest',
766 uuid: <uuid>
767 };
768 window.parent.postMessage(data, '*')
769
770 // Allgemein ansprechbar über postMessage:
771 var data = {
772 msg: "goToContest",
773 uuid: <uuid>
774 };
775 <window>.postMessage(data , '*')
776 {{/code}}
777
778 === Microsite-spezifisch ===
779
780 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.
781
782 == Einbinden als Microsite ==
783
784 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:
785
786 ==== Resizing der IFrame anhand ihres Inhaltes ====
787
788 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:
789
790 {{code language="none"}}
791 iFrameResize({log: false}, '<CSS-Selektor der iframe>');
792 {{/code}}
793
794 ==== Scrolling zu gewünschten Stellen auf der Microsite ====
795
796 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:
797
798 {{code language="none"}}
799 // Behandelt Messages der Microsite
800 function _handleMessage(event){
801
802 // Prüfung ob es sich um eine Scroll-Message handelt
803 if(event.data.scrollTarget || event.data.scrollOffset){
804
805 // Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich.
806 var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top;
807
808 // Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame
809 $('html, body').animate({
810 scrollTop : event.data.scrollOffset + frameOffset
811 }, 'slow');
812
813 // Weiterleitung aller weiteren postMessages an die Microsite
814 }else{
815 $('<CSS-Selektor der iFrame>').each(function(){
816 var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView;
817 iframewindow.postMessage(event.data,"*");
818 });
819 }
820 }
821
822 // Registireren der Message-Behandlung
823 if (window.addEventListener) {
824 window.addEventListener('message', _handleMessage, false);
825 } else if (window.attachEvent) { // ie8
826 window.attachEvent('onmessage', _handleMessage);
827 }
828
829 {{/code}}
830
831
832 {{info}}
833 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!
834 {{/info}}
835
836 == Versionshistorie ==
837
838 === 1.7.0 ===
839
840 * Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen
841
842 === 1.6.0 ===
843
844 * Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien
845 * Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit
846
847 === 1.5.0 ===
848
849 * Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
850 * JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
851
852 === 1.4.0 ===
853
854 * Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
855 * Erweiterung der scrollTo-Funktionen
856 * Kleinere CSS-Anpassungen
857
858 === 1.3.4 ===
859
860 * CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
861
862 === 1.3.3 ===
863
864 * Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies
865 * Korrektur der Formular- und iFrameResizer-URL in der Vorschau
866
867 === 1.3.2 ===
868
869 * Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht
870
871 === 1.3.1 ===
872
873 * Über den Plugin-Parameter //portal.usebaseurl// kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.
874 * Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite
875
876 === 1.3.0 ===
877
878 * Fehlerbehebung beim Ausliefern über den Frontend-Server
879 * Einbau eines iFrame-Resizer für Microseiten
880 * Weitergabe von scroll-Nachrichten an top-window
881
882 === 1.2.4 ===
883
884 * Weiterleitung von postMessage an iframe innerhalb von Microsites
885
886 === 1.2.3 ===
887
888 * Durchreichen von URL-Parametern an IFames im Portal
889 * Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter
890
891 === 1.2.2 ===
892
893 * Undo/Redo-Funktionalität an Editoren aktiviert
894 * Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut
895 * Kleinere Anpassungen/Bugfixes
896
897 === 1.2.0 ===
898
899 * Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren
900 * Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints
901 * Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen
902
903 === 1.1.0 ===
904
905 * Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8
906
907 === 1.0.1 ===
908
909 * Anpassungen für FORMCYCLE Version 6.4.x

Navigation

Copyright 2000-2025