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

Navigation

Copyright 2000-2025