Wiki source code of Notifikace

Last modified by Josef Vencl on 2021/11/26 07:45

Show last authors
1 (% class="box" %)
2 (((
3 Notifikace jsou automatické e-mailové zprávy, které jsou zaslány definovaným uživatelům v okamžiku, kdy nastane určitá situace. Například založení nového uživatelského účtu, vypršení přístupu ke kurzu nebo přiřazení nového kurzu uživateli.
4 )))
5
6 Notifikace existují v systému dvojího druhu - globální a lokální. Globalní notifikace platí pro všechny objekty v systému a nastavují se ze sekce Nastavení, [[tabu Notifikace 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Nastavení.Tab Notifikace.WebHome]] v modálovém okně Notifikace. Lokální notifikace se nastavují z [[detailu aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]] a platí pouze pro danou aktivitu. Pokud je tedy nastavena globální notifikace na splnění aktivity uživatelem, odešle se v okamžiku kdy jakýkoli uživatel splní jakoukoli aktivitu v systému. Pokud je nastavena stejná notifikace lokálně na aktivitě, odešle se v pouze případě, kdy jakýkoli uživatel splní tuto konkrétní aktivitu.
7
8 Při nastavení **lokální i globální notifikace na stejný spouštěč** se v závislosti na nastavení zpracují obě notifikace, lokální notifikace nahradí notifikaci globální nebo lokální notifikace zruší tu globální bez náhrady. Zmíněné nastavení upravíme v konfiguračním okně Notifikace z [[Detailu aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]] zatržením checkboxů Nahradit globální notifikaci, resp. Zrušit globální notifikaci pro tuto aktivitu.
9
10 = Adresáti notifikací =
11
12 Adresátem notifikace může být pouze uživatel spojený se spuštěnou akcí. Jsou to:
13
14 * //uživatel// - přímo spojený např. s aktivitou, která mu je přiřazena, nebo jako majitel uživatelského účtu, jehož e-mail se ověřuje.
15 * //hodnotitel// - uživatel, který je u aktivit a hodnocení jako hodnotitel přiřazen
16 * (% class="box warningmessage" %)
17 (((
18 //zadavatel - k doplnění//
19 )))
20 * (% class="box warningmessage" %)
21 (((
22 //příjemce notifikací skupiny - k doplnění//
23 )))
24 * Další příjemci notifikací mohou být přidáni jmenovitě ve Specifickém nastavení notifikace (viz níže ↓).
25
26 = Události (spouštěče notifikací) =
27
28 U každé události uvádíme krátký popis kontextu události, související obrazovky, ev. doporučené globální/lokální nasazení.
29
30 == Aktivace nové verze aktivity ==
31
32 Verze aktivity mohou být aktivovány ručně nebo může být jejich aktivace načasována. Oba způsoby spustí notifikaci.
33
34 * Související obrazovka: [[Detail aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]], tab Popis
35
36 == Založení nového uživatele ==
37
38 Uživatele v Competentu zakládáme jednotlivě nebo hromadně importem souboru. Oba způsoby spustí notifikaci.
39
40 * Doporučené nasazení: globální
41 * Související obrazovka: [[Obrazovka Lidé 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Lidé.WebHome]]
42 * Související ukázka: [[Import uživatelů ►>>doc:Main.Official manuals.Competent - Uživatelská příručka.Případy použití - Administrátor.Lidé.Import uživatelů.WebHome]]
43
44 == Zapomenuté heslo ==
45
46 Událost spouští uživatel z obrazovky Přihlášení.
47
48 * Související obrazovka: Přihlášení
49
50 == Přiřazení aktivity uživateli ==
51
52 Notifikace se odešle při vytvoření nové uživatelské aktivity.
53
54 * Související obrazovky: [[Detail aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]], tab Uživatelé, [[Detail sady 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail sady.WebHome]], tab Uživatelé.
55 * Související téma: Import dat
56
57 == Dokončení aktivity ==
58
59 Uživatelská aktivita změnila stav na Dokončeno s libovolným výsledkem.
60
61 == Úspěšné dokončení aktivity ==
62
63 Uživatel splnil aktivitu.
64
65 == Neúspěšné dokončení aktivity ==
66
67 Uživatelský přístup k aktivitě vypršel, než ji uživatel stihl splnit, přp. vypršely pokusy.
68
69 == Zrušení aktivity ==
70
71 Uživatelský přístup byl zrušen.
72
73 * Související obrazovka: [[Detail aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]]
74
75 == Potřeba vyhodnocení aktivity ==
76
77 == Změna emailu uživatele ==
78
79 == Ověření emailu uživatele ==
80
81 Spouštěč čeká na příkaz serveru Odeslat ověření e-mailu s parametrem Uživatelské ID. Takto zadanému uživateli je následně odeslán e-mail s odkazem pro ověření.
82
83 **Doporučené nastavení**
84
85 * Globální notifikace, Základní typ
86 * Základní šablona
87 * parametry v šabloně: link
88
89 **Související témata**
90
91 * [[Zasílání e-mailů 📖>>doc:Main.Official manuals.Competent - Uživatelská příručka.Slovník.Zasílání e-mailů.WebHome]]
92 * [[Uživatel 📖>>doc:Main.Official manuals.Competent - Uživatelská příručka.Slovník.Uživatel.WebHome]] - viz parametr emailVerified
93 * [[Příkazy serveru 📖>>doc:Main.Official manuals.Competent - Uživatelská příručka.Slovník.Příkazy serveru.WebHome]]
94
95 == Přiřazení hodnocení uživateli ==
96
97 == Dokončení hodnocení ==
98
99 == Úspěšné dokončení hodnocení ==
100
101 == Neúspěšné dokončení hodnocení ==
102
103 == Zrušení hodnocení ==
104
105 == Vyhodnocení pokusu hodnocení ==
106
107 == Aktualizace pokusu hodnocení ==
108
109 == Vyhodnocení pokusu aktivity ==
110
111 **Spouštěč není implementován**
112
113 == Aktualizace pokusu aktivity ==
114
115 == Aktualizace pokusu aktivity po vyhodnocení ==
116
117 == Aktualizace pokusu hodnocení po vyhodnocení ==
118
119 == Počet dní před datem splnění aktivity ==
120
121 **Spoštěč není implementován**
122
123 == Počet dní po datu splnění aktivity ==
124
125 **Spouštěč není implementován**
126
127 == Počet dní před datem splnění hodnocení ==
128
129 **Spouštěč není implementován**
130
131 == Počet dní po datu splnění hodnocení ==
132
133 **Spouštěč není implementován**
134
135 == Prodloužení přístupu k aktivitě ==
136
137 Akce se provede ve chvíli, kdy je přístup uživatele k aktivitě automaticky prodloužen (viz [[Automaticky prodloužený přístup k aktivitě 📖>>doc:Main.Official manuals.Competent - Uživatelská příručka.Slovník.Automaticky prodloužený přístup k aktivitě.WebHome]]).
138
139 == Prodloužení přístupu k hodnocení ==
140
141 Akce se provede ve chvíli, kdy je přístup uživatele k hodnocení automaticky prodloužen (viz [[Automaticky prodloužený přístup k aktivitě 📖>>doc:Main.Official manuals.Competent - Uživatelská příručka.Slovník.Automaticky prodloužený přístup k aktivitě.WebHome]]).
142
143 == Začátek přístupu k aktivitě ==
144
145 Související obrazovky: [[Detail uživatele 💻>>]], tab Aktivity; [[Detail aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Aktivity.Detail aktivity.WebHome]], tab Uživatelé
146
147 Související obrazovky studentského modu: [[Obrazovka Nástěnka 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Studentské rozhraní.Obrazovka Nástěnka.WebHome]]; [[Obrazovka Aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Studentské rozhraní.Obrazovka Aktivity.WebHome]]; [[Obrazovka Detail uživatelské aktivity 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Studentské rozhraní.Obrazovka Aktivity.Obrazovka Detail uživatelské aktivity.WebHome]]
148
149 == Začátek přístupu k hodnocení ==
150
151 Související obrazovky: [[Detail uživatele 💻>>]], tab Hodnocení; [[Detail hodnocení 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Administrátorské rozhraní.Obrazovka Hodnocení.WebHome]], tab Uživatelé
152
153 Související obrazovky studentského modu: [[Obrazovka Hodnocení 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Studentské rozhraní.Obrazovka Hodnocení.WebHome]]; [[Obrazovka Detail hodnocení 💻>>doc:Main.Official manuals.Competent - Uživatelská příručka.Uživatelské rozhraní.Studentské rozhraní.Obrazovka Hodnocení.Detail hodnocení.WebHome]]
154
155 == Agregační skupina ==
156
157 Speciální typ notifikace sloužící k seskupení více různých dalších notifikací do jedné zprávy, která se jednou denně odešle příjemci. Notifikace použije hlavičku a patičku agregační e-mailové šablony a naplní ji těly notifikací, které jsou pod ní seskupeny. Pro účely odeslání agregačního e-mailu jsou ignorována některá nastavení na agregační skupině a na dílčích dílčích notifikacích:
158
159 **Ignorováno na agregační skupině**
160
161 * Tělo šablony notifikace
162
163 **Ignorováno na dílčí notifikaci**
164
165 * Hlavička a Patička šablony notifikace
166 * Notifikace se odesílá ... - všechny parametry určující příjemce dílčích notifikací
167 * Některé parametry Specifického nastavení:
168 ** Emails
169 ** Groups
170 ** //Custom//
171
172 == Doporučené nastavení v agregační skupině ==
173
174 * typ šablony: Agregovaná
175 * typ dílčí šablony: Základní (nepoužije se hlavička a patička)
176 * typ notifikace: Agregovaná
177 * (% class="box warningmessage" %)
178 (((
179 typ dílčí notifikace: Základní - toto nastavení se zřejmě v agregační skupině neprojeví
180 )))
181
182 = Specifické nastavení =
183
184 Notifikaci můžeme dále ladit parametry Specifického nastavení. Jedná se o objekt typu JSON a v modálovém okně Notifikace jej upravujeme pomocí grafického editoru. Vlastnosti:
185
186 * Aggregation - napojení na spouštěč Agregační skupina, který tuto notifikaci zařadí mezi další upozornění v této skupině
187 ** ##emailTemplateUsageId - number[]## - seznam identifikátorů agregačních notifikací, do nichž bude tato notifikace začleněna.
188 * Enrich - ##string[] ##(výběr z menu) - seznam tříd, které rozšíří data dostupná pro šablonu e-mailu, takže do ní bude možné dosadit další značky. V tuto chvíli nejsou dostupné žádné obecně dostupné třídy, pouze vytvořené na míru pro jednotlivé klienty.
189 * Emails - pevně stanovené e-maily, na které se notifikace také odešle
190 ** ##emailList - string[] ##- seznam e-mailů oddělených čárkami
191 * Custom - ##{classname: config}[] ##- dynamické stanovení příjemce e-mailu na základě události, přp. jiná akce. Classname stanoví třídu pro spuštění, zatímco volitelný Config dodá případné parametry. V tuto chvíli nejsou dostupné obecně dostupné třídy, pouze vytvořené na míru pro klienty.
192 * Groups - ##{groupNameList: objectRoleList}[]## - pevně stanovené skupiny a uživatelské role v nich, kterým se notifikace také odešle
193
194 [[image:Modal-Notification-annotated.png]]
195
196 Grafický nástroj pro editaci JSON. Obsahuje všechny uvedené parametry:
197
198 * **(1)** Aggregation - emailTemplateUsageId. Pomocí tlačítka **+** je možné přidat další vazby na Agregovanou notifikaci.
199 * **(2)** Enrich - po klikntí na tlačítko **+** zobrazí k výběru dostupné rozšiřující třídy
200 * **(3)** Emails - emailList. Textové pole obsahuje e-mailové adresy oddělené čárkou. Alternativně lze také přidat další řádky.
201 * **(4)** Custom
202 * **(5)** Groups - pole objektů, v němž jsou pod klíčem názvu skupiny vypsány role, jejichž nositelé budou z dané skupiny obesláni.
203
204 (% class="box infomessage" %)
205 (((
206 Aktualizováno na verzi 185
207 )))