HeInfo - Rozšiřující moduly

Z WikiOrange
Přejít na: navigace, hledání


Úvod

Samostatně fungující program HeInfo slouží jako doplňující nástroj k Helios Orange. Program je schopen hlídat na základě uživatelem vytvořených definic rozličné události, ke kterým v rámci databáze Helios Orange dochází, a o těchto událostech (stavech) uživatele informovat prostřednictvím nadefinovaných akcí. Program funguje zcela nezávisle na Helios Orange, uživatel nemusí mít Helios Orange spuštěn.

Uživatelem vytvořené definice jsou v rámci programu nazývány jako "události". Událost vždy obsahuje vstupní podmínku, která je vůči databázi Helios Orange kontrolována, a následnou akci (či akce), které jsou po splnění podmínky spuštěny. Podmínky jsou zapsány formou libovolného SQL dotazu (SELECT). Na základě počtu vrácených záznamů daného dotazu se vyhodnotí, zda byla podmínka splněna, a následně jsou spuštěny předdefinované akce. Počet hlídaných událostí není omezen.

Program lze získat pomocí funkce Helios Store "Stáhni z webu nejnovější verzi" v rámci programu Helios Orange. Je distribuován zdarma. Lze použít jako doplněk například k modulům Nástroje přizpůsobení, Nástroje pro řízení procesů nebo Workflow. Pro fungování programu je tedy nutné mít licenci alespoň na jeden z těchto modulů.


Příklad Slovní příklad definice události v programu HeInfo:

Pokud je počet nezahájených úkolů, jejichž řešitelem je uživatel uvedený v nastavení, alespoň 1, bude odeslán email danému uživateli: “Existují úkoly, kde jste uveden/a jako řešitel, které jsou stále ve stavu nezahájeno.“

Dalším příkladem může být upozornění pro účetní, že v sytému jsou nerealizované faktury, atd.

Řešení najdete zde

Instalace a možnosti použití

Program je možno používat v několika základních režimech:

a) Lokální instalace na všech počítačích uživatelů, kteří jej chtějí používat. Na lokální stanici je uložen program i konfigurační soubor s definicemi událostí. Veškerá nastavení a definice si každý uživatel spravuje sám, jiní uživatelé nemají ke konfiguraci přístup. Stanice musí mít připojení na SQL server.

b) Spouštění programu ze sdíleného úložiště (například sdílený adresář s instalací Helios Orange na serveru). Program včetně konfiguračního souboru je přístupný všem uživatelům. Všichni tedy sdílejí stejnou konfiguraci (definice událostí). Princip používání je stejný jako v případě čistě lokální instalace, je však třeba počítat s tím, že v tomto případě je konfigurační soubor pouze jeden pro všechny, všichni mají právo jej měnit, mazat či upravovat definice apod. a tím pádem se všem uživatelům spouštějí stejné akce za stejných podmínek.

c) Spouštění jako služba - program běží pouze na serveru jako služba a uživatelé s ním vůbec nepracují. Služba zpracovává vytvořené definice, které mají nadefinovány akce typu Odeslat e-mail a Spustit SQL skript – tedy neprojevující se nijak vizuálně (není je „komu“ zobrazovat) a v určených intervalech je vykoná. Služba může běžet na libovolném počítači v síti, nemusí jít nutně o stejný počítač, na kterém běží SQL server. Postup instalace služby nejdete zde. c) "Serverová instalace". V tomto režimu uživatelé vůbec s HeInfo nepracují. Program běží pouze na serveru jako takovém pod libovolným uživatelským účtem a zpracovává někým (správcem) vytvořené definice. "Serverem" je v tomto smyslu myšlen libovolný počítač v síti, nemusí jít nutně o stejný počítač, na kterém běží SQL server. Pochopitelně však musí mít běžící HeInfo na SQL server přístup. V rámci "serverového režimu" má smysl využívat v podstatě jen akce, které se neprojevují nijak vizuálně (není je „komu“ zobrazovat), tj. odesílání mailů, spouštění dalších aplikací či skriptů. Na takovém „serveru“ běží jedno HeInfo s mnoha definicemi událostí, které rozesílají např. maily na různé adresy. Uživatelé v „terénu“ bez přímého spojení na SQL server (ale s připojením na internet) tak mohou dostávat informace o událostech automaticky mailem.


Postup instalace:

1) Stáhněte program prostřednictvím funkce "Helios Store" z prostředí Helios Orange stejným způsobem jako při aktualizaci samotného Helios Orange či jeho doplňkových knihoven (pluginů). Na záložce "Zdarma" vyhledejte položku Heinfo. Klikněte na tlačítko Přidat a následně Instalovat. Po stažení bude program HeInfo.exe uložen do adresáře Helios Orange. V rámci databáze Helios Orange nebude program HeInfo nijak viditelný (jedná se o zcela samostatně pracující doplněk).

2) Dle zvoleného režimu používání (viz předchozí sekce) zkopírujte HeInfo.exe na jednotlivé stanice (do libovolných adresářů) nebo ponechte v adresáři Helios Orange.

3) Spusťte soubor HeInfo.exe podle vámi vybraného umístění dle předchozích bodů (lokální instalace, běh programu na serveru nebo serverová instalace). Automaticky bude vytvořen konfigurační soubor HeInfo.XML do stejné složky jako HeInfo.exe. Do konfiguračního souboru se ukládají jednak obecná nastavení a dále jednotlivé definice událostí.

4) Po prvním spuštění budete programem vyzváni k nastavení cesty na soubor HeKonfig.dll z adresáře Helios Orange. Tento krok je nutný pro ověření zakoupených modulů (Workflow či Nástroje přizpůsobení) a bez souboru HeKonfig.DLL nelze v práci pokračovat. Knihovnu HeKonfig.dll z adresáře Heliosu je též možno zkopírovat do adresáře s HeInfo.exe na lokální stanici.

Zadání cesty ke knihovně HEKONFIG.DLL

Ovládání

Po spuštění programu se zobrazí jeho ikona v oznamovací oblasti hlavního panelu. Hlavní okno zobrazíte kliknutím na ikonu levou myší. Okno se skládá ze záložek Definice událostí, Konfigurace, Logování událostí a Windows služba.

Na záložce Definice událostí je k dispozici jejich přehled a lišta nástrojů s hlavními funkcemi pro práci s událostmi. Jednotlivá tlačítka mají následující funkce:

  • Nový – vytvoření nové události
  • Oprava – editace označené události (události, na které je umístěn v přehledu kurzor).
  • Smazat – smazání označené události
  • Aktivovat – aktivace/deaktivace události
  • Import – importovat definice události z externího souboru
  • Export – export definice události
  • Spustit – spuštění označené události (podmínky definice se ověří ihned, nečeká se na časový interval nastavený v definici)
  • Kopie - vytvoří kopii označené definice, nově vzniklá kopie je nastavena jako neaktivní


Konfigurace

Na záložce Konfigurace lze změnit cestu k souboru HeKonfig.dll (kterou jste zadali při prvním spuštění). Po zaškrtnutí volby Logovat aktivitu programu bude vytvořen soubor HeInfo.log, do kterého se zapisuje průběh činnosti programu. Po aktivaci volby Automaticky spustit po startu Windows se bude program spouštět automaticky při startu PC. Zaškrtnutím políčka Zkontrolovat definice typu „interval“ hned po startu (nečekat na uplynutí prvního intervalu) provede HeInfo kontrolu všech "intervalových" definic ihned po startu programu, tj. nečeká se na uplynutí prvního intervalu. Je možno nastavit též Jazyk aplikace a zvolit Vzhled aplikace. Pokud máte zvolený jiný vzhled, než "Windows", tak po kliknutí na křížek se nastaví právě vzhled Windows. Změna nastavení jazyka se projeví až po restartu aplikace, změna vzhledu ihned.


Pro správné fungování odesílání e-mailových zpráv je nutné nastavit sekci SMTP server:

Záložka konfigurace

Po nastavení konfiguraci potvrdíte tlačítkem OK. Konfigurace bude uložena a program se opět zminimalizuje do oznamovací oblasti hlavního panelu. Tlačítko Storno změny zruší (neprovede se uložení konfigurace).

Lišta oznámení ve Windows

Po kliknutí pravým tlačítkem na ikonu programu v oznamovací oblasti se zobrazí lokální nabídka. Zde můžete Pozastavit sledování (program přestane dočasně spouštět SQL dotazy a ikona zešedne) / Pokračovat ve sledování (obnoví se normální činnost programu), zobrazit informace O programu (zobrazí aktuální používanou verzi apod.) či Ukončit program.

Lokální nabídka
Lokální nabídka

Definice událostí

Definice událostí

Přehled událostí

Na záložce "Definice událostí" je vidět přehled všech nastavených událostí, ať už ve stavu aktivním, nebo neaktivním (rozlišení pomocí zaškrtávátka u názvu události ve sloupci "A"). V dalším sloupci je vidět název události a v posledním sloupci je uveden přibližný čas dalšího spuštění kontroly definice.

Založení nové události

Novou událost založíte stisknutím tlačítka „Nový“ (F2) - objeví se okno „Definice události – nová definice“. Každá událost se skládá z definice podmínky na záložce Základní údaje, záložky Informační hláška, Časového intervalu a z definice následující Akce na stejnojmenné záložce. Akce následuje v případě splnění podmínek definovaných na záložce základní údaje.

Na záložce Základní údaje zadejte nejprve obecné údaje o definici – název a popis,které slouží pro lepší identifikaci definice pro uživatele. Hodnota Název je vidět v přehledu událostí. Aby událost byla spouštěna, musí být zaškrtnuto políčko Aktivní. Pokud zaškrtnete i políčko Automaticky deaktivovat definici po prvním spuštění, deaktivuje se událost po prvním splnění podmínky, tj. událost bude nadále neaktivní a již se nebude nadále kontrolovat, dokud neprovedete přepnutí do aktivního stavu. Pro správné fungování je nezbytné vyplnit SQL údaje – název serveru a název databáze, ve které se bude SQL dotaz provádět. Volitelně lze zadat též přihlašovací jméno a heslo (pokud je neuvedete, program automaticky použije NT autentifikaci). Klíčovou částí je samotný SQL dotaz. Jeho splnění či nesplnění je vyhodnoceno na základě počtu vrácených záznamů, ne na základě vrácených hodnot!! Do políčka „spustit akci, jestliže počet vrácených záznamů“ doplňte příslušný operátor (<; >; <=; =>; <>; =) a číslovku. Tlačítko Test slouží k ověření funkčnosti spojení a správnosti SQL dotazu. Po spuštění testu se provede SQL dotaz. O úspěšném průběhu informuje informační okno.

Informace o úspěšně proběhlé zkoušce podmínky


Na záložce Informační hláška můžete popsat detailněji zobrazovaný text při spuštění události. Můžete pracovat s různým nastavením fontů, tučného textu a kurzívy a velikostí písma. Lze vyplnit titulek a text informační hlášky (použito též pro odeslaný e-mail).


Pomocí tlačítek <..>, která jsou umístěna vedle polí pro titulek a text informační hlášky, lze pracovat s atributy, které lze přidat do samotné zprávy. Tyto atributy jsou vybrány na základě SQL dotazu, který je zadán na záložce "Základní údaje" v definici události. Pracujeme-li tedy s tabulkou úkolů a v SQL dotazu je uvedeno: SELECT * FROM TabUkoly WHERE...., tak po kliknutí na <..> se zobrazí všechny dostupné atributy, které lze přidat. Pokud by SQL dotaz vypadal takto: SELECT Predmet FROM TabUkoly WHERE...., pak se v seznamu atributů zobrazí pouze atribut Predmet. Další volbou při přidávání atributů je možnost přidat Seznam, resp. 1.hodnota. Využití lze najít v případě, že potřebujete zobrazit všechny záznamy, resp. první záznam, který odpovídá zadané podmínce v SQL dotazu. Rozdíl pak bude v tom, že v textu hlášky, v okně definice události, bude vedle běžného, vámi zapsaného textu, zobrazeno <@Predmet> pro seznam, resp. <Predmet> pro první nalezenou hodnotu. Tyto se pak při spuštění události změní v požadované hodnoty.

Informační hláška

Záložka Časový interval - zvolte pomocí přepínače (kliknutím na přepínací políčko), zda se má SQL dotaz provádět v zadaném intervalu nebo denně v určitou dobu.

Založení nové události, základní údaje


Na záložce Akce se definují činnosti, které program provede v případě splnění podmínky. V seznamu dostupných akcí lze zaškrtnout libovolnou kombinaci. Na výběr máte z následujících možností:

  • Zobrazit informační bublinu v oblasti hlavního panelu - zobrazí informační bublinu navázanou na ikonu HeInfo s titulkem a textem Informační hlášky.
  • Zobrazit informační okno - zobrazí informační okno. Je možné odkliknout pomocí OK.
  • Přehrát zvukový soubor - po spuštění akce přehraje Vámi uvedený soubor (.waw, .mp3).
  • Přečíst hlášku s využitím SAPI (WinXP)- v systému WinXP přečte uvedenou hlášku.
  • Odeslat email na adresy (automaticky deaktivovat akci po prvním odeslaném emailu) - akci pro odeslání e-mailu lze nastavit pro automatickou deaktivaci po odeslání prvního mailu (tj. nebude deaktivována celá definice, pouze akce pro odeslání e-mailu)
  • Spustit externí akci - spustí vybranou externí akci.
  • Spustit SQL skript - spustí uvedený SQL skript.


V případě splnění podmínky budou spuštěny všechny zaškrtnuté akce.

Založení nové události, akce

Tlačítko Test akcí na této záložce simuluje splnění podmínky a dojde ke spuštění předdefinované akce (akcí).

Informace o úspěšně proběhlé zkoušce akce


Příklad

Příklad

Následující obrázky dokumentují příklad použití HeInfo a definované události, která „hlídá“ počet úkolů, které jsou ve stavu "Nezahájeno" a řešitelem je zaměstnanec uvedený v podmínce (v případě příkladu v databázi Helios004). Ve chvíli, kdy dotaz vrátí nenulový počet nezahájených úkolů, kde řešitelem je konkrétní zaměstnanec, dojde ke spuštění akce (zobrazí se informační okno) – viz následující obr.

Příklad definování události v HeInfo - základní údaje
Příklad definování události v HeInfo - akce

Windows služba

Součástí instalačního balíčku (spolu s HeInfo.exe) je i služba HeInfoService.exe.

Po stažení balíčku z HeliosStore se soubory rozbalí do adresáře Helios Orange (HeInfoService.exe musí být ve stejném adresáři jako konfigurační soubor HeInfo.xml). HeInfoService.exe ověřuje licenci vůči HeKonfig.dll, takže pro službu musí být tento soubor přístupný a to na té cestě, kterou si nastavíte v konfiguraci HeInfo.

Služba zapisuje případné chybové hlášení a další informace na dvě místa – do standardního systémového EventLogu Windows a pak do souboru HeInfoService.log, který je automaticky vytvořen ve stejném adresáři, jako je služba.

Ze všech dostupných akcí u jednotlivých definic zpracovává služba pouze dvě – odesílání mailu a spouštění SQL příkazu. Změny v definicích událostí, které mají být zpracovávány v režimu služby, se projeví až po restartu služby!


Instalace služby

Nejjednodušší cesta, jak službu nainstalovat, je přes příkazový řádek, který musí být spuštěn přes "Spustit jako správce". HeInfoService.exe nakopírujte do vhodného cílového adresáře a spusťte příkaz: <CESTA>HeInfoService.exe /install. Stejným způsobem lze zase službu odinstalovat (<CESTA>HeInfoService.exe /uninstall). Nově nainstalovanou službu je potřeba spustit přes správce služeb (služba se po instalaci pouze zaregistruje).

Stav služby (zda je nainstalována, zda běží atd.) je vidět v okně aplikace HeInfo na záložce „Windows služba“ (viz obrázek níže). Informace se vztahuje k počítači, na kterém je v daný okamžik HeInfo spuštěno. Je-li služba nainstalována na serveru (nejběžnější situace), neuvidí uživatel ze své stanice stav služby na serveru. Informace o běžící službě bude za takových podmínek aktuální pouze za předpokladu, že i samotná aplikace HeInfo bude spuštěna přímo na serveru. Záložka „Windows služba“ tedy typicky slouží spíše jako kontrolní informace pro administrátory, kteří přímo na serveru (kde služba běží) spravují jednotlivé definice pomocí HeInfo aplikace.

Služba