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_gewinner_ermitteln"/}}
328
329
330
331 === Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===
332
333 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.
334
335 ==== Menü ====
336
337 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.
338
339 ==== Gewinndetails ====
340
341 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:
342
343 ; **UUID des Gewinns**
344 : Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.
345
346 ; **Gewinnname**
347 : Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.
348
349 ; **Kategorie**
350 : Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion //Gewinn ermitteln// genutzt, zur möglichen Limitierung der Gewinnziehung auf eine Kategorie.
351
352 ; **Gewinncode**
353 : Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen.
354
355 ; **UUID des Gewinner-Vorgangs**
356 : 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.
357
358 ; **Gewinnbeschreibung**
359 : 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.
360
361 ; **Gewinnbild**
362 : Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:
363
364 :; **Über eine Bild-Ressource**
365 :: 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.
366
367 :; **Über eine Bild-URL**
368 :: 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.
369 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.
370
371 ; **Speichern**
372 : Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.
373
374 ==== Fußzeile ====
375
376 Hier befinden sich die folgenden zwei Schaltflächen:
377
378 ; + Excel-Import
379 : Import von Gewinnen aus Excel-Datei. Siehe Excel-Import
380
381 ;Schließen
382 : Schließen des Dialogfensters.
383 \\\\{{id name="backend_prizes"/}}
384
385 ==== Excel-Import von Gewinnen ====
386
387 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.
388
389 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.
390 Ü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.
391
392
393 === Vorlagen verwalten ===
394
395 {{figure image="vorlagen_ui_de.png" clear="h2"}}
396 Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
397 {{/figure}}
398
399 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.
400
401 ==== Menü ====
402
403 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.
404
405 ==== Einstellungen ====
406
407 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:
408
409 ; **Name der Vorlage:**
410 : Innerhalb von {{formcycle/}} angezeigter Name der Vorlage.
411
412 ; **Layout:**
413 : 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:
414 :; **Formular links**
415 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
416 :; **Formular rechts**
417 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
418 :; **Formular oben**
419 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
420 :; **Formular unten**
421 :: Der //Beschreibungstext// wird über dem Formular angezeigt
422 :; **ohne Beschreibung**
423 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
424
425 ; **Microsite**
426 : 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:
427 :; **Vorschau**
428 :: 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:
429 :; **Vorschau als angekündigt**
430 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
431 :; **Vorschau als abgelaufen**
432 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
433
434 {{figure image="gs_inhalt_de.png" clear="h2"}}
435 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
436 {{/figure}}
437
438 ; **Inhalt**
439 : 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.
440 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
441 :; **Beschreibung**
442 :: Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.
443 :; **Teilnahmebedingungen**
444 :: Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
445 :; **Datenschutz**
446 :: Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
447 :; **Ankündigung**
448 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
449 :; **Abgelaufen**
450 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
451 :; **CSS (Microsite)**
452 :: Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
453 :; **JavaScript (Microsite)**
454 :: Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
455 :; **HTML header (Microsite)**
456 :: 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.
457
458 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
459 Vorhandene Schaltflächen unter //Bannergrafiken//.
460 {{/figure}}
461
462 ; Bannergrafiken
463 : 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:
464 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
465 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
466 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
467 : 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.
468
469 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
470 :; **Desktop**, **Tablet** und **Mobile**
471 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
472 :; **+ Bannergrafik ändern**
473 :: Ö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.
474 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
475 :: Löschen der Grafik
476
477 ==== Fußzeile ====
478
479 Hier befinden sich die folgenden zwei Schaltflächen:
480
481 ; **Formular bearbeiten**
482 : Ö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.
483
484 ; **Speichern**
485 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
486 \\\\{{id name="backend_portal"/}}
487
488 === Konfiguration ===
489
490 {{figure image="portal_ui_de.png" clear="h2"}}
491 Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//.
492 {{/figure}}
493
494 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:
495
496 ; Kopfbereich
497 : Über dem Formular angezeigter Inhalt.
498
499 ; Trenner
500 : Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.
501
502 ; Fußbereich
503 : Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.
504
505 ; Abgelaufen-Overlay
506 : Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.
507
508 ; CSS (Portal)
509 : Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.
510
511 ; JavaScript (Portal)
512 : Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.
513
514 ; HTML header (Portal)
515 : 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.
516
517 == Speicherort der Inhalte des Gewinnspiel-Portals ==
518
519 Die unter //Konfiguration// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].
520
521 **Es handelt sich um die folgenden Dateien:**
522
523 |=Dateiname|=Inhalt
524 |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
525 |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
526 |contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite
527 |contest-portal.js.txt|JavaScript der Gewinnspiel-Portalseite
528 |contest-portal.meta.html|HTML header der Gewinnspiel-Portalseite
529 |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
530 |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
531 |expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist
532
533 == JavaScript-Schnittstellen ==
534
535 === Allgemein ===
536
537 Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:
538
539 ==== Scrollen zum Seitenanfang: ====
540
541 {{code language="none"}}
542 // Innerhalb des Kontextes
543 Contest.scrollToTop();
544
545 // Innerhalb des Formulares
546 // - falls dies in der selben Domaine betrieben wird
547 window.parent.Contest.scrollToTop();
548
549 // - falls dies nicht in der selben Domaine betrieben wird
550 window.parent.postMessage('scrollToTop', '*');
551
552 // Allgemein ansprechbar über postMessage:
553 <window>.postMessage('scrollToTop', '*');
554 {{/code}}
555
556 ==== Scrollen zu den Teilnahmebedingungen: ====
557
558 {{code language="none"}}
559 // Innerhalb des Kontextes
560 Contest.scrollToTerms();
561
562 // Innerhalb des Formulares
563 // - falls dies in der selben Domaine betrieben wird
564 window.parent.Contest.scrollToTerms();
565
566 // - falls dies nicht in der selben Domaine betrieben wird
567 window.parent.postMessage('scrollToTerms', '*');
568
569 // Allgemein ansprechbar über postMessage:
570 <window>.postMessage('scrollToTerms', '*');
571 {{/code}}
572
573 ==== Scrollen zur Datenschutz-Erklärung: ====
574
575 {{code language="none"}}
576 // Innerhalb des Kontextes
577 Contest.scrollToPrivacy();
578
579 // Innerhalb des Formulares
580 // - falls dies in der selben Domaine betrieben wird
581 window.parent.Contest.scrollToPrivacy();
582
583 // - falls dies nicht in der selben Domaine betrieben wird
584 window.parent.postMessage('scrollToPrivacy', '*');
585
586 // Allgemein ansprechbar über postMessage:
587 <window>.postMessage('scrollToPrivacy', '*');
588
589 {{/code}}
590
591 ==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====
592
593 {{code language="none"}}
594 // Innerhalb des Kontextes
595 Contest.scrollToForm();
596
597 // Innerhalb des Formulares
598 // - falls dies in der selben Domaine betrieben wird
599 window.parent.Contest.scrollToForm();
600
601 // - falls dies nicht in der selben Domaine betrieben wird
602 window.parent.postMessage('scrollToForm', '*');
603
604 // Allgemein ansprechbar über postMessage:
605 <window>.postMessage('scrollToForm', '*');
606
607 {{/code}}
608
609 ==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====
610
611 {{code language="none"}}
612 // Innerhalb des Kontextes
613 Contest.scrollToContestTop();
614
615 // Innerhalb des Formulares
616 // - falls dies in der selben Domaine betrieben wird
617 window.parent.Contest.scrollToContestTop();
618
619 // - falls dies nicht in der selben Domaine betrieben wird
620 window.parent.postMessage('scrollToContestTop', '*');
621
622 // Allgemein ansprechbar über postMessage:
623 <window>.postMessage('scrollToContestTop', '*');
624
625 {{/code}}
626
627 ==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====
628
629 {{code language="none"}}
630 // Innerhalb des Kontextes
631 Contest.scrollToContent();
632
633 // Innerhalb des Formulares
634 // - falls dies in der selben Domaine betrieben wird
635 window.parent.Contest.scrollToContent();
636
637 // - falls dies nicht in der selben Domaine betrieben wird
638 window.parent.postMessage('scrollToContent', '*');
639
640 // Allgemein ansprechbar über postMessage:
641 <window>.postMessage('scrollToContent', '*');
642
643 {{/code}}
644
645 ==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====
646
647 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.
648
649 {{code language="none"}}
650 // Liefert standardmäßig 0 zurück
651 Contest.calcScrollOffset();
652
653 // Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).
654 Contest.calcScrollOffset = function(){
655 if(window.matchMedia('(min-width: 960px)').matches){
656 return 0;
657 }else{
658 return -60;
659 }
660 }
661 {{/code}}
662
663
664 === Portal-spezifisch ===
665
666 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:
667
668 {{code language="none"}}
669 // Abholen des entsprechenden Carousel-Objekts
670 var carousel = $('.portal-carousel-images');
671
672 // Beispielhafte konfiguration des Autoplay-Features
673 if (carousel && carousel.length > 0) {
674 carousel.slick('slickSetOption', 'speed', 1000)
675 carousel.slick('slickSetOption', 'autoplaySpeed', 5000);
676 carousel.slick('slickPlay');
677 }
678 {{/code}}
679
680 (% class="wikigeneratedid" id="HSelektioneinesbestimmtenGewinnspiels:" %)
681 Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:
682
683 {{code language="none"}}
684 // Innerhalb des Kontextes
685 Portal.goToContest(<uuid>);
686
687 // Innerhalb des Formulares
688 // - falls dies in der selben Domaine betrieben wird
689 window.parent.Portal.goToContest(<uuid>);
690
691 // - falls dies nicht in der selben Domaine betrieben wird
692 var data = {
693 msg: 'goToContest',
694 uuid: <uuid>
695 };
696 window.parent.postMessage(data, '*')
697
698 // Allgemein ansprechbar über postMessage:
699 var data = {
700 msg: "goToContest",
701 uuid: <uuid>
702 };
703 <window>.postMessage(data , '*')
704 {{/code}}
705
706 === Microsite-spezifisch ===
707
708 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.
709
710 == Einbinden als Microsite ==
711
712 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:
713
714 ==== Resizing der IFrame anhand ihres Inhaltes ====
715
716 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:
717
718 {{code language="none"}}
719 iFrameResize({log: false}, '<CSS-Selektor der iframe>');
720 {{/code}}
721
722 ==== Scrolling zu gewünschten Stellen auf der Microsite ====
723
724 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:
725
726 {{code language="none"}}
727 // Behandelt Messages der Microsite
728 function _handleMessage(event){
729
730 // Prüfung ob es sich um eine Scroll-Message handelt
731 if(event.data.scrollTarget || event.data.scrollOffset){
732
733 // Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich.
734 var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top;
735
736 // Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame
737 $('html, body').animate({
738 scrollTop : event.data.scrollOffset + frameOffset
739 }, 'slow');
740
741 // Weiterleitung aller weiteren postMessages an die Microsite
742 }else{
743 $('<CSS-Selektor der iFrame>').each(function(){
744 var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView;
745 iframewindow.postMessage(event.data,"*");
746 });
747 }
748 }
749
750 // Registireren der Message-Behandlung
751 if (window.addEventListener) {
752 window.addEventListener('message', _handleMessage, false);
753 } else if (window.attachEvent) { // ie8
754 window.attachEvent('onmessage', _handleMessage);
755 }
756
757 {{/code}}
758
759 " 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!
760
761 {{info}}
762 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!
763 {{/info}}
764
765 == Versionshistorie ==
766
767 === 1.6.0 ===
768
769 * Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien
770 * Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit
771
772 === 1.5.0 ===
773
774 * Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
775 * JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
776
777 === 1.4.0 ===
778
779 * Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
780 * Erweiterung der scrollTo-Funktionen
781 * Kleinere CSS-Anpassungen
782
783 === 1.3.4 ===
784
785 * CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
786
787 === 1.3.3 ===
788
789 * Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies
790 * Korrektur der Formular- und iFrameResizer-URL in der Vorschau
791
792 === 1.3.2 ===
793
794 * Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht
795
796 === 1.3.1 ===
797
798 * Über den Plugin-Parameter //portal.usebaseurl// kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.
799 * Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite
800
801 === 1.3.0 ===
802
803 * Fehlerbehebung beim Ausliefern über den Frontend-Server
804 * Einbau eines iFrame-Resizer für Microseiten
805 * Weitergabe von scroll-Nachrichten an top-window
806
807 === 1.2.4 ===
808
809 * Weiterleitung von postMessage an iframe innerhalb von Microsites
810
811 === 1.2.3 ===
812
813 * Durchreichen von URL-Parametern an IFames im Portal
814 * Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter
815
816 === 1.2.2 ===
817
818 * Undo/Redo-Funktionalität an Editoren aktiviert
819 * Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut
820 * Kleinere Anpassungen/Bugfixes
821
822 === 1.2.0 ===
823
824 * Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren
825 * Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints
826 * Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen
827
828 === 1.1.0 ===
829
830 * Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8
831
832 === 1.0.1 ===
833
834 * Anpassungen für FORMCYCLE Version 6.4.x

Navigation

Copyright 2000-2025