Änderungen von Dokument Gewinnspiel-Portal-Plugin


Von Version 1.1
bearbeitet von MKO
am 20.01.2021, 16:20
Änderungskommentar: Imported from XAR
Auf Version 7.1
bearbeitet von jdr
am 16.11.2021, 09:04
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.mko
1 +XWiki.jdr
Inhalt
... ... @@ -10,7 +10,7 @@
10 10  Beispiel für ein mit dem Plugin erstelltes Gewinnspiel-Portal.
11 11  {{/figure}}
12 12  
13 -Das 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.
13 +Das kostenpflichtige Gewinnspiel-Portal bietet die Möglichkeit, Portale für eine beliebige Anzahl an Gewinnspielen innerhalb von {{formcycle/}} zu erstellen und verwalten. Diese Gewinnspiele nutzen für die Dateneingabe der Teilnehmer {{formcycle/}} Formulare. Das Gewinnspiel-Portal kann auf allen Mandanten auf dem {{fcserver/}} genutzt werden, wobei auf jedem Mandanten ein eigenes Gewinnspiel-Portal eingerichtet werden kann.
14 14  
15 15  == Installation ==
16 16  
... ... @@ -51,6 +51,30 @@
51 51  ; Gewinnspiel-Formular bearbeiten
52 52  : Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
53 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 +
54 54  ==== Vorlagen verwalten ====
55 55  
56 56  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.
... ... @@ -69,12 +69,6 @@
69 69  Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.
70 70  {{/figure}}
71 71  
72 -
73 -{{html wiki="true"}}
74 -<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Zusätzliche Menüpunkte auf der Verwaltungsoberfläche.'><div class='xm-figure-inner' style='width:160px'>{{lightbox image='portal_menue_elemente_de.png' width='150' group='$height' group='$group' title='Zusätzliche Menüpunkte auf der Verwaltungsoberfläche.'/}}<div class='xm-figure-caption'>Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.</div></div></div>
75 -{{/html}}
76 -
77 -
78 78  Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
79 79  
80 80  
... ... @@ -113,7 +113,7 @@
113 113  
114 114  === Gewinnspiele verwalten ===
115 115  
116 -{{figure image="gewinnspiele_ui_de.png" clear="h2"}}
134 +{{figure image="contest_ui_de.png" clear="h2"}}
117 117  Verwaltungsoberfläche für den Menüpunkt //Gewinnspiele verwalten//
118 118  {{/figure}}
119 119  
... ... @@ -121,7 +121,7 @@
121 121  
122 122  ==== Menü ====
123 123  
124 -Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}}, exportiert {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}}, als Vorlage gespeichert {{icon name="fa-save" title="Als Vorlage speichern" size="1x" cssClass="fa-save"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinnspiel-Liste automatisch gefiltert wird. Beim Anlegen eines neuen Gewinnspiels kan entweder ein neues leeres Gewinnspiel angelegt, ein zuvor exportiertes Gewinnspiel wieder geladen oder eine Vorlage als Grundlage für das Gewinnspiel verwendet werden.
142 +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.
125 125  
126 126  Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
127 127  
... ... @@ -132,21 +132,16 @@
132 132  ; {{ficon name="circle-outline"/}}
133 133  : Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
134 134  
135 -==== Einstellungen ====
153 +==== Metadaten ====
136 136  
137 -{{figure image="gs_onlineeinstellungen_de.png" clear="h2"}}
138 -Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes
155 +{{figure image="contest_meta_data_de.png" clear="h2"}}
156 +Mögliche Optionen zum Konfigurieren der Metadaten des Gewinnspiels.
139 139  {{/figure}}
140 140  
141 141  
142 -{{html wiki="true"}}
143 -<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='gs_onlineeinstellungen_de.png' width='300' group='$height' group='$group' title='Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes'/}}<div class='xm-figure-caption'>Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes</div></div></div>
144 -{{/html}}
160 +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:
145 145  
146 146  
147 -Nachdem auf die //Neues Gewinnspiel//-Schaltfläche geklickt oder ein Gewinnspiel in der Liste ausgewählt wurde, erscheint rechts die Konfigurationsseite für das Gewinnspiel. Hier können im oberen Bereich links konfiguriert werden, wann und wie das Gewinnspiel sichtbar sein soll. Die foldenden Optionen können konfiguriert werden:
148 -
149 -
150 150  ; **Aktiviert (Das Gewinnspiel ist aufrufbar)**
151 151  : Das Gewinnspiel kann über einen Link aufgerufen werden
152 152  
... ... @@ -153,31 +153,18 @@
153 153  ; **Gewinnspiel im Portal anzeigen**
154 154  : 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
155 155  
156 -; **Name des Gewinnspiels:**
169 +; **Name des Gewinnspiels**
157 157  : Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.
158 158  
159 -; **UUID des Gewinnspiels:**
172 +; **UUID des Gewinnspiels**
160 160  : Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.
161 161  
162 -; **Online von:**
175 +; **Online von**
163 163  : 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.
164 164  
165 -; **Online bis:**
178 +; **Online bis**
166 166  : 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.
167 167  
168 -; **Layout:**
169 -: 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:
170 -:; **Formular links**
171 -:: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
172 -:; **Formular rechts**
173 -:: Der //Beschreibungstext// wird links neben dem Formular angezeigt
174 -:; **Formular oben**
175 -:: Der //Beschreibungstext// wird unter dem Formular angezeigt
176 -:; **Formular unten**
177 -:: Der //Beschreibungstext// wird über dem Formular angezeigt
178 -:; **ohne Beschreibung**
179 -:: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
180 -
181 181  {{figure image="gs_microsite_de.png" clear="h2"}}
182 182  Mögliche Optionen zum Öffnen des Gewinnspiels bzw. zum Generieren von Code zum Einbetten des Gewinnspiels im Punkt //Microsite//
183 183  {{/figure}}
... ... @@ -211,6 +211,64 @@
211 211  :; **Bereitstellen als Ajax/JavaScript**
212 212  :: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
213 213  
214 +{{id name="deletions"/}}
215 +
216 +{{figure image="contest_deletions_de.png" clear="h2"}}
217 +Konfigurationsoberfläche zur Verwaltung der Löschfristen eines Gewinnspiels
218 +{{/figure}}
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.
233 +
234 +==== Inhalt ====
235 +
236 +{{figure image="contest_content_de.png" clear="h2"}}
237 +Mögliche Optionen zur Anpassung der Inhalte eines Gewinnspiels
238 +{{/figure}}
239 +
240 +; **Layout**
241 +: 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 +{{figure image="gs_bannergrafiken_de.png" clear="h2"}}
254 +Vorhandene Schaltflächen unter //Bannergrafiken//.
255 +{{/figure}}
256 +
257 +; Bannergrafiken
258 +: 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 +
214 214  {{figure image="gs_inhalt_de.png" clear="h2"}}
215 215  Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
216 216  {{/figure}}
... ... @@ -235,25 +235,6 @@
235 235  :; **HTML header (Microsite)**
236 236  :: 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.
237 237  
238 -{{figure image="gs_bannergrafiken_de.png" clear="h2"}}
239 -Vorhandene Schaltflächen unter //Bannergrafiken//.
240 -{{/figure}}
241 -
242 -; Bannergrafiken
243 -: 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:
244 -:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
245 -:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
246 -:: **Mobile** - bei 641 px oder weniger Bildschirmbreite
247 -: 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.
248 -
249 -: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
250 -:; **Desktop**, **Tablet** und **Mobile**
251 -:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
252 -:; **+ Bannergrafik ändern**
253 -:: Ö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.
254 -:; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
255 -:: Löschen der Grafik
256 -
257 257  ==== Fußzeile ====
258 258  
259 259  Hier befinden sich die folgenden zwei Schaltflächen:
... ... @@ -261,13 +261,128 @@
261 261  ; **Formular bearbeiten**
262 262  : Ö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.
263 263  
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 +
264 264  ; **Speichern**
265 265  : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
266 266  \\\\{{id name="backend_vorlagen"/}}
267 267  
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 +{{figure image="dialog_1_de.png" clear="h2"}}
324 +Dialog zu Konfiguration der Gewinnerziehung.
325 +{{/figure}}
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 +{{figure image="dialog_2_de.png" clear="h2"}}
332 +Anzeige der ermittelten Gewinner
333 +{{/figure}}
334 +
335 +==== Auswertung ====
336 +
337 +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"/}}
344 +
345 +
346 +
347 +
348 +
349 +=== Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===
350 +
351 +{{figure image="dialog_prize_de.PNG" clear="h2"}}
352 +Verwaltungsdialog für Gewinne
353 +{{/figure}}
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.
356 +
357 +==== Menü ====
358 +
359 +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.
396 +
397 +==== Fußzeile ====
398 +
399 +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 +{{figure image="dialog_import_excel_de.PNG" clear="h2"}}
408 +Dialog zur Konfiguration des Excel-Imports
409 +{{/figure}}
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"/}}
418 +
419 +
420 +
421 +
268 268  === Vorlagen verwalten ===
269 269  
270 -{{figure image="vorlagen_ui_de.png" clear="h2"}}
424 +{{figure image="template_ui_de.png" clear="h2"}}
271 271  Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
272 272  {{/figure}}
273 273  
... ... @@ -343,7 +343,7 @@
343 343  
344 344  : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
345 345  :; **Desktop**, **Tablet** und **Mobile**
346 -:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
500 +:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
347 347  :; **+ Bannergrafik ändern**
348 348  :: Ö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.
349 349  :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
... ... @@ -399,9 +399,60 @@
399 399  |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
400 400  |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
401 401  |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
402 402  |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
403 -|contest-portal.title.html|Titel der Gewinnspiel-Portalseite~{~{/table}}
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
404 404  
562 +{{id name="config_quartz"/}}
563 +
564 +== Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} ==
565 +
566 +{{figure image="contest_quartz_config_de" clear="h2"}}
567 +Konfiguration der Cron-Expression Property und Beschreibung des Quartz-Jobs
568 +{{/figure}}
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 +{{figure image="aktion_prize_chance.png" clear="h2"}}
578 +Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln//
579 +{{/figure}}
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.
582 +
583 +=== Parameter ===
584 +
585 +==== Ziehmodus ====
586 +
587 +; **Gewinncode**
588 +: 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.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] einer Aktion vom Typ [[Statusänderung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.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 +
405 405  == JavaScript-Schnittstellen ==
406 406  
407 407  === Allgemein ===
... ... @@ -460,6 +460,79 @@
460 460  
461 461  {{/code}}
462 462  
668 +==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====
669 +
670 +{{code language="none"}}
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', '*');
683 +
684 +{{/code}}
685 +
686 +==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====
687 +
688 +{{code language="none"}}
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', '*');
701 +
702 +{{/code}}
703 +
704 +==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====
705 +
706 +{{code language="none"}}
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', '*');
719 +
720 +{{/code}}
721 +
722 +==== 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 +{{code language="none"}}
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){
733 + return 0;
734 + }else{
735 + return -60;
736 + }
737 +}
738 +{{/code}}
739 +
740 +
463 463  === Portal-spezifisch ===
464 464  
465 465  Innerhalb des Portals wird für die Carousel-Darstellung die Bibliothekt [[slick>>https://kenwheeler.github.io/slick/||rel="noopener noreferrer" target="_blank"]] verwendet. Dies lässt sich hierbei wie folgt ansprechen und umkonfigurieren:
... ... @@ -561,7 +561,17 @@
561 561  
562 562  == Versionshistorie ==
563 563  
564 -(% class="wikigeneratedid" %)
842 +=== 1.5.0 ===
843 +
844 +* Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
845 +* JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
846 +
847 +=== 1.4.0 ===
848 +
849 +* Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
850 +* Erweiterung der scrollTo-Funktionen
851 +* Kleinere CSS-Anpassungen
852 +
565 565  === 1.3.4 ===
566 566  
567 567  * CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
dialog_1_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.mko
Größe
... ... @@ -1,0 +1,1 @@
1 +47.8 KB
Inhalt
dialog_2_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.mko
Größe
... ... @@ -1,0 +1,1 @@
1 +49.7 KB
Inhalt