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

; 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

; Löschfristen verwalten {{version major="1" minor="7"}}{{/version}}

76

: Berechtigung, um Löschfristen zu erstellen, zu bearbeiten oder löschen zu dürfen.

77

78

==== Vorlagen verwalten ====

79

80

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.

81

82

==== Konfigurieren ====

83

84

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

85

86

=== Gewinnspiel-Portal öffnen ===

87

88

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

89

90

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

91

92

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

93

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

94

95

96

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:

102

103

; Gewinnspiele verwalten

104

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

105

106

; Vorlagen verwalten

107

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

108

109

; Konfiguration

110

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

111

112

=== Gewinnspiel öffnen ===

113

114

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

115

116

== Grundstruktur des Gewinnspiel-Portals ==

117

118

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:

119

120

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

121

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

122

123

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

124

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

125

126

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

127

128

== Verwaltungsoberfläche im FORMCYCLE Backend ==

=== Gewinnspiele verwalten ===

133

134

135

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

136

137

138

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 kann entweder ein neues leeres Gewinnspiel angelegt, ein zuvor exportiertes Gewinnspiel wieder geladen oder eine Vorlage als Grundlage für das Gewinnspiel verwendet werden.

143

144

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

145

146

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

147

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

148

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

149

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

150

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

151

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

==== Metadaten ====

Mögliche Optionen zum Konfigurieren der Metadaten des Gewinnspiels.

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 die Metadaten des Gewinnspiels konfiguriert werden. Die folgenden Optionen können konfiguriert werden:

161

162

163

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

164

: Das Gewinnspiel kann über einen Link aufgerufen werden

165

166

; **Gewinnspiel im Portal anzeigen**

167

: 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

168

169

; **Name des Gewinnspiels**

170

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

171

172

; **UUID des Gewinnspiels**

173

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

174

175

; **Online von**

176

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

177

178

; **Online bis**

179

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

180

181

182

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:

187

:; **Öffnen**

188

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

189

:; **Vorschau**

190

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

191

:; **Vorschau als angekündigt**

192

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

193

:; **Vorschau als abgelaufen**

194

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

195

:; **Bereitstellen**

196

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

197

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

198

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

199

::; **Beschreibung des Gewinnspiels ausblenden**

200

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

201

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

202

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

203

::; **Zu verwendender Server**

204

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

205

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

206

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

207

:; **Bereitstellen als HTML Link**

208

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

209

:; **Bereitstellen als Inlineframe**

210

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

211

:; **Bereitstellen als Ajax/JavaScript**

212

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

Konfigurationsoberfläche zur Verwaltung der Löschfristen eines Gewinnspiels

218

219

220

; **Löschfristen des Gewinnspiels** {{version major="1" minor="7"}}{{/version}}

221

: Im Bereich der Metadaten befindet sich auf der rechten Seite eine Tabelle zur Verwaltung der Löschfristen eines Gewinnspiels. Diese Löschfristen fungieren zur Beschreibung des Vorgehens der automatisierten Löschung von Gewinnspielvorgängen im Postfach. Damit die Löschfristen aller Gewinnspiele angewandt werden können, muss vorher in den [[Properties>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] des Plugins der Quartz-Job konfiguriert werden (Siehe [[Konfiguration des Quartz-Jobs>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="config_quartz"]]) . Eine Löschfrist kann konfiguriert werden, wenn die Berechtigung zur Verwaltung der Löschfristen aktiviert ist. Jede Löschfrist besitzt drei Eigenschaften: den Löschtyp, den Löschstatus und die Tage bis zur Löschung.

222

:: **Löschtyp**

223

::; **nach Ende des Gewinnspiels**

224

::: Eine Löschfrist dieses Typs wird erst angewandt, wenn das konfigurierte Ende des Gewinnspiels eingetreten ist und die eingestellten Tage bis zur Löschung vergangen sind.

225

::; **nach Formulareingang**

226

::: Eine Löschfrist dieses Typs wird erst angewandt, wenn die eingestellten Tage der Löschfrist nach Eingang des Vorgangs in das Postfach vergangen sind.

227

:; **Löschstatus**

228

:: Der Löschstatus gibt an, in welchem Status sich ein Vorgang im Postfach befinden muss, um gelöscht zu werden. Falls die Option //beliebiger Status// ausgewählt ist, werden alle Vorgänge des Gewinnspiels in der eingestellten Frist gelöscht, unabhängig vom Status eines Vorgangs.

229

:; **Tage bis zur Löschung**

230

:: Tage die es benötigt in Abhängigkeit zum Löschtyp bis Ausführung der Löschfrist.

231

232

: Durch den Knopf //+ Löschfrist hinzufügen// kann eine neue Löschfrist konfiguriert werden, welche gespeichert wird durch das Drücken auf den Knopf zum Speichern des Gewinnspiels. Jede Löschfrist besitzt am Ende den {{ficon name="trash-alt2"/}}-Knopf, wodurch die Löschfrist nach Bestätigung endgültig entfernt wird. Sobald es zur Ausführung und Löschung von Vorgängen durch eine Löschfrist gekommen ist, wird dies als [[System-Protokolleintrag>>doc:Formcycle.UserInterface.Protocol]] dokumentiert.

==== Inhalt ====

Mögliche Optionen zur Anpassung der Inhalte eines Gewinnspiels

; **Layout**

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

242

:; **Formular links**

243

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

244

:; **Formular rechts**

245

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

246

:; **Formular oben**

247

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

248

:; **Formular unten**

249

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

250

:; **ohne Beschreibung**

251

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

252

253

254

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:

259

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

260

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

261

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

262

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

263

264

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

265

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

266

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

267

:; **+ Bannergrafik ändern**

268

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

269

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

270

:: Löschen der Grafik

271

272

273

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.

278

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

279

:; **Beschreibung**

280

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

281

:; **Teilnahmebedingungen**

282

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

283

:; **Datenschutz**

284

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

285

:; **Ankündigung**

286

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

287

:; **Abgelaufen**

288

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

289

:; **CSS (Microsite)**

290

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

291

:; **JavaScript (Microsite)**

292

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

293

:; **HTML header (Microsite)**

294

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

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

299

300

; **Formular bearbeiten**

301

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

302

303

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

304

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

305

306

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

307

: Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar, sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist sowie bereits eine Gewinnerziehung stattgefunden hat. Er öffnet den Dialog zur Konfiguration und zum Starten der Nachziehung von Gewinnern.

308

309

; **Teilnehmer exportieren** {{version major="1" minor="5"}}{{/version}}

310

: Diese Schaltfläche ist bei entsprechender Berechtigung nur verfügbar, wenn zum ausgewählten Gewinnspiel eine projektspezifische Postfachansicht definiert wurde. Beim Betätigen dieser Schaltfläche wird ein EXCEL-Export angestoßen, welcher die dort definierten Formularfelder inkl. aller Metadaten-Felder exportiert. Je nach Anzahl der Teilnehmer kann dieser Export mehrere Sekunden lang dauern.

311

312

; **Gewinne verwalten** {{version major="1" minor="6"}}{{/version}}

313

: Diese Schaltfläche ist erst bei entsprechender Berechtigung verfügbar. Sie öffnet den Dialog zur Verwaltung der Gewinne des ausgewählten Gewinnspiels.

314

315

; **Speichern**

316

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

317

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

318

319

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

320

321

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

322

323

324

Dialog zu Konfiguration der Gewinnerziehung.

325

326

327

==== Konfiguration ====

328

329

Startet man über die entsprechenden Schaltflächen die Ermittlung der Gewinner eines Gewinnspiels, so öffnet sich hierbei ein Konfigurationdialog. In diesem wird angegeben, aus welchem Status die Teilnehmer-Datensätze herangezogen werden, sowie die Anzahl der eigentlichen Gewinner in ihren Ausprägungen. Hierbei wird unterschieden zwischen Hauptgewinnern, Nebengewinnern und zusätzlichen Ersatzgewinnern. Die Datensätze, die für die jeweilige Ausprägung gezogen werden, werden anschließen je nach Auswahl mit oder ohne ausgeführter Statusverarbeitgung in den zugehörigen Zielstatus überführt.

330

331

332

Anzeige der ermittelten Gewinner

==== Auswertung ====

Nach der Ziehung wird eine Übersicht mit den ermittelten Gewinnern angezeigt. Hierbei werden je nach Verfügbarkeit Spalten der projektspezifischen Postfachansicht oder der Betreff inkl. von Standard-Spalten angezeigt. Ferner sind die Spalten über die zugehörige Auswahl anpassbar. Über die Schlatfläche "Export" steht zusätzlich diese Tabelle mit allen vorhandenen Spalten als Excel-Datei zur Verfügung. Ferner kann über "Export" > "... mit kompletten Datensätzen" das Excel auch um alle im Formular vorhandenen Eingabedaten erweitert werden.

338

339

340

==== Gewinner nachziehen ====

341

342

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.

343

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

=== Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===

350

351

352

Verwaltungsdialog für Gewinne

353

354

355

Unter dieser Schaltfläche öffnet sich ein Dialogfenster, in dem vorhandene Gewinne eines Gewinnspiels verwaltet und neue Gewinne angelegt werden können, wenn die entsprechenden Berechtigungen aktiviert sind.

==== Menü ====

Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinne. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Zusätzlich besitzt jeder Gewinn einen eigenen Button zum Löschen {{ficon name="trash-alt2"/}} des Gewinns. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinn-Liste automatisch gefiltert wird.

360

361

==== Gewinndetails ====

362

363

Nachdem auf die Schaltfläche //Gewinn hinzufügen// geklickt oder ein Gewinn in der Liste ausgewählt wurde, erscheinen rechts die konfigurierbaren Gewinndetails. Die folgenden Optionen können konfiguriert werden oder werden als Information angezeigt:

364

365

; **UUID des Gewinns**

366

: Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.

367

368

; **Gewinnname**

369

: Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.

370

371

; **Kategorie**

372

: Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion //Gewinn ermitteln// genutzt für eine möglichen Limitierung der Gewinnziehung auf eine Kategorie.

373

374

; **Gewinncode**

375

: Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen.

376

377

; **Gewinn-Link**

378

: Benutzerdefinierter Link für den Gewinn, um bspw. eine URL als Link in das Gewinnbild einzubinden.

379

380

; **UUID des Gewinner-Vorgangs**

381

: Falls ein Gewinn über die Plugin-Aktion //Gewinn ermitteln// ausgewählt wurde, wird die eindeutige UUID des Gewinner-Vorgangs in den Gewinndetails angezeigt, um diesen identifizieren zu können. Bei Existenz dieser UUID in den Gewinndetails kann über den Button //Verknüpfung aufheben// bei vorhandenen Berechtigungen die Verknüpfung zwischen dem Gewinner-Vorgang und dem ausgewählten Gewinn aufgehoben werden.

382

383

; **Gewinnbeschreibung**

384

: An dieser Stelle wird die Beschreibung des Gewinns über einen WYSIWYG-Editor konfiguriert. Durch einen Klick auf Quellcode kann in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden.

385

386

; **Gewinnbild**

387

: Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:

388

:; **Über eine Bild-Ressource**

389

:: Für diese Möglichkeit kann bei bestehender Berechtigung durch den Button //+ Gewinnbild hochladen// über einen Dateiauswahldialog eine lokal gespeicherte Grafik selektiert werden. Nach dem Bestätigen der Auswahl wird die Bilddatei hochgeladen und als Datei am Gewinnspiel-Formular gespeichert. Falls eine Bild-Datei mit dem identischen Dateinamen hochgeladen wird, erhält diese Bild-Datei eine Laufnummer. Durch das Auswahlmenü über dem Gewinnbild wird das hochgeladene Bild automatisch ausgewählt, wodurch ggf. auch eine bereits existierende Bild-Ressource selektiert werden kann.

390

:; **Über eine Bild-URL**

391

:: Die Bild-URL kann durch Eingabe oder Einfügen in das Auswahlfeld konfiguriert werden. Beim Ausklappen des Auswahlfeldes werden alle Bild-URLs angezeigt, die von Gewinnen im Gewinnspiel verwendet werden.

392

Des Weiteren dient das {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik, zum Löschen dieser Grafik bei bestehender Berechtigung.

393

394

; **Speichern**

395

: Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

400

401

; **+ Excel-Import**

402

: Import von Gewinnen aus Excel-Datei.

403

404

; **Schließen**

405

: Schließen des Dialogfensters.

406

407

408

Dialog zur Konfiguration des Excel-Imports

409

410

411

==== Excel-Import von Gewinnen ====

412

413

Auf der linken Seite der Fußzeile im Verwaltungsdialog der Gewinne befindet sich die Schaltfläche //+ Excel Import//. Nach dem Klicken auf die Schaltfläche öffnet sich ein Dateiauswahldialog, über den eine bereits bestehende lokale Excel-Datei selektiert werden kann. Die Excel-Datei muss weder vom Dateityp //.xls// oder //.xlsx// sein.

414

415

Falls es sich bei der ausgewählten Datei um eine Excel-Datei handelt, öffnet sich ein Dialog zur Konfiguration des Imports der Gewinne aus der Excel-Datei. Hierbei kann zuerst das Excel-Blatt ausgewählt werden, in welchem sich die Gewinne in der Excel-Datei befinden. Über das Ankreuzfeld //Erste Zeile ignorieren// kann bei ggf. bestehenden Spaltenbeschriftungen der Gewinne die erste Zeile des Excel-Blatts ignoriert werden.

416

Über die fünf Eingabefelder können die zugehörigen Spaltennummern der Exceltabelle angegeben werden. Jedes Gewinnattribut (Name, Kategorie, Gewinncode, Gewinn-Link, Beschreibung, Bild-URL) wird genau einer Spalte in der Exceltabelle zugeordnet. Nach dem Drücken auf den Button //Importieren// werden die Gewinne erstellt auf Grundlage der Exceltabelle und sind danach im Verwaltungsdialog der Gewinne zu sehen.

417

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

=== Vorlagen verwalten ===

423

424

425

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

426

427

428

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.

433

434

==== Einstellungen ====

435

436

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:

437

438

; **Name der Vorlage:**

439

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

440

441

; **Layout:**

442

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

443

:; **Formular links**

444

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

445

:; **Formular rechts**

446

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

447

:; **Formular oben**

448

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

449

:; **Formular unten**

450

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

451

:; **ohne Beschreibung**

452

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

453

454

; **Microsite**

455

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

456

:; **Vorschau**

457

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

458

:; **Vorschau als angekündigt**

459

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

460

:; **Vorschau als abgelaufen**

461

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

462

463

464

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.

469

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

470

:; **Beschreibung**

471

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

472

:; **Teilnahmebedingungen**

473

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

474

:; **Datenschutz**

475

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

476

:; **Ankündigung**

477

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

478

:; **Abgelaufen**

479

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

480

:; **CSS (Microsite)**

481

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

482

:; **JavaScript (Microsite)**

483

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

484

:; **HTML header (Microsite)**

485

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

486

487

488

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:

493

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

494

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

495

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

496

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

497

498

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

499

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

500

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

501

:; **+ Bannergrafik ändern**

502

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

503

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

504

:: Löschen der Grafik

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

509

510

; **Formular bearbeiten**

511

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

512

513

; **Speichern**

514

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

515

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

516

517

=== Konfiguration ===

518

519

520

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

521

522

523

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:

524

525

; Kopfbereich

526

: Über dem Formular angezeigter Inhalt.

527

528

; Trenner

529

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

530

531

; Fußbereich

532

: Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.

533

534

; Abgelaufen-Overlay

535

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

536

537

; CSS (Portal)

538

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

539

540

; JavaScript (Portal)

541

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

542

543

; HTML header (Portal)

544

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

545

546

== Speicherort der Inhalte des Gewinnspiel-Portals ==

547

548

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

549

550

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

551

552

|=Dateiname|=Inhalt

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

== Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} ==

565

566

567

Konfiguration der Cron-Expression Property und Beschreibung des Quartz-Jobs

568

569

570

Das automatisierte Löschen und die damit verbundene Überprüfung der [[Löschfristen>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="deletions"]] aller Gewinnspiele wird durch einen Quartz-Job ermöglicht, welcher eine Cron-Expression benötigt, die angibt, wann dieser Job ausgeführt wird. Standardmäßig ist kein Quartz-Job mit Cron-Expression hinterlegt.

571

572

; portal.contestent.deletion.cron

573

: Über die Plugin-Property //portal.contestent.deletion.cron// kann eine Cron-Expression angegeben werden, damit ein Job mit dieser Cron-Expression angelegt wird. Um die Erstellung einer Cron-Expression zu erleichtern kann beispielsweise das Online-Tool CronMaker verwendet werden: [[cronmaker.com>>url:http://cronmaker.com]]. In der Beschreibung des Portalplugins wird nach Speicherung der Plugin-Property noch einmal erfasst, ob der Quartz-Job angelegt werden konnte bzw. ob die Cron-Expression damit valide ist und wann der Job als Nächstes ausgeführt wird.

574

575

== Plugin-Aktion: Gewinn ermitteln {{version major="1" minor="6"}}{{/version}} ==

576

577

578

Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln//

579

580

581

Die Plugin-Aktion //Gewinn ermitteln// ermöglicht es, durch Eingabe eines Gewinncodes im Gewinnspiel-Formular oder durch eine konfigurierbare Wahrscheinlichkeit, Gewinne für eingegangene Vorgänge zu ermitteln.

=== Parameter ===

==== Ziehmodus ====

; **Gewinncode**

: Beim Zieh-Modus Gewinncode muss über das Gewinnspiel-Formular ein Gewinncode eingegeben werden, wobei bei Übereinstimmung mit dem Gewinncode eines bestehenden Gewinns des Gewinnspiels dies am Gewinn vermerkt wird. Hierfür muss über das Textfeld //Gewinncodefeld// das zugehörige Eingabetextfeldelement des Formulars für den Gewinncode angegeben werden.

589

590

; **Gewinnchance**

591

: Durch den Zieh-Modus //Gewinnchance// kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü //Limitieren auf Kategorie//.

592

Die konfigurierbare Wahrscheinlichkeit wird über das Textfeld //Gewinnchance 1 zu// angegeben. Hierbei wird z.B. bei Eingabe einer 100 die Gewinnchance 1 zu 100 genutzt.

593

Falls ein Gewinner über die Gewinnchance ermittelt wird, wird in der ausgewählten limitierten Kategorie ebenfalls ein zufälliger Gewinn aus der Gewinnkategorie ausgewählt.

594

595

=== Rückgabewert der Plugin-Aktion ===

596

597

Rückgabewert der Aktion sind die Attribute des möglichen Gewinns, welche über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables||anchor="HAktionsplatzhalter"]] ausgelesen werden können. So können sie zum Beispiel in [[HTML-Templates>>Formcycle.UserInterface.FilesAndTemplates.HTML]] im Gewinnspiel-Portal angezeigt werden. Ein weiterer Anwendungsfall wäre die Verwendung als [[Abarbeitungsbedingung>>doc:Formcycle.Designer.Workflow.LegacyWorkflow.ActionConditions]] einer Aktion vom Typ [[Statusänderung>>doc:Formcycle.Designer.Workflow.LegacyWorkflow.Actions.ChangeState]] bei Erfolg der Aktion //Gewinn ermitteln//. Hier könnte im geänderten Status nun über eine Aktion vom Typ [[Abschlussseite>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ResponsePage]] ein bestimmtes HTML-Template angezeigt werden.

598

599

**Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:**

600

601

|=Rückgabewert|=Beschreibung

602

|[%$Aktionsname.SUCCESS%]|Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein

603

|[%$Aktionsname.RESULT[0].uuid%]|Eindeutige UUID des erhaltenen Gewinns

604

|[%$Aktionsname.RESULT[0].description%]|Beschreibung des erhaltenen Gewinns

605

|[%$Aktionsname.RESULT[0].category%]|Kategorie des erhaltenen Gewinns

606

|[%$Aktionsname.RESULT[0].process%]|Eindeutige UUID des Gewinner-Vorgangs

607

|[%$Aktionsname.RESULT[0].picture%]|Bild-URL des erhaltenen Gewinns

608

|[%$Aktionsname.RESULT[0].link%]|Gewinn-Link des erhaltenen Gewinns

609

610

== JavaScript-Schnittstellen ==

=== Allgemein ===

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

615

616

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

617

618

619

// Innerhalb des Kontextes

620

Contest.scrollToTop();

621

622

// Innerhalb des Formulares

623

// - falls dies in der selben Domaine betrieben wird

624

window.parent.Contest.scrollToTop();

625

626

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

627

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

628

629

// Allgemein ansprechbar über postMessage:

630

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

631

632

633

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

634

635

636

// Innerhalb des Kontextes

637

Contest.scrollToTerms();

638

639

// Innerhalb des Formulares

640

// - falls dies in der selben Domaine betrieben wird

641

window.parent.Contest.scrollToTerms();

642

643

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

644

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

645

646

// Allgemein ansprechbar über postMessage:

647

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

648

649

650

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

651

652

653

// Innerhalb des Kontextes

654

Contest.scrollToPrivacy();

655

656

// Innerhalb des Formulares

657

// - falls dies in der selben Domaine betrieben wird

658

window.parent.Contest.scrollToPrivacy();

659

660

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

661

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

662

663

// Allgemein ansprechbar über postMessage:

664

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

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

669

670

671

// Innerhalb des Kontextes

672

Contest.scrollToForm();

673

674

// Innerhalb des Formulares

675

// - falls dies in der selben Domaine betrieben wird

676

window.parent.Contest.scrollToForm();

677

678

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

679

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

680

681

// Allgemein ansprechbar über postMessage:

682

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

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

687

688

689

// Innerhalb des Kontextes

690

Contest.scrollToContestTop();

691

692

// Innerhalb des Formulares

693

// - falls dies in der selben Domaine betrieben wird

694

window.parent.Contest.scrollToContestTop();

695

696

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

697

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

698

699

// Allgemein ansprechbar über postMessage:

700

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

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

705

706

707

// Innerhalb des Kontextes

708

Contest.scrollToContent();

709

710

// Innerhalb des Formulares

711

// - falls dies in der selben Domaine betrieben wird

712

window.parent.Contest.scrollToContent();

713

714

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

715

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

716

717

// Allgemein ansprechbar über postMessage:

718

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

==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====

723

724

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.

725

726

727

// Liefert standardmäßig 0 zurück

728

Contest.calcScrollOffset();

729

730

// Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).

731

Contest.calcScrollOffset = function(){

732

if(window.matchMedia('(min-width: 960px)').matches){

return 0;

}else{

return -60;

}

}

=== Portal-spezifisch ===

742

743

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:

744

745

746

// Abholen des entsprechenden Carousel-Objekts

747

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

748

749

// Beispielhafte konfiguration des Autoplay-Features

750

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

751

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

752

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

753

carousel.slick('slickPlay');

}

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

758

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

759

760

761

// Innerhalb des Kontextes

762

Portal.goToContest(<uuid>);

763

764

// Innerhalb des Formulares

765

// - falls dies in der selben Domaine betrieben wird

766

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

767

768

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

var data = {

msg: 'goToContest',

uuid: <uuid>

};

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

774

775

// Allgemein ansprechbar über postMessage:

var data = {

msg: "goToContest",

uuid: <uuid>

};

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

781

782

783

=== Microsite-spezifisch ===

784

785

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.

786

787

== Einbinden als Microsite ==

788

789

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:

790

791

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

792

793

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:

794

795

796

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

797

798

799

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

800

801

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:

802

803

804

// Behandelt Messages der Microsite

805

function _handleMessage(event){

806

807

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

808

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

809

810

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

811

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

812

813

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

814

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

815

scrollTop : event.data.scrollOffset + frameOffset

816

}, 'slow');

817

818

// Weiterleitung aller weiteren postMessages an die Microsite

819

}else{

820

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

821

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

822

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

});

}

}

// Registireren der Message-Behandlung

828

if (window.addEventListener) {

829

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

830

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

831

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!

838

839

840

== Versionshistorie ==

=== 1.7.0 ===

* Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen

=== 1.6.0 ===

* Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien

849

* Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit

=== 1.5.0 ===

* Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht

854

* JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets

=== 1.4.0 ===

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

859

* Erweiterung der scrollTo-Funktionen

860

* Kleinere CSS-Anpassungen

=== 1.3.4 ===

* CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen

=== 1.3.3 ===

* Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies

869

* Korrektur der Formular- und iFrameResizer-URL in der Vorschau

=== 1.3.2 ===

* Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht

=== 1.3.1 ===

* Über den Plugin-Parameter //portal.usebaseurl// kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.

878

* Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite

=== 1.3.0 ===

* Fehlerbehebung beim Ausliefern über den Frontend-Server

883

* Einbau eines iFrame-Resizer für Microseiten

884

* Weitergabe von scroll-Nachrichten an top-window

=== 1.2.4 ===

* Weiterleitung von postMessage an iframe innerhalb von Microsites

=== 1.2.3 ===

* Durchreichen von URL-Parametern an IFames im Portal

893

* Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter

=== 1.2.2 ===

* Undo/Redo-Funktionalität an Editoren aktiviert

898

* Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut

899

* Kleinere Anpassungen/Bugfixes

=== 1.2.0 ===

* Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren

904

* Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints

905

* Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen

=== 1.1.0 ===

* Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8

=== 1.0.1 ===

* Anpassungen für FORMCYCLE Version 6.4.x

Wiki-Quellcode von Gewinnspiel-Portal-Plugin