| ... |
... |
@@ -75,6 +75,9 @@ |
| 75 |
75 |
; Löschfristen verwalten {{version major="1" minor="7"}}{{/version}} |
| 76 |
76 |
: Berechtigung, um Löschfristen zu erstellen, zu bearbeiten oder löschen zu dürfen. |
| 77 |
77 |
|
|
78 |
+; Gewinnspiel zurücksetzen {{version major="2"}}{{/version}} |
|
79 |
+: Berechtigung ein vorhandenes Gewinnspiel zurücksetzen zu dürfen. |
|
80 |
+ |
| 78 |
78 |
==== Vorlagen verwalten ==== |
| 79 |
79 |
|
| 80 |
80 |
Notwendige Berechtigung, um neue Gewinnspielvorlagen erstellen und vorhandene Gewinnspielvorlagen bearbeiten und löschen zu dürfen. Nur wenn dieses Recht aktiv ist, kann der Nutzer ein vorhandenes Gewinnspiel als Vorlage speichern. |
| ... |
... |
@@ -83,6 +83,9 @@ |
| 83 |
83 |
|
| 84 |
84 |
Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen |
| 85 |
85 |
|
|
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 |
+ |
| 86 |
86 |
=== Gewinnspiel-Portal öffnen === |
| 87 |
87 |
|
| 88 |
88 |
Berechtigung, das Gewinnspiel-Portal aus {{formcycle/}} heraus direkt öffnen zu dürfen |
| ... |
... |
@@ -259,6 +259,17 @@ |
| 259 |
259 |
:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden |
| 260 |
260 |
:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite |
| 261 |
261 |
:: **Mobile** - bei 641 px oder weniger Bildschirmbreite |
|
268 |
+ |
|
269 |
+{{figure image="header.png" clear="h2"}} |
|
270 |
+Seit Version 1.8.0 erweitere Varianten der //Bannergrafiken//. |
|
271 |
+{{/figure}} |
|
272 |
+ |
|
273 |
+: 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. |
|
274 |
+:: **Desktop (1280px)** - ab 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
275 |
+:: **Tablet (960px)** - zwischen 960 px und 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
276 |
+:: **Mobile (600px)** - zwischen 600 px und 960 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
277 |
+:: **Mobile (320px)** - bei 600 px oder weniger Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
278 |
+ |
| 262 |
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 |
263 |
|
| 264 |
264 |
: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken: |
| ... |
... |
@@ -371,6 +371,9 @@ |
| 371 |
371 |
; **Kategorie** |
| 372 |
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 |
373 |
|
|
391 |
+; **Gruppe** |
|
392 |
+: 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. |
|
393 |
+: |
| 374 |
374 |
; **Gewinncode** |
| 375 |
375 |
: Code des Gewinns, welcher im Gewinnspiel-Portal eingeben werden kann, um über die Plugin-Aktion //Gewinn ermitteln// einen Gewinner-Vorgang zuzuweisen. |
| 376 |
376 |
|
| ... |
... |
@@ -413,7 +413,7 @@ |
| 413 |
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 |
414 |
|
| 415 |
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. |
|
436 |
+Ü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. |
| 417 |
417 |
\\{{id name="backend_prize_import"/}} |
| 418 |
418 |
|
| 419 |
419 |
|
| ... |
... |
@@ -488,11 +488,24 @@ |
| 488 |
488 |
Vorhandene Schaltflächen unter //Bannergrafiken//. |
| 489 |
489 |
{{/figure}} |
| 490 |
490 |
|
|
511 |
+ |
|
512 |
+ |
| 491 |
491 |
; Bannergrafiken |
| 492 |
492 |
: Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels und auf der Microsite angezeigten Bannergrafiken für diese Gewinnspiel-Vorlage konfiguriert werden. Für unterschiedliche Geräteklassen bzw. Bildschirmauflösungen können dabei verschiedene Grafiken genutzt werden. Zur Auswahl stehen die folgenden Größen: |
| 493 |
493 |
:: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden |
| 494 |
494 |
:: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite |
| 495 |
495 |
:: **Mobile** - bei 641 px oder weniger Bildschirmbreite |
|
518 |
+ |
|
519 |
+{{figure image="header.png" clear="h2"}} |
|
520 |
+Seit Version 1.8.0 erweitere Varianten der //Bannergrafiken//. |
|
521 |
+{{/figure}} |
|
522 |
+ |
|
523 |
+: 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. |
|
524 |
+:: **Desktop (1280px)** - ab 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
525 |
+:: **Tablet (960px)** - zwischen 960 px und 1280 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
526 |
+:: **Mobile (600px)** - zwischen 600 px und 960 px Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
527 |
+:: **Mobile (320px)** - bei 600 px oder weniger Bildschirmbreite {{version major="1" minor="8"}}{{/version}} |
|
528 |
+ |
| 496 |
496 |
: Wenn eine Bannergrafik für eine Geräteklasse nicht explizit konfiguriert wird, wird bei der Anzeige die Grafik des nächstgrößeren Formats verwendet. Dementsprechend sollte die Grafik für //Desktop// immer konfiguriert werden, während //Tablet// und //Mobile// optional sind. Unterstützt werden alle im Browser zulässigen Bildformate. |
| 497 |
497 |
|
| 498 |
498 |
: Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken: |
| ... |
... |
@@ -559,6 +559,54 @@ |
| 559 |
559 |
|contest-portal.title.html|Titel der Gewinnspiel-Portalseite |
| 560 |
560 |
|expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist |
| 561 |
561 |
|
|
595 |
+{{id name="config_quartz"/}} |
|
596 |
+ |
|
597 |
+== Konfiguration des Quartz-Jobs {{version major="1" minor="7"}}{{/version}} == |
|
598 |
+ |
|
599 |
+{{figure image="contest_quartz_config_de" clear="h2"}} |
|
600 |
+Konfiguration der Cron-Expression Property und Beschreibung des Quartz-Jobs |
|
601 |
+{{/figure}} |
|
602 |
+ |
|
603 |
+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. |
|
604 |
+ |
|
605 |
+; portal.contestent.deletion.cron |
|
606 |
+: Ü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. |
|
607 |
+ |
|
608 |
+== Plugin-Aktion: Gewinn ermitteln {{version major="1" minor="6"}}{{/version}} == |
|
609 |
+ |
|
610 |
+{{figure image="aktion_prize_chance.png" clear="h2"}} |
|
611 |
+Nutzeroberfläche für Plugin-Aktion vom Typ //Gewinn ermitteln// |
|
612 |
+{{/figure}} |
|
613 |
+ |
|
614 |
+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. |
|
615 |
+ |
|
616 |
+=== Parameter === |
|
617 |
+ |
|
618 |
+==== Ziehmodus ==== |
|
619 |
+ |
|
620 |
+; **Gewinncode** |
|
621 |
+: 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. |
|
622 |
+ |
|
623 |
+; **Gewinnchance** |
|
624 |
+: Durch den Zieh-Modus //Gewinnchance// kann das Ziehen auf eine bestehende Kategorie der Gewinne beschränkt werden, durch das Auswahlmenü //Limitieren auf Kategorie//. |
|
625 |
+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. |
|
626 |
+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. |
|
627 |
+ |
|
628 |
+=== Rückgabewert der Plugin-Aktion === |
|
629 |
+ |
|
630 |
+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. |
|
631 |
+ |
|
632 |
+**Über die folgenden Aktionsplatzhalter kann auf die zurückgegebenen Attribute der Plugin-Aktion in FORMCYCLE zugegriffen werden:** |
|
633 |
+ |
|
634 |
+|=Rückgabewert|=Beschreibung |
|
635 |
+|[%$Aktionsname.SUCCESS%]|Aktion war erfolgreich und der abgeschickte Vorgang hat einen Gewinn gezogen. Dieser Wert kann true oder false sein |
|
636 |
+|[%$Aktionsname.RESULT[0].uuid%]|Eindeutige UUID des erhaltenen Gewinns |
|
637 |
+|[%$Aktionsname.RESULT[0].description%]|Beschreibung des erhaltenen Gewinns |
|
638 |
+|[%$Aktionsname.RESULT[0].category%]|Kategorie des erhaltenen Gewinns |
|
639 |
+|[%$Aktionsname.RESULT[0].process%]|Eindeutige UUID des Gewinner-Vorgangs |
|
640 |
+|[%$Aktionsname.RESULT[0].picture%]|Bild-URL des erhaltenen Gewinns |
|
641 |
+|[%$Aktionsname.RESULT[0].link%]|Gewinn-Link des erhaltenen Gewinns |
|
642 |
+ |
| 562 |
562 |
== JavaScript-Schnittstellen == |
| 563 |
563 |
|
| 564 |
564 |
=== Allgemein === |
| ... |
... |
@@ -689,7 +689,18 @@ |
| 689 |
689 |
} |
| 690 |
690 |
{{/code}} |
| 691 |
691 |
|
|
773 |
+==== (% id="cke_bm_1486S" style="display:none" %) (%%)Umschalten der Einzeige eines Gewinnspiels in den Gewonnen-Status: {{version major="1" minor="8"}}{{/version}} ==== |
| 692 |
692 |
|
|
775 |
+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. |
|
776 |
+ |
|
777 |
+{{code language="none"}} |
|
778 |
+// Snippet für eine HTML-Abschlussseite welches die Anzeige des aktuellen Gewinnspiels in den Gewonnen-Status schaltet. |
|
779 |
+// Funktioniert für die Bereitstellung als Micro-Site und innerhalb des Portals. |
|
780 |
+if (window.parent && window.parent.Contest) { |
|
781 |
+ window.parent.Contest.markAsWon([%$PROJECT_ID%], window); |
|
782 |
+} |
|
783 |
+{{/code}} |
|
784 |
+ |
| 693 |
693 |
=== Portal-spezifisch === |
| 694 |
694 |
|
| 695 |
695 |
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: |
| ... |
... |
@@ -791,6 +791,25 @@ |
| 791 |
791 |
|
| 792 |
792 |
== Versionshistorie == |
| 793 |
793 |
|
|
886 |
+=== 1.8.0 === |
|
887 |
+ |
|
888 |
+* Funktionalität der Pflege Bannergrafiken um weitere responsive Stufe und spezielle Grafiken für den Fall des Gewinns erweitert |
|
889 |
+* JavaScript-Schnittstelle um die Banner-Grafik im Falle eines Gewinns umzuschalten hinzugefügt |
|
890 |
+ |
|
891 |
+=== 1.7.1 === |
|
892 |
+ |
|
893 |
+* Funktionalität zum Bereitstellen der MetaDaten von Preisen für die Visualisierung innerhalb des Formulars (PreRender-Plugin) |
|
894 |
+* Preis-Gruppen für die Zusammenfassung der zu visualisierenden Preise |
|
895 |
+ |
|
896 |
+=== 1.7.0 === |
|
897 |
+ |
|
898 |
+* Funktionalität zur Pflegung von Löschfristen und Ausführung eines Quartz-Jobs zur Anwendung der gepflegten Löschfristen |
|
899 |
+ |
|
900 |
+=== 1.6.0 === |
|
901 |
+ |
|
902 |
+* Funktionalität zur Pflegung von Gewinnen eines Gewinnspiels und Import von Gewinnen aus Excel-Dateien |
|
903 |
+* Aktion zur Ermittlung und Prüfung von Gewinnen anhand von Gewinncodes oder konfigurierbarer Wahrscheinlichkeit |
|
904 |
+ |
| 794 |
794 |
=== 1.5.0 === |
| 795 |
795 |
|
| 796 |
796 |
* Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht |
