Gewinnspiel-Portal-Plugin - FORMCYCLE Wiki

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

{{version major="6" minor="5"}}{{/version}}Für das Gewinnspiel-Portal-Plugin wird mindestend {{formcycle/}} in der Version 6.5.0 benötigt

Beispiel für ein mit dem Plugin erstelltes Gewinnspiel-Portal.

11

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.

== Installation ==

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.

== Rollenrechte ==

Nach der Installation des Plugins zusätzlich konfigurierbare [[Rollenrechte>>doc:Formcycle.UserInterface.UserSettings.Roles]] in der Benuterverwaltung.

23

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

; Ersatzgewinner ermitteln {{version major="1" minor="4"}}{{/version}}

58

: Ermöglicht es wiederholt Ersatzgewinner zu ermitteln.

59

60

==== Vorlagen verwalten ====

61

62

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.

63

64

==== Konfigurieren ====

65

66

Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen

67

68

=== Gewinnspiel-Portal öffnen ===

69

70

Berechtigung, das Gewinnspiel-Portal aus {{formcycle/}} heraus direkt öffnen zu dürfen

71

72

== Menüpunkte auf der Verwaltungsoberfläche ==

73

74

{{figure image="portal_menue_elemente_de.png" clear="h2" width="150"}}

75

Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.

<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>

Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:

=== Gewinnspiele ===

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:

90

91

; Gewinnspiele verwalten

92

: 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"]].

93

94

; Vorlagen verwalten

95

: 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"]].

96

97

; Konfiguration

98

: 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"]].

99

100

=== Gewinnspiel öffnen ===

101

102

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//.

103

104

== Grundstruktur des Gewinnspiel-Portals ==

105

106

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:

107

108

; (1) Kopfbereich, (7) Fußbereich und (4) Trenner vom Portal

109

: Diese Elemente werden einmal konfiguriert und werden für alle Gewinnspiele im Gewinnspiel-Portal genutzt.

110

111

; (2) Bannergrafik, (3) Inhalt (Formular, Beschreibung, ggf. Ankündigungen oder Mitteilungen über den Beginn oder das Ende des Gewinnspiels), (5) Teilnahmebedingungen und (6) Datenschutz

112

: Diese Elemente können für jedes Gewinnspiel individuell konfiguriert werden.

113

114

{{lightbox image="portal_aufbau_de.jpg" group="g0" width="800"/}}

115

116

== Verwaltungsoberfläche im FORMCYCLE Backend ==

=== Gewinnspiele verwalten ===

121

122

123

Verwaltungsoberfläche für den Menüpunkt //Gewinnspiele verwalten//

124

125

126

Unter diesem Menüpunkt können die vorhandenen Gewinnspiele verwaltet und neue Gewinnspiele angelegt werden.

==== Menü ====

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.

131

132

Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:

133

134

; {{ficon name="checkbox-marked-circle"/}}

135

: Ein ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist und sich aktuell innerhalb des konfigurierten Online-Zeitraumes befindet

136

; {{ficon name="checkbox-marked-circle-outline"/}}

137

: 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.

138

; {{ficon name="circle-outline"/}}

139

: Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist

140

141

==== Einstellungen ====

142

143

144

Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes

<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>

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:

154

155

156

; **Aktiviert (Das Gewinnspiel ist aufrufbar)**

157

: Das Gewinnspiel kann über einen Link aufgerufen werden

158

159

; **Gewinnspiel im Portal anzeigen**

160

: 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

161

162

; **Name des Gewinnspiels:**

163

: Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.

164

165

; **UUID des Gewinnspiels:**

166

: Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.

167

168

; **Online von:**

169

: 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.

170

171

; **Online bis:**

172

: 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.

173

174

; **Layout:**

175

: 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:

176

:; **Formular links**

177

:: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt

178

:; **Formular rechts**

179

:: Der //Beschreibungstext// wird links neben dem Formular angezeigt

180

:; **Formular oben**

181

:: Der //Beschreibungstext// wird unter dem Formular angezeigt

182

:; **Formular unten**

183

:: Der //Beschreibungstext// wird über dem Formular angezeigt

184

:; **ohne Beschreibung**

185

:: Es wird nur das Formular und kein //Beschreibungstext// angezeigt

186

187

188

Mögliche Optionen zum Öffnen des Gewinnspiels bzw. zum Generieren von Code zum Einbetten des Gewinnspiels im Punkt //Microsite//

; **Microsite**

: 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:

193

:; **Öffnen**

194

:: Ö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.

195

:; **Vorschau**

196

:: 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:

197

:; **Vorschau als angekündigt**

198

:: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.

199

:; **Vorschau als abgelaufen**

200

:: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.

201

:; **Bereitstellen**

202

:: Ö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:

203

::; **Kopfbereich des Gewinnspiels ausblenden (Bilder)**

204

::: Wenn diese Option gewählt wird, wird die Bannergrafik nicht angezeigt.

205

::; **Beschreibung des Gewinnspiels ausblenden**

206

::: Wenn diese Option gewählt wird, wird die Beschreibung des Gewinnspiels nicht angezeigt, unabhängig davon, was unter //Layout// konfiguriert wurde.

207

::; **Fußbereich des Gewinnspiels ausblenden (Datenschutz & Teilnahmebedingungen)**

208

::: Wenn diese Option gewählt wird, werden die für das Gewinnspiel konfigurierten Inhalte für //Datenschutz// und //Teilnahmebedingungen// nicht angezeigt.

209

::; **Zu verwendender Server**

210

::: Auswahl, über welchen Server das Gewinnspiel geöffnet werden soll. Zur Auswahl stehen Master- und eventuell vorhande Frontend-Server.

211

:: 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.

212

:: 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:

213

:; **Bereitstellen als HTML Link**

214

:: Generiert Quellcode, mit dem das Gewinnspiel direkt als HTML-Code in eine Webseite eingebunden werden kann.

215

:; **Bereitstellen als Inlineframe**

216

:: Generiert Quellcode, mit dem das Gewinnspiel als Inlineframe in eine Webseite eingebunden werden kann.

217

:; **Bereitstellen als Ajax/JavaScript**

218

:: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.

219

220

221

Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.

; **Inhalt**

: 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.

226

: Folgende Inhalte können an dieser Stelle konfiguriert werden:

227

:; **Beschreibung**

228

:: Beschreibungstext zum Gewinnspiel. Wird neben bzw. über oder unter dem Formular angezeigt.

229

:; **Teilnahmebedingungen**

230

:: Teilnahmebedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.

231

:; **Datenschutz**

232

:: Datenschutzbedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.

233

:; **Ankündigung**

234

:: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.

235

:; **Abgelaufen**

236

:: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.

237

:; **CSS (Microsite)**

238

:: Zusätzlicher CSS-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.

239

:; **JavaScript (Microsite)**

240

:: Zusätzlicher JavaScript-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.

241

:; **HTML header (Microsite)**

242

:: 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.

243

244

245

Vorhandene Schaltflächen unter //Bannergrafiken//.

; Bannergrafiken

: 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:

250

:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden

251

:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite

252

:: **Mobile** - bei 641 px oder weniger Bildschirmbreite

253

: 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.

254

255

: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:

256

:; **Desktop**, **Tablet** und **Mobile**

257

:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden

258

:; **+ Bannergrafik ändern**

259

:: Ö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.

260

:; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik

261

:: Löschen der Grafik

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

266

267

; **Formular bearbeiten**

268

: Ö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.

269

270

; **Gewinner ermitteln** {{version major="1" minor="4"}}{{/version}}

271

: 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.

272

273

; **Ersatzgewinner ermitteln** {{version major="1" minor="4"}}{{/version}}

274

: 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.

275

276

; **Speichern**

277

: Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.

278

\\\\{{id name="backend_vorlagen"/}}

279

280

=== Gewinner ermitteln {{version major="1" minor="4"}}{{/version}} ===

281

282

Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.

283

284

285

Dialog zu Konfiguration der Gewinnerziehung.

286

287

288

==== Konfiguration ====

289

290

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.

291

292

293

Anzeige der ermittelten Gewinner

==== Asuwertung ====

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.

299

300

301

==== Gewinner nachziehen ====

302

303

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.

304

305

306

=== Vorlagen verwalten ===

307

308

309

Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.

310

311

312

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.

==== Menü ====

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.

317

318

==== Einstellungen ====

319

320

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:

321

322

; **Name der Vorlage:**

323

: Innerhalb von {{formcycle/}} angezeigter Name der Vorlage.

324

325

; **Layout:**

326

: 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:

327

:; **Formular links**

328

:: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt

329

:; **Formular rechts**

330

:: Der //Beschreibungstext// wird links neben dem Formular angezeigt

331

:; **Formular oben**

332

:: Der //Beschreibungstext// wird unter dem Formular angezeigt

333

:; **Formular unten**

334

:: Der //Beschreibungstext// wird über dem Formular angezeigt

335

:; **ohne Beschreibung**

336

:: Es wird nur das Formular und kein //Beschreibungstext// angezeigt

337

338

; **Microsite**

339

: 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:

340

:; **Vorschau**

341

:: 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:

342

:; **Vorschau als angekündigt**

343

:: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.

344

:; **Vorschau als abgelaufen**

345

:: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.

346

347

348

Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.

; **Inhalt**

: 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.

353

: Folgende Inhalte können an dieser Stelle konfiguriert werden:

354

:; **Beschreibung**

355

:: Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.

356

:; **Teilnahmebedingungen**

357

:: Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.

358

:; **Datenschutz**

359

:: Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.

360

:; **Ankündigung**

361

:: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.

362

:; **Abgelaufen**

363

:: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.

364

:; **CSS (Microsite)**

365

:: Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.

366

:; **JavaScript (Microsite)**

367

:: Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.

368

:; **HTML header (Microsite)**

369

:: 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.

370

371

372

Vorhandene Schaltflächen unter //Bannergrafiken//.

; Bannergrafiken

: 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:

377

:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden

378

:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite

379

:: **Mobile** - bei 641 px oder weniger Bildschirmbreite

380

: 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.

381

382

: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:

383

:; **Desktop**, **Tablet** und **Mobile**

384

:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden

385

:; **+ Bannergrafik ändern**

386

:: Ö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.

387

:; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik

388

:: Löschen der Grafik

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

393

394

; **Formular bearbeiten**

395

: Ö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.

396

397

; **Speichern**

398

: Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.

399

\\\\{{id name="backend_portal"/}}

400

401

=== Konfiguration ===

402

403

404

Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//.

405

406

407

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:

408

409

; Kopfbereich

410

: Über dem Formular angezeigter Inhalt.

411

412

; Trenner

413

: Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.

414

415

; Fußbereich

416

: Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.

417

418

; Abgelaufen-Overlay

419

: Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.

420

421

; CSS (Portal)

422

: Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.

423

424

; JavaScript (Portal)

425

: Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.

426

427

; HTML header (Portal)

428

: 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.

429

430

== Speicherort der Inhalte des Gewinnspiel-Portals ==

431

432

Die unter //Konfiguration// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].

433

434

**Es handelt sich um die folgenden Dateien:**

435

436

|=Dateiname|=Inhalt

437

|contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird

438

|contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite

439

|contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite

440

|contest-portal.js.txt|JavaScript der Gewinnspiel-Portalseite

441

|contest-portal.meta.html|HTML header der Gewinnspiel-Portalseite

442

|contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite

443

|contest-portal.title.html|Titel der Gewinnspiel-Portalseite

444

|expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist

445

446

== JavaScript-Schnittstellen ==

=== Allgemein ===

Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:

451

452

==== Scrollen zum Seitenanfang: ====

453

454

455

// Innerhalb des Kontextes

456

Contest.scrollToTop();

457

458

// Innerhalb des Formulares

459

// - falls dies in der selben Domaine betrieben wird

460

window.parent.Contest.scrollToTop();

461

462

// - falls dies nicht in der selben Domaine betrieben wird

463

window.parent.postMessage('scrollToTop', '*');

464

465

// Allgemein ansprechbar über postMessage:

466

<window>.postMessage('scrollToTop', '*');

467

468

469

==== Scrollen zu den Teilnahmebedingungen: ====

470

471

472

// Innerhalb des Kontextes

473

Contest.scrollToTerms();

474

475

// Innerhalb des Formulares

476

// - falls dies in der selben Domaine betrieben wird

477

window.parent.Contest.scrollToTerms();

478

479

// - falls dies nicht in der selben Domaine betrieben wird

480

window.parent.postMessage('scrollToTerms', '*');

481

482

// Allgemein ansprechbar über postMessage:

483

<window>.postMessage('scrollToTerms', '*');

484

485

486

==== Scrollen zur Datenschutz-Erklärung: ====

487

488

489

// Innerhalb des Kontextes

490

Contest.scrollToPrivacy();

491

492

// Innerhalb des Formulares

493

// - falls dies in der selben Domaine betrieben wird

494

window.parent.Contest.scrollToPrivacy();

495

496

// - falls dies nicht in der selben Domaine betrieben wird

497

window.parent.postMessage('scrollToPrivacy', '*');

498

499

// Allgemein ansprechbar über postMessage:

500

<window>.postMessage('scrollToPrivacy', '*');

==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====

505

506

507

// Innerhalb des Kontextes

508

Contest.scrollToForm();

509

510

// Innerhalb des Formulares

511

// - falls dies in der selben Domaine betrieben wird

512

window.parent.Contest.scrollToForm();

513

514

// - falls dies nicht in der selben Domaine betrieben wird

515

window.parent.postMessage('scrollToForm', '*');

516

517

// Allgemein ansprechbar über postMessage:

518

<window>.postMessage('scrollToForm', '*');

==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====

523

524

525

// Innerhalb des Kontextes

526

Contest.scrollToContestTop();

527

528

// Innerhalb des Formulares

529

// - falls dies in der selben Domaine betrieben wird

530

window.parent.Contest.scrollToContestTop();

531

532

// - falls dies nicht in der selben Domaine betrieben wird

533

window.parent.postMessage('scrollToContestTop', '*');

534

535

// Allgemein ansprechbar über postMessage:

536

<window>.postMessage('scrollToContestTop', '*');

==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====

541

542

543

// Innerhalb des Kontextes

544

Contest.scrollToContent();

545

546

// Innerhalb des Formulares

547

// - falls dies in der selben Domaine betrieben wird

548

window.parent.Contest.scrollToContent();

549

550

// - falls dies nicht in der selben Domaine betrieben wird

551

window.parent.postMessage('scrollToContent', '*');

552

553

// Allgemein ansprechbar über postMessage:

554

<window>.postMessage('scrollToContent', '*');

=== Portal-spezifisch ===

559

560

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:

561

562

563

// Abholen des entsprechenden Carousel-Objekts

564

var carousel = $('.portal-carousel-images');

565

566

// Beispielhafte konfiguration des Autoplay-Features

567

if (carousel && carousel.length > 0) {

568

carousel.slick('slickSetOption', 'speed', 1000)

569

carousel.slick('slickSetOption', 'autoplaySpeed', 5000);

570

carousel.slick('slickPlay');

}

(% class="wikigeneratedid" id="HSelektioneinesbestimmtenGewinnspiels:" %)

575

Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:

576

577

578

// Innerhalb des Kontextes

579

Portal.goToContest(<uuid>);

580

581

// Innerhalb des Formulares

582

// - falls dies in der selben Domaine betrieben wird

583

window.parent.Portal.goToContest(<uuid>);

584

585

// - falls dies nicht in der selben Domaine betrieben wird

var data = {

msg: 'goToContest',

uuid: <uuid>

};

window.parent.postMessage(data, '*')

591

592

// Allgemein ansprechbar über postMessage:

var data = {

msg: "goToContest",

uuid: <uuid>

};

<window>.postMessage(data , '*')

598

599

600

=== Microsite-spezifisch ===

601

602

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.

603

604

== Einbinden als Microsite ==

605

606

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:

607

608

==== Resizing der IFrame anhand ihres Inhaltes ====

609

610

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:

611

612

613

iFrameResize({log: false}, '<CSS-Selektor der iframe>');

614

615

616

==== Scrolling zu gewünschten Stellen auf der Microsite ====

617

618

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:

619

620

621

// Behandelt Messages der Microsite

622

function _handleMessage(event){

623

624

// Prüfung ob es sich um eine Scroll-Message handelt

625

if(event.data.scrollTarget || event.data.scrollOffset){

626

627

// Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich.

628

var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top;

629

630

// Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame

631

$('html, body').animate({

632

scrollTop : event.data.scrollOffset + frameOffset

633

}, 'slow');

634

635

// Weiterleitung aller weiteren postMessages an die Microsite

636

}else{

637

$('<CSS-Selektor der iFrame>').each(function(){

638

var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView;

639

iframewindow.postMessage(event.data,"*");

});

}

}

// Registireren der Message-Behandlung

645

if (window.addEventListener) {

646

window.addEventListener('message', _handleMessage, false);

647

} else if (window.attachEvent) { // ie8

648

window.attachEvent('onmessage', _handleMessage);

}

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!

655

656

657

== Versionshistorie ==

=== 1.4.0 ===

* Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export

662

* Erweiterung der scrollTo-Funktionen