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

; Gewinnspiel zurücksetzen {{version major="2"}}{{/version}}

79

: Berechtigung ein vorhandenes Gewinnspiel zurücksetzen zu dürfen.

80

81

==== Vorlagen verwalten ====

82

83

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.

84

85

==== Konfigurieren ====

86

87

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

88

89

; Verwalten der Standard-Einstellungen für Löschfristen {{version major="2"}}{{/version}}

90

: Berechtigung, um die Standardeinstellungen für Löschfristen von Gewinnspielen zu verwalten.

91

92

=== Gewinnspiel-Portal öffnen ===

93

94

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

95

96

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

97

98

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

99

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

100

101

102

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:

108

109

; Gewinnspiele verwalten

110

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

111

112

; Vorlagen verwalten

113

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

114

115

; Konfiguration

116

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

117

118

=== Gewinnspiel öffnen ===

119

120

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

121

122

== Grundstruktur des Gewinnspiel-Portals ==

123

124

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:

125

126

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

127

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

128

129

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

130

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

131

132

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

133

134

== Verwaltungsoberfläche im FORMCYCLE Backend ==

=== Gewinnspiele verwalten ===

139

140

141

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

142

143

144

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"/}}, gelöscht {{ficon name="trash-alt2"/}} oder zurückgesetzt {{icon name="fa-rotate-left" title="Zurücksetzen" size="1x" cssClass="fa-rotate-left"/}} {{version major="2"}}{{/version}} 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.

149

150

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

151

152

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

153

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

154

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

155

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

156

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

157

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

167

168

169

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

170

: Das Gewinnspiel kann über einen Link aufgerufen werden

171

172

; **Gewinnspiel im Portal anzeigen**

173

: 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

174

175

; **Name des Gewinnspiels**

176

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

177

178

; **UUID des Gewinnspiels**

179

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

180

181

; **Online von**

182

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

183

184

; **Online bis**

185

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

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.

Konfigurationsoberfläche zur Verwaltung der Löschfristen eines Gewinnspiels

224

225

226

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

227

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

228

:: **Löschtyp**

229

::; **nach Ende des Gewinnspiels**

230

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

231

::; **nach Formulareingang**

232

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

233

:; **Löschstatus**

234

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

235

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

236

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

237

238

: 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. Die Standardwerte für die Tage bis zur Löschung und der Löschtyp können in der Portal-Konfiguration verwaltet werden und werden bei der Erstellungen von Löschfristen angewandt. {{version major="2"}}{{/version}}

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

248

:; **Formular links**

249

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

250

:; **Formular rechts**

251

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

252

:; **Formular oben**

253

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

254

:; **Formular unten**

255

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

256

:; **ohne Beschreibung**

257

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

258

259

260

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:

265

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

266

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

267

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

268

269

: Ab Version {{version major="1" minor="8"}}{{/version}} wurden die Typen der Bannergrafiken überarbeitet und um die Pfelge von Grafiken für Fall eines Gewinns erweitert.

270

:: **Desktop (1280px)** - ab 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

271

:: **Tablet (960px)** - zwischen 960 px und 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

272

:: **Mobile (600px)** - zwischen 600 px und 960 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

273

:: **Mobile (320px)** - bei 600 px oder weniger Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

274

275

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

276

277

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

278

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

279

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

280

:; **+ Bannergrafik ändern**

281

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

282

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

283

:: Löschen der Grafik

284

285

286

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.

291

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

292

:; **Beschreibung**

293

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

294

:; **Teilnahmebedingungen**

295

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

296

:; **Datenschutz**

297

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

298

:; **Ankündigung**

299

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

300

:; **Abgelaufen**

301

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

302

:; **CSS (Microsite)**

303

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

304

:; **JavaScript (Microsite)**

305

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

306

:; **HTML header (Microsite)**

307

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

312

313

; **Formular bearbeiten**

314

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

315

316

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

317

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

318

319

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

320

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

321

322

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

323

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

324

325

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

326

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

327

328

; **Speichern**

329

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

330

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

331

332

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

333

334

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

335

336

337

Dialog zu Konfiguration der Gewinnerziehung.

338

339

340

==== Konfiguration ====

341

342

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.

343

344

345

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.

351

352

353

==== Gewinner nachziehen ====

354

355

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.

356

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

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

363

364

365

Verwaltungsdialog für Gewinne

366

367

368

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.

373

374

==== Gewinndetails ====

375

376

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:

377

378

; **UUID des Gewinns**

379

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

380

381

; **Gewinnname**

382

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

383

384

; **Kategorie**

385

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

386

387

; **Gruppe**

388

: Frei definierbare Gruppe eines Gewinns. Wird für das Ausspielen der Meta-Daten eines Preises innerhalb des Formulars benutzt. Ein Preis ohne Gruppe steht für die Visualisierung innerhalb des Formulars nicht zur Verfügung. Bei gleichen Gruppen-Namen werden ausschließlich die Daten des ersten Preises bereitgestellt.

389

:

390

; **Gewinncode**

391

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

392

393

; **Gewinn-Link**

394

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

395

396

; **UUID des Gewinner-Vorgangs**

397

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

398

399

; **Gewinnbeschreibung**

400

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

401

402

; **Gewinnbild**

403

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

404

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

405

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

406

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

407

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

408

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.

409

410

; **Speichern**

411

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

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

416

417

; **+ Excel-Import**

418

: Import von Gewinnen aus Excel-Datei.

419

420

; **Schließen**

421

: Schließen des Dialogfensters.

422

423

424

Dialog zur Konfiguration des Excel-Imports

425

426

427

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

428

429

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.

430

431

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.

432

Über die fünf Eingabefelder können die zugehörigen Spaltennummern der Exceltabelle angegeben werden. Jedes Gewinnattribut (Name, Kategorie, Gruppe, 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.

433

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

=== Vorlagen verwalten ===

439

440

441

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

442

443

444

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.

449

450

==== Einstellungen ====

451

452

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:

453

454

; **Name der Vorlage:**

455

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

456

457

; **Layout:**

458

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

459

:; **Formular links**

460

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

461

:; **Formular rechts**

462

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

463

:; **Formular oben**

464

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

465

:; **Formular unten**

466

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

467

:; **ohne Beschreibung**

468

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

469

470

; **Microsite**

471

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

472

:; **Vorschau**

473

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

474

:; **Vorschau als angekündigt**

475

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

476

:; **Vorschau als abgelaufen**

477

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

478

479

480

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.

485

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

486

:; **Beschreibung**

487

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

488

:; **Teilnahmebedingungen**

489

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

490

:; **Datenschutz**

491

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

492

:; **Ankündigung**

493

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

494

:; **Abgelaufen**

495

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

496

:; **CSS (Microsite)**

497

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

498

:; **JavaScript (Microsite)**

499

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

500

:; **HTML header (Microsite)**

501

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

502

503

504

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:

511

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

512

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

513

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

514

515

: Ab Version {{version major="1" minor="8"}}{{/version}} wurden die Typen der Bannergrafiken überarbeitet und um die Pfelge von Grafiken für Fall eines Gewinns erweitert.

516

:: **Desktop (1280px)** - ab 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

517

:: **Tablet (960px)** - zwischen 960 px und 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

518

:: **Mobile (600px)** - zwischen 600 px und 960 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

519

:: **Mobile (320px)** - bei 600 px oder weniger Bildschirmbreite {{version major="1" minor="8"}}{{/version}}

520

521

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

522

523

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

524

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

525

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

526

:; **+ Bannergrafik ändern**

527

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

528

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

529

:: Löschen der Grafik

==== Fußzeile ====

Hier befinden sich die folgenden zwei Schaltflächen:

534

535

; **Formular bearbeiten**

536

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

537

538

; **Speichern**

539

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

540

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

541

542

=== Konfiguration ===

543

544

545

Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//, um das Aussehen des Gewinnspiel-Portals anzupassen.

Verwaltungsoberfläche um die Standardeinstellungen für Löschfristen zu verwalten.

550

551

552

In diesem Menüpunkt kann das Aussehen des Gewinnspiel-Portals und die Standardeinstellungen für Löschfristen von Gewinnspielen {{version major="2"}}{{/version}} angepasst werden.

553

554

; Mandant-spezifische Portal-Konfiguration

555

: Die folgenden Reiter stehen für die Konfiguration des Portals zur Verfügung:

556

:; Kopfbereich

557

:: Über dem Formular angezeigter Inhalt.

558

:; Trenner

559

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

560

:; Fußbereich

561

:: Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.

562

:; Abgelaufen-Overlay

563

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

564

:; CSS (Portal)

565

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

566

:; JavaScript (Portal)

567

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

568

:; HTML header (Portal)

569

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

570

571

; Standard-Einstellungen für Löschfristen {{version major="2"}}{{/version}}

572

: Die folgenden Einstellungen können verwaltet werden:

573

:; Standardwert für Löschfristen in Tagen

574

:: Standardwert der bei der Erstellungen von neuen Löschfristen angewandt wird. In der Verwaltungsoberfläche der Gewinnspiele wird darauf hingewiesen, sobald die Anzahl der Tage unter diesem Standardwert ist.

575

:; Standardwert für Löschtyp

576

:: Standardwert des Löschtypen der bei der Erstellungen von neuen Löschfristen angewandt wird. Dabei kann zwischen den Typen // nach Formulareingang // und // nach Ende des Gewinnspiels // ausgewählt werden.

577

578

== Speicherort der Inhalte des Gewinnspiel-Portals ==

579

580

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

581

582

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

583

584

|=Dateiname|=Inhalt

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

597

598

599

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

600

601

602

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.

603

604

; portal.contestent.deletion.cron

605

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

606

607

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

608

609

610

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

611

612

613

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.

621

622

; **Gewinnchance**

623

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

624

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.

625

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.

626

627

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

628

629

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.Designer.Workflow.LegacyWorkflow.Actions.ResponsePage]] ein bestimmtes HTML-Template angezeigt werden.

630

631

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

632

633

|=Rückgabewert|=Beschreibung

634

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

635

|[%$Aktionsname.RESULT.name%]|Gewinn-Name des erhaltenen Gewinns

636

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

637

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

638

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

639

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

640

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

641

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

642

|[%$Aktionsname.RESULT.group%]|Gewinn-Gruppe des erhaltenen Gewinns

643

644

== JavaScript-Schnittstellen ==

=== Allgemein ===

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

649

650

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

651

652

653

// Innerhalb des Kontextes

654

Contest.scrollToTop();

655

656

// Innerhalb des Formulares

657

// - falls dies in der selben Domaine betrieben wird

658

window.parent.Contest.scrollToTop();

659

660

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

661

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

662

663

// Allgemein ansprechbar über postMessage:

664

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

665

666

667

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

668

669

670

// Innerhalb des Kontextes

671

Contest.scrollToTerms();

672

673

// Innerhalb des Formulares

674

// - falls dies in der selben Domaine betrieben wird

675

window.parent.Contest.scrollToTerms();

676

677

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

678

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

679

680

// Allgemein ansprechbar über postMessage:

681

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

682

683

684

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

685

686

687

// Innerhalb des Kontextes

688

Contest.scrollToPrivacy();

689

690

// Innerhalb des Formulares

691

// - falls dies in der selben Domaine betrieben wird

692

window.parent.Contest.scrollToPrivacy();

693

694

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

695

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

696

697

// Allgemein ansprechbar über postMessage:

698

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

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

703

704

705

// Innerhalb des Kontextes

706

Contest.scrollToForm();

707

708

// Innerhalb des Formulares

709

// - falls dies in der selben Domaine betrieben wird

710

window.parent.Contest.scrollToForm();

711

712

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

713

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

714

715

// Allgemein ansprechbar über postMessage:

716

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

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

721

722

723

// Innerhalb des Kontextes

724

Contest.scrollToContestTop();

725

726

// Innerhalb des Formulares

727

// - falls dies in der selben Domaine betrieben wird

728

window.parent.Contest.scrollToContestTop();

729

730

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

731

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

732

733

// Allgemein ansprechbar über postMessage:

734

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

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

739

740

741

// Innerhalb des Kontextes

742

Contest.scrollToContent();

743

744

// Innerhalb des Formulares

745

// - falls dies in der selben Domaine betrieben wird

746

window.parent.Contest.scrollToContent();

747

748

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

749

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

750

751

// Allgemein ansprechbar über postMessage:

752

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

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

757

758

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.

759

760

761

// Liefert standardmäßig 0 zurück

762

Contest.calcScrollOffset();

763

764

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

765

Contest.calcScrollOffset = function(){

766

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

return 0;

}else{

return -60;

}

}

==== (% id="cke_bm_1486S" style="display:none" %) (%%)Umschalten der Einzeige eines Gewinnspiels in den Gewonnen-Status: {{version major="1" minor="8"}}{{/version}} ====

775

776

Um im Falle eines Gewinns die Anzeige des Gewinnspiels abzuändern (z.B. Austausch der Banner-Grafik) ist die Funktion Contest.markAsWon() gedacht. Diese erwartet als Parameter die ID des Gewinnspiel-Projektes und das window in welchem das eigentliche Formular z.B. als IFrame ausgeliefert wird. Der Haupteinsatzort dieser Funktion ist das HTML-Template welches im Falle eines Gewinns ausgeliefert werden soll.

777

778

779

// Snippet für eine HTML-Abschlussseite welches die Anzeige des aktuellen Gewinnspiels in den Gewonnen-Status schaltet.

780

// Funktioniert für die Bereitstellung als Micro-Site und innerhalb des Portals.

781

if (window.parent && window.parent.Contest) {

782

window.parent.Contest.markAsWon([%$PROJECT_ID%], window);

}

=== Portal-spezifisch ===

787

788

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:

789

790

791

// Abholen des entsprechenden Carousel-Objekts

792

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

793

794

// Beispielhafte konfiguration des Autoplay-Features

795

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

796

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

797

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

798

carousel.slick('slickPlay');

}

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

803

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

804

805

806

// Innerhalb des Kontextes

807

Portal.goToContest(<uuid>);

808

809

// Innerhalb des Formulares

810

// - falls dies in der selben Domaine betrieben wird

811

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

812

813

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

var data = {

msg: 'goToContest',

uuid: <uuid>

};

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

819

820

// Allgemein ansprechbar über postMessage:

var data = {

msg: "goToContest",

uuid: <uuid>

};

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

826

827

828

=== Microsite-spezifisch ===

829

830

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.

831

832

== Einbinden als Microsite ==

833

834

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:

835

836

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

837

838

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:

839

840

841

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

842

843

844

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

845

846

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:

847

848

849

// Behandelt Messages der Microsite

850

function _handleMessage(event){

851

852

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

853

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

854

855

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

856

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

857

858

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

859

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

860

scrollTop : event.data.scrollOffset + frameOffset

861

}, 'slow');

862

863

// Weiterleitung aller weiteren postMessages an die Microsite

864

}else{

865

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

866

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

867

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

});

}

}

// Registireren der Message-Behandlung

873

if (window.addEventListener) {

874

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

875

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

876

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!

883

884

885

== Versionshistorie ==

=== 1.8.0 ===

* Funktionalität der Pflege Bannergrafiken um weitere responsive Stufe und spezielle Grafiken für den Fall des Gewinns erweitert

890

* JavaScript-Schnittstelle um die Banner-Grafik im Falle eines Gewinns umzuschalten hinzugefügt

=== 1.7.1 ===

* Funktionalität zum Bereitstellen der MetaDaten von Preisen für die Visualisierung innerhalb des Formulars (PreRender-Plugin)

895

* Preis-Gruppen für die Zusammenfassung der zu visualisierenden Preise

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

904

* 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

909

* JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets

=== 1.4.0 ===

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

914

* Erweiterung der scrollTo-Funktionen

915

* 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

924

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

933

* Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite

=== 1.3.0 ===

* Fehlerbehebung beim Ausliefern über den Frontend-Server

938

* Einbau eines iFrame-Resizer für Microseiten

939

* 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

948

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

=== 1.2.2 ===

* Undo/Redo-Funktionalität an Editoren aktiviert

953

* Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut

954

* Kleinere Anpassungen/Bugfixes

=== 1.2.0 ===

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

959

* Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints

960

* 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

Navigation