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

Navigation

Copyright 2000-2025