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