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

Navigation

Copyright 2000-2025