Reporting - rozesílání emailu pomocí CAQservice

Úvod

Tento manuál řeší nastavení funkčnosti automatického rozesílání emailů pomocí funkce MAIL v modulu Dashboard (Reporting). Pro fungování celého procesu zasílání emailů musí být povoleny a konfigurovány:

• CAQservice (instalace a konfigurace Config.xml -> SMTP server)
• SMTP server
• CAQadmin (povolení modulu "Mail")

Nastavení SMTP

Aby mohlo být prováděno odesílání emailů je nutné instalovat CAQservice a službu konfigurovat pro SMTP.
Dle uvedeného odkazu také proveďte kontrolu funkčnosti odesílání emailů přes službu. Bez tohoto testu nepokračujte v dalším nastavení.

Nastavení v modulu Reporting, záložka "mail"

Proveďte spuštění modulu Reporting Viewer (../APL/Dashboard.exe).
- Vyberte požadovaný reporting dotaz např.  „SPC Náměry mimo toleranční pole“
- Vyberte "VLASTNOSTI" a zde "Spustit editor"
- Přejděte na záložku „Mail“ a nastavte hodnoty nutné k aktivaci automatického rozesílání emailů.

Podrobně je práce s modulem Reporting popsána v jeho nápovědě (".../DOC/Reporting.pdf").

Založení modulu

Je nutné definovat modul, který se bude zpracovávat při zaslání emailu (sekce "Moduly" - velká žlutá ikona v levé části). Pokud ještě neexistuje, založte si nový modul typu "Tisková sestava" a pojmenujte si ho, např. "SPC.mimo.tisk". Pro práci s moduly je nutné mít licenci na modul Reporting Designer. Následně si pod sekcí "Moduly" u založeného modulu "Tisková sestava" definujte její vzhled.

Nastavení emailů

Viz obrázek ukazující nastavení na záložce "Mail":

• Addresses - seznam pevných emailů, na které se má report rozeslat
• Attachments - definování formátu, modulu a názvu příloh které má email obsahovat
• MailContent - obsah emailu, vhodné vyplnit, některé SPAM filtry mohou zprávu blokovat při prázdném obsahu
• MailSubject - předmět emailu, vhodné vyplnit, některé SPAM filtry mohou zprávu blokovat při prázdném obsahu
• SenderAddress - emailová adresa odesílatele

Nastavení plánovače

Nastavení plánovače se provádí v okně "Plánovač" pod záložkou "Mail"

• Active - musí být nastaveno na TRUE
•  Triggers - klikněte na konci na ikonku tří teček  a otevře se Vám nové okno, kde si definujete dny, hodiny a periodu spouštení. Dny jsou zastoupeny číslicemi (1 = pondělí atd.), ukázka níže tedy bude rozesílána Po-Pá v 9 hod.

Spouštění, platný postup od verze 2021.xx.xxx

O pravidelné rozesílání emailů se stará CAQservice, která musí být instalována.

Dále musí být v ./APL/CAQadmin.exe (Správa systému) záložka "Plánovač" zaškrtnuto u řádku "Mail"

Ověření odeslaných zpráv

Po nastavení celého procesu je možné ověřit komu a kdy odešel jaký report.

Možnost 1)
Otevřete modul /APL/CAQadmin.exe nebo z Launcher v postraním panelu "Správa systému"

Přejděte na "Diagnostika" -> "Log" a v záložce "Mail" můžete sledovat jaký report byl odeslán a na jakou adresu. Dále pod záložkou "Scheduller" sledujete jak často se událost vyvolala a jaké reporty zpracovala.
 

Možnost 2)
Otevřete modul /APL/CAQadmin.exe nebo z Launcher v postraním panelu "Správa systému"

Přejděte na "Plánovač" zvolte plán "Mail" a v horní části můžete zvolit report, který je nastaven pro funkci zasílání emailů. Ve sloupci "Aktivní" lze jednotlivé reporty přepnout do stavu "Deaktivovat" respektive "Neaktivní".

V dolní části můžete sledovat jednotlivé LOGy pro každý z uvedených dotazů, kde v případě potíží s odeíláním najdete podrobnější důvod.

Obrázek ukazuje proces zpracování rozesílání emailů službou CAQservice. Z FlowChart můžete sledovat do jakého stavu dle čísledného kódu v sloupci "stav" se email dostal, nebo kde se právě nachází v procesu zpracování fronty emailů k odeslání.

Spouštění naplánované úlohy, tento postup je zastaralý pro verze do 2020.xx.xxx

Pro fungování plánovače nastaveného v sekci "Mail" je nutné, aby ve Windows běžela každou hodinu naplánovaná úloha spouštějící připravenou dávku ".../APL/scheduler.mail.bat". Pokud nemáte vyplněné ověřovací údaje vůči SMTP serveru v souboru config.xml (z bezpečnostních důvodů je toto doporučený postup), použije se pro ověření uživatel Windows, pod kterým bude naplánovaná úloha spouštěna, takže je potřeba zajistit, aby měl, případně i stanice, právo odesílat email.

Při každém spuštění dávky pak dojde k ověření, zda v modulu Reporting "nečeká" úloha, která by se dle nastavení v "Plánovači" již měla rozeslat a případně se tak stane. Dávka je nastavena tak, aby logovala svůj běh do naší databáze a v modulu Reporting najdete připravený dotaz "Palstat LOGs", ve kterém je mimo jiné vidět i výstup z mailování.

Pro účely testování je možné rozeslání buď všech nebo konkrétního reportového dotazu vynutit, bez ohledu na jeho nastavení regulérních časů pro poslání v "Plánovači", viz parametr "force" v ukázce níže:

ModuleRunner SCHEDULER/SMMailReport MailReportModule /force all

ModuleRunner SCHEDULER/SMMailReport MailReportModule /force "Název reportového dotazu"