Änderungen von Dokument Gewinnspiel-Portal-Plugin

Von 1.1 nach 2.1 Von 8.1 nach 9.1

Von Version 2.1

bearbeitet von MKO
am 04.03.2021, 10:12

Änderungskommentar: Imported from XAR

Auf Version 8.1

bearbeitet von jdr
am 16.11.2021, 09:19

Änderungskommentar: Neues Bild aktion_prize_chance.png hochladen

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
- aktion_prize_chance.png

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.mko
++XWiki.jdr

Inhalt

@@ -52,11 +52,29 @@
  : Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
  ; Gewinner ermitteln {{version major="1" minor="4"}}{{/version}}
--: 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.
++: 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.
++; Teilnehmer exportieren {{version major="1" minor="5"}}{{/version}}
++: Berechtigung zum Exportieren der aktuellen Liste der Gewinnspiel-Teilnahmer
++
  ; Ersatzgewinner ermitteln {{version major="1" minor="4"}}{{/version}}
--: Ermöglicht es wiederholt Ersatzgewinner zu ermitteln.
++: Ermöglicht es, wiederholt Ersatzgewinner zu ermitteln.
++; Gewinne verwalten {{version major="1" minor="6"}}{{/version}}
++: Berechtigung, um neue Gewinne zu erstellen und vorhandene Gewinne bearbeiten und löschen zu dürfen.
++
++; Gewinnbild hochladen {{version major="1" minor="6"}}{{/version}}
++: Berechtigung das vorhandene Gewinnbild eines Gewinns hochladen zu dürfen.
++
++; Gewinnbild löschen {{version major="1" minor="6"}}{{/version}}
++: Berechtigung das vorhandene Gewinnbild eines Gewinns löschen zu dürfen.
++
++; Verknüpfung Gewinnervorgang aufheben {{version major="1" minor="6"}}{{/version}}
++: Berechtigung die vorhandene Verknüpfung eines Gewinnvorgangs am Gewinn aufheben zu dürfen.
++
++; Löschfristen verwalten {{version major="1" minor="7"}}{{/version}}
++: Berechtigung, um Löschfristen zu erstellen, zu bearbeiten oder löschen zu dürfen.
++
  ==== Vorlagen verwalten ====
  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.
@@ -75,12 +75,6 @@
  Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.
  {{/figure}}
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
@@ -119,7 +119,7 @@
  === Gewinnspiele verwalten ===
--{{figure image="gewinnspiele_ui_de.png" clear="h2"}}
++{{figure image="contest_ui_de.png" clear="h2"}}
  Verwaltungsoberfläche für den Menüpunkt //Gewinnspiele verwalten//
  {{/figure}}
@@ -127,7 +127,7 @@
  ==== Menü ====
--Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}}, exportiert {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}}, als Vorlage gespeichert {{icon name="fa-save" title="Als Vorlage speichern" size="1x" cssClass="fa-save"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinnspiel-Liste automatisch gefiltert wird. Beim Anlegen eines neuen Gewinnspiels kan entweder ein neues leeres Gewinnspiel angelegt, ein zuvor exportiertes Gewinnspiel wieder geladen oder eine Vorlage als Grundlage für das Gewinnspiel verwendet werden.
++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.
  Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
@@ -138,21 +138,16 @@
  ; {{ficon name="circle-outline"/}}
  : Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
--==== Einstellungen ====
++==== Metadaten ====
--{{figure image="gs_onlineeinstellungen_de.png" clear="h2"}}
--Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes
++{{figure image="contest_meta_data_de.png" clear="h2"}}
++Mögliche Optionen zum Konfigurieren der Metadaten des Gewinnspiels.
  {{/figure}}
--{{html wiki="true"}}
--<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>
--{{/html}}
++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:
--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:
--
--
  ; **Aktiviert (Das Gewinnspiel ist aufrufbar)**
  : Das Gewinnspiel kann über einen Link aufgerufen werden
@@ -159,31 +159,18 @@
  ; **Gewinnspiel im Portal anzeigen**
  : 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
--; **Name des Gewinnspiels:**
++; **Name des Gewinnspiels**
  : Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.
--; **UUID des Gewinnspiels:**
++; **UUID des Gewinnspiels**
  : Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.
--; **Online von:**
++; **Online von**
  : 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.
--; **Online bis:**
++; **Online bis**
  : 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.
--; **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:
--:; **Formular links**
--:: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
--:; **Formular rechts**
--:: Der //Beschreibungstext// wird links neben dem Formular angezeigt
--:; **Formular oben**
--:: Der //Beschreibungstext// wird unter dem Formular angezeigt
--:; **Formular unten**
--:: Der //Beschreibungstext// wird über dem Formular angezeigt
--:; **ohne Beschreibung**
--:: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
--
  {{figure image="gs_microsite_de.png" clear="h2"}}
  Mögliche Optionen zum Öffnen des Gewinnspiels bzw. zum Generieren von Code zum Einbetten des Gewinnspiels im Punkt //Microsite//
  {{/figure}}
@@ -217,6 +217,64 @@
  :; **Bereitstellen als Ajax/JavaScript**
  :: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
++{{id name="deletions"/}}
++
++{{figure image="contest_deletions_de.png" clear="h2"}}
++Konfigurationsoberfläche zur Verwaltung der Löschfristen eines Gewinnspiels
++{{/figure}}
++
++; **Löschfristen des Gewinnspiels** {{version major="1" minor="7"}}{{/version}}
++: 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.
++:: **Löschtyp**
++::; **nach Ende des Gewinnspiels**
++::: 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.
++::; **nach Formulareingang**
++::: Eine Löschfrist dieses Typs wird erst angewandt, wenn die eingestellten Tage der Löschfrist nach Eingang des Vorgangs in das Postfach vergangen sind.
++:; **Löschstatus**
++:: 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.
++:; **Tage bis zur Löschung**
++:: Tage die es benötigt in Abhängigkeit zum Löschtyp bis Ausführung der Löschfrist.
++
++: Durch den Knopf //+ Löschfrist hinzufügen// kann eine neue Löschfrist konfiguriert werden, welche gespeichert wird durch das Drücken auf den Knopf zum Speichern des Gewinnspiels. Jede Löschfrist besitzt am Ende den {{ficon name="trash-alt2"/}}-Knopf, wodurch die Löschfrist nach Bestätigung endgültig entfernt wird. Sobald es zur Ausführung und Löschung von Vorgängen durch eine Löschfrist gekommen ist, wird dies als [[System-Protokolleintrag>>doc:Formcycle.UserInterface.Protocol]] dokumentiert.
++
++==== Inhalt ====
++
++{{figure image="contest_content_de.png" clear="h2"}}
++Mögliche Optionen zur Anpassung der Inhalte eines Gewinnspiels
++{{/figure}}
++
++; **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:
++:; **Formular links**
++:: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
++:; **Formular rechts**
++:: Der //Beschreibungstext// wird links neben dem Formular angezeigt
++:; **Formular oben**
++:: Der //Beschreibungstext// wird unter dem Formular angezeigt
++:; **Formular unten**
++:: Der //Beschreibungstext// wird über dem Formular angezeigt
++:; **ohne Beschreibung**
++:: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
++
++{{figure image="gs_bannergrafiken_de.png" clear="h2"}}
++Vorhandene Schaltflächen unter //Bannergrafiken//.
++{{/figure}}
++
++; 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:
++:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
++:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
++:: **Mobile** - bei 641 px oder weniger Bildschirmbreite
++: 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.
++
++: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
++:; **Desktop**, **Tablet** und **Mobile**
++:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
++:; **+ Bannergrafik ändern**
++:: Ö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.
++:; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
++:: Löschen der Grafik
++
  {{figure image="gs_inhalt_de.png" clear="h2"}}
  Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
  {{/figure}}
@@ -241,25 +241,6 @@
  :; **HTML header (Microsite)**
  :: 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.
--{{figure image="gs_bannergrafiken_de.png" clear="h2"}}
--Vorhandene Schaltflächen unter //Bannergrafiken//.
--{{/figure}}
--
--; 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:
--:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
--:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
--:: **Mobile** - bei 641 px oder weniger Bildschirmbreite
--: 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.
--
--: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
--:; **Desktop**, **Tablet** und **Mobile**
--:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
--:; **+ Bannergrafik ändern**
--:: Ö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.
--:; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
--:: Löschen der Grafik
--
  ==== Fußzeile ====
  Hier befinden sich die folgenden zwei Schaltflächen:
@@ -268,11 +268,17 @@
  : Ö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.
  ; **Gewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
--: 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.
++: 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.
  ; **Ersatzgewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
--: Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist sowie bereits eine Gewinnerziehung stattgefunden hat. Er öffnet den Dialog zu Konfiguration und zum Starten der Nachziehung von Gewinnern.
++: 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.
++; **Teilnehmer exportieren** {{version major="1" minor="5"}}{{/version}}
++: 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.
++
++; **Gewinne verwalten** {{version major="1" minor="6"}}{{/version}}
++: Diese Schaltfläche ist erst bei entsprechender Berechtigung verfügbar. Sie öffnet den Dialog zur Verwaltung der Gewinne des ausgewählten Gewinnspiels.
++
  ; **Speichern**
  : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
  \\\\{{id name="backend_vorlagen"/}}
@@ -279,7 +279,7 @@
  === Gewinner ermitteln {{version major="1" minor="4"}}{{/version}} ===
--Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
++Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde, ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
  {{figure image="dialog_1_de.png" clear="h2"}}
  Dialog zu Konfiguration der Gewinnerziehung.
@@ -287,25 +287,102 @@
  ==== Konfiguration ====
--Startet man über die entsprechenden Schaltflächen die Ermittlung der Gewinner eines Gewinnspiels, so öffnet sich hierbei ein Konfigurationdialog. In diesem wird angegeben aus welchem Status die Teilnehmer-Datensätze herangezogen werden, sowie die Anzahl der eigentlichen Gewinner in ihren Ausprägungen. Hierbei wird unterschieden zwischen Hauptgewinnern, Nebengewinnern und zusätzlichen Ersatzgewinnern. Die Datensätze die für die jeweilige Ausprägung gezogen weden, werden anschließen je nach Auswahl mit oder ohne ausgeführter Statusverarbeitgung in den zugehörigen Zielstatus überführt.
++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.
  {{figure image="dialog_2_de.png" clear="h2"}}
  Anzeige der ermittelten Gewinner
  {{/figure}}
--==== Asuwertung ====
++==== Auswertung ====
--Nach der Ziehung wird eine Übersicht mit den ermittelten Gewinnern angezeigt. Hierbei werden je nach Verfügbarkeit Spalten der Projekt-spezifischen Postfach-Ansicht oder der Betreff inkl. von Standard-Spalten angezeigt. Ferner sind die Spalten über die zugehörige Auswahl anpassbar. Über die Schlatfläche "Export" steht zusätzlich diese Tabelle mit allen vorhandenen Spalten als Excel-Datei zur Verfügung. Ferner kann über "Export" > "... mit kompletten Datensätzen" das Excel auch um alle im Formular vorhandenen Eingabedaten erweitert werden.
++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.
  ==== Gewinner nachziehen ====
--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.
++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.
++\\{{id name="backend_prizes"/}}
++
++
++
++=== Gewinne verwalten {{version major="1" minor="6"}}{{/version}} ===
++
++{{figure image="dialog_prize_de.PNG" clear="h2"}}
++Verwaltungsdialog für Gewinne
++{{/figure}}
++
++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.
++
++==== Gewinndetails ====
++
++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:
++
++; **UUID des Gewinns**
++: Gibt die eindeutige UUID des Gewinns aus, um diesen identifizieren zu können.
++
++; **Gewinnname**
++: Konfigurierbarer Name des Gewinns. Jeder Gewinn muss einen Namen besitzen, ansonsten kann ein Gewinn nicht angelegt werden.
++
++; **Kategorie**
++: Frei definierbare Kategorisierung eines Gewinns. Wird in der Plugin-Aktion //Gewinn ermitteln// genutzt für eine möglichen Limitierung der Gewinnziehung auf eine Kategorie.
++
++; **Gewinncode**
++: Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen.
++
++; **Gewinn-Link**
++: Benutzerdefinierter Link für den Gewinn, um bspw. eine URL als Link in das Gewinnbild einzubinden.
++
++; **UUID des Gewinner-Vorgangs**
++: 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.
++
++; **Gewinnbeschreibung**
++: 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.
++
++; **Gewinnbild**
++: Oben rechts kann das Bild des Gewinns konfiguriert werden. Es bestehen zwei Auswahlmöglichkeiten, um das Gewinnbild zu konfigurieren:
++:; **Über eine Bild-Ressource**
++:: 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.
++:; **Über eine Bild-URL**
++:: 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.
++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.
++
++; **Speichern**
++: Speichert die im Dialog gemachten Konfiguration bzw. Änderungen am selektierten Gewinn.
++
++==== Fußzeile ====
++
++Hier befinden sich die folgenden zwei Schaltflächen:
++
++; **+ Excel-Import**
++: Import von Gewinnen aus Excel-Datei.
++
++; **Schließen**
++: Schließen des Dialogfensters.
++
++{{figure image="dialog_import_excel_de.PNG" clear="h2"}}
++Dialog zur Konfiguration des Excel-Imports
++{{/figure}}
++
++==== Excel-Import von Gewinnen ====
++
++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.
++
++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.
++Ü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.
++\\{{id name="backend_prize_import"/}}
++
++
++
++
  === Vorlagen verwalten ===
--{{figure image="vorlagen_ui_de.png" clear="h2"}}
++{{figure image="template_ui_de.png" clear="h2"}}
  Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
  {{/figure}}
@@ -381,7 +381,7 @@
  : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
  :; **Desktop**, **Tablet** und **Mobile**
--:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
++:: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewechselt werden
  :; **+ Bannergrafik ändern**
  :: Ö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.
  :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
@@ -443,6 +443,54 @@
  |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
  |expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist
++{{id name="config_quartz"/}}
++
++== Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} ==
++
++{{figure image="contest_quartz_config_de" clear="h2"}}
++Konfiguration der Cron-Expression Property und Beschreibung des Quartz-Jobs
++{{/figure}}
++
++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.
++
++; portal.contestent.deletion.cron
++: Ü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.
++
++== Plugin-Aktion: Gewinn ermitteln {{version major="1" minor="6"}}{{/version}} ==
++
++{{figure image="aktion_prize_chance.png" clear="h2"}}
++Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln//
++{{/figure}}
++
++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.
++
++; **Gewinnchance**
++: Durch den Zieh-Modus //Gewinnchance// kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü //Limitieren auf Kategorie//.
++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.
++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.
++
++=== Rückgabewert der Plugin-Aktion ===
++
++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.
++
++**Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:**
++
++|=Rückgabewert|=Beschreibung
++|[%$Aktionsname.SUCCESS%]|Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein
++|[%$Aktionsname.RESULT[0].uuid%]|Eindeutige UUID des erhaltenen Gewinns
++|[%$Aktionsname.RESULT[0].description%]|Beschreibung des erhaltenen Gewinns
++|[%$Aktionsname.RESULT[0].category%]|Kategorie des erhaltenen Gewinns
++|[%$Aktionsname.RESULT[0].process%]|Eindeutige UUID des Gewinner-Vorgangs
++|[%$Aktionsname.RESULT[0].picture%]|Bild-URL des erhaltenen Gewinns
++|[%$Aktionsname.RESULT[0].link%]|Gewinn-Link des erhaltenen Gewinns
++
  == JavaScript-Schnittstellen ==
  === Allgemein ===
@@ -555,6 +555,25 @@
  {{/code}}
++==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====
++
++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.
++
++{{code language="none"}}
++// Liefert standardmäßig 0 zurück
++Contest.calcScrollOffset();
++
++// Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).
++Contest.calcScrollOffset = function(){
++    if(window.matchMedia('(min-width: 960px)').matches){
++        return 0;
++    }else{
++        return -60;
++    }
++}
++{{/code}}
++
++
  === Portal-spezifisch ===
  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:
@@ -656,6 +656,20 @@
  == Versionshistorie ==
++=== 1.7.0 ===
++
++* Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen
++
++=== 1.6.0 ===
++
++* Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien
++* 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
++* JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
++
  === 1.4.0 ===
  * Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export

aktion_prize_chance.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jdr

Größe

...	...	@@ -1,0 +1,1 @@
	1	+38.0 KB

Inhalt