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

Navigation

Copyright 2000-2025