This is UltimateRPA Documentation
Management Console

1 Co je aplikace UltimateRPA Management Console

Nástroj UltimateRPA Management Console je webová aplikace, která slouží k zobrazení různých měření (entit) zasílaných z robotizačních skriptů. Konzole je zobrazuje ve stromové struktuře tak, jak jsou zasílána z jednotlivých schedulerů a jimi spouštěných úloh.

2 Přihlášení do aplikace

Login_screen.png
Obrázek 1 Console - Přihlášení do aplikace

Do aplikace je možné se přihlásit pomocí administrátorského účtu, který byl vytvořen během instalace. Pro přihlášení pod tímto uživatelem je nutné zadat uživatelské jméno admin a heslo admin. Po prvním úspěšném přihlášení je doporučeno heslo změnit.

3 Volba licence

Login_license.png
Obrázek 2 Console - Volba licence

Po prvním přihlášení se aplikace přeptá na typ licence. Je možné buď vložit komerční licenci, nebo pokračovat v používání aplikace s nekomerční licencí.

3.1 Chci nekomerční licenci

Použití nekomerční licence je omezeno licenční smlouvou. Po volbě „Pokračovat s licencí pro nekomerční využití“ je možné začít nekomerční licenci produktu ihned používat. Dialog ohledně výběru licence se v tomto případě zobrazí při každém dalším přihlášení do aplikace. Zároveň bude v pravé dolní části obrazovky vyznačeno, že je používána nekomerční licence.

License_no_comercial.png
Obrázek 3 Console - Oznámení o využívání nekomerční licence

Po kliknutí na toto oznámení je možné vyvolat dialog, kde je uveden typ a vlastník licence.

Register_license.png
Obrázek 4 Console - Dialog s registrací

Zároveň je možné volbou Registrovat licenci přejít do dialogu volby licence a registrace.

Více informací o tom, jakým způsobem lze získat komerční licenci je možné se dočíst v kapitole Registrace licence.

License_comercial.png
Obrázek 5 Console - Oznámení o využívání komerční licence

Po vložení komerční licence se oznámení o licenci změní na šedou barvu a obsahuje název vlastníka licence. Po kliknutí na oznámení je možné zobrazit další detaily licence.

License_comercial_detail.png
Obrázek 6 Console - Detail komerční licence

Pomocí volby Odregistrovat licenci je možné kdykoliv přejít zpět k licenci nekomerční.

Po přihlášení obsahuje aplikace až čtyři stránky (dle role uživatele), mezi kterými je možné se přepínat pomocí navigačního panelu v levém horním rohu aplikace.

Přehled stránek aplikace:

  • Nastavení: Nastavení aplikace.
  • Uživatelé: Správa uživatelů.
  • Přehled: Stránka, na které je možné nalézt samotné stromy měření.
  • Odhlášení: Ukončení práce s aplikací.

4 Nastavení aplikace

Navigation_settings.png
Obrázek 7 Console - Navigační panel, záložka s nastavením aplikace

4.1 Nastavení SMTP Serveru

Jedná se o sekci nastavení, ve které je možné nastavit parametry nutné pro správnou funkci notifikací. Nastavují se zde parametry SMTP serveru, který je následně používán k zasílání notifikačních emailů.

Settings_email_SMTP.png
Obrázek 8 Console - Nastavení SMTP serveru
  • Host: Adresa SMTP serveru
  • Port: Port, na kterém server běží
  • Username: Přihlášení k SMTP serveru.
  • Password: Heslo použité pro přihlášení k SMTP.
  • SMTP Encryption: Zabezpečení použité při komunikaci s SMTP serverem.

Pro promítnutí změn nastavení je nutné nastavení uložit pomocí tlačítka na konci formuláře.

4.2 Test nastavení notifikací

Settings_email_test.png
Obrázek 9 Console - Test nastavení notifikací

V této sekci nastavení je možné ověřit, zda byl správně nastaven SMTP server a bude tak fungovat zasílání upozornění. Po vložení emailové adresy a potvrzení odešle aplikace na zadanou adresu testovací email, který vypadá následovně:

Předmět: Stav měření test je NODATA
NODATA since 2018-06-12T15:44:08.077

4.3 Nastavení Email šablon

Settings_email_templates.png
Obrázek 10 Console - Šablony pro Email notifikace

V této sekci nastavení je možné nastavit předmět a tělo emailu, který bude poslán jako notifikace.

4.4 Nastavení Scheduleru

Settings_scheduler.png
Obrázek 11 Console - Nastavení hesla pro Scheduler

Nastavení hesla, které využívá scheduler pro posílání dat do console.

5 Správa uživatelů

Navigation_users.png
Obrázek 12 Console - Navigační panel, záložka s vytvářením uživatelů

Do této sekce se uživatel s právy administrátora dostane kliknutím na záložku Uživatelé.

User_list.png
Obrázek 13 Console - Seznam uživatelů vytvořených v aplikaci

Zde je možné přidávat a odebírat uživatele aplikace. Zároveň se zde přiřazují uživatelské role. Ty mohou být:

  • user (v seznamu uživatelů má černou ikonu před jménem)
    • má právo sledovat hodnoty zaslané z robotizačních scriptů
  • admin (v seznamu uživatelů má červenou ikonu před jménem)
    • má právo sledovat hodnoty zaslané z robotizačních scriptů.
    • má možnost mazat záznamy zaslané z robotizačních scriptů.
    • má právo přidávat a mazat uživatele v aplikaci

Uživatel s rolí admin může přidat nového uživatele stisknutím tlačítka Vytvořit. Smazat uživatele lze kliknutím na ikonu koše.

New_user_dialog.png
Obrázek 14 Console - Dialog s přidáním nového uživatele

6 Zobrazení výsledků měření

Navigation_overview.png
Obrázek 15 Console - Navigační panel, záložka s výsledky měření

6.1 Zápis výsledků měření

Výsledky měření zapisuje robot pomocí funkce write_measure do adresáře, který musí být nastaven v aplikaci Scheduler. Ten v pravidelných intervalech kontroluje obsah tohoto adresáře a výsledky měření odesílá do Console. Po jejich odeslání je z adresáře smaže. Po přihlášení do aplikace je možné po přepnutí na záložku "Přehled" vidět jednotlivé výsledky měření. Výsledky měření jsou uspořádány do stromu, kdy všechny listy jsou potomkem kořene stromu. Jméno kořene stromu je vždy definováno jménem úlohy ze Scheduleru a jednotlivé listy jsou pojmenovány podle parametru name použitého při zápisu dat pomocí funkce write_measure. Listy měření se zakládají automaticky s přijatými měřeními. Listy lze ručně smazat. Po kliknutí na kořen stromu je možné skrýt všechny jeho listy.

6.2 Detail řádku měření

Na následujícím obrázku je zobrazen detail měření, na kterém jsou popsány jeho jednotlivé části a ovládací prvky.

Line_detail.png
Obrázek 16 Console - Řádek měření s popisem
Číslo Popis
1 Stav měření Jedná se o stav, se kterým měření skončilo.
Hodnota status z funkce write_measure.
2 Název měření Informace s názvem měření.
Hodnota name z funkce write_measure.
3 Detailní popis měření Informace s detailním popisem měření.
Hodnota description z funkce write_measure.
4 Samotná hodnota měření Hodnota value z funkce write_measure.
5 Jednotka měření Hodnota unit z funkce write_measure.
6 Datum měření Kdy bylo samotné měření provedeno.
7 Historie měření Možnost dostat se zpětně k minulým hodonotám měření.
8 Notifikace Nastavení notifikací.
9 Smazání řádku s měřením

V tabulce je možné nalézt všechny možné hodnoty, kterých může nabývat stav měření.

Ikona Popis
Process_tree_NO_DATA.png
NO DATA
Process_tree_INFO.png
INFO
Process_tree_SUCCESS.png
SUCCESS
Process_tree_WARNING.png
WARNING
Process_tree_ERROR.png
ERROR

Do kořene stromu je propagován vždy nejhorší stav měření pod ním. Jinak řečeno, kořen stromu má stav podle toho, jak dopadlo nejhorší měření (čím je měření v tabulce níž, tím je bráno za horší). NO_DATA je stav, který není možné zapsat pomocí funkce write_measure. Tento stav nastane automaticky v momentě, kdy nejsou již data z měření platná.

6.3 Uživatelské akce se stromem měření

Ikona Akce Popis akce
Line_History.png
Historie měření Zobrazení historické hodnoty měření.
Line_notification_bw.png
Nastavení notifikace Nastavení notifikace na stav měření.
Po potvrzení notifikace se obálka změní na černou.
Line_delete.png
Smazání záznamu měření Smazání řádku s měřením.

6.3.1 Historie měření

Line_history_detail.png
Obrázek 17 Console - Historické hodnoty měření

Po kliknutí na ikonu grafu je možné získat historické hodnoty měření. Historie se otevře v novém dialogovém okně.

6.3.2 Nastavení notifikace

Nad každým z měření je možné nastavit notifikace a vybrat si stavy, které nás budou zajímat. Po kliknutí na ikonu obálky se otevře formulář s nastavením notifikace na email.

Ukázka nastavení notifikace

V momentě, kdy přijde další záznam s tímto měřením a bude splňovat stav, který byl v notifikaci vybrán, bude uživateli odeslán email. Jak bude email vypadat je možné definovat v nastavení aplikace. Po potvrzení notifikace se obálka zbarví na černou.

Line_notification_demo.png
Obrázek 18 Console - Zapnuté notifikace

Ukázka doručeného Emailu

Předmět: Stav měření Aktualní stav zpracování dávky je INFO
Stav měření Aktualní stav zpracování dávky k 2018-02-05T15:12:48 je SUCCESS, komentář: Doplňující informace

6.3.3 Smazání záznamu měření

Po kliknutí na ikonu koše je možné odstranit záznam měření. Před samotným smazáním se ještě objeví dialog, kde je nutné smazání potvrdit.

Line_delete_confirm_dialog.png
Obrázek 19 Console - Dialog odstranění měření

6.4 Ukázka zápisu měření

Ukázka python výrazu, který se postará o zapsání měření z obrázku. Pátý parametr, který má hodnotu 744 nám říká, že zapsaná hodnota bude platná 744 minut. Pokud do té doby nepřijde jiné měření se stejným identifikátorem, nastane stav no data.

import urpa
def main():
urpa.write_measure("Dokončení procesu ", "SUCCESS", 0, "%",744,"Doplňující informace")

Výsledek zapsaný v souboru vypadá poté následujícím způsobem.

{"task":{"id":"42bd9167-23a1-4ad8-9a4f-2882ebe67dbc","name":"py"},"measure":{"id":"Dokončení procesu ","name":"Dokončení procesu ","timestamp":"2018-06-08T11:50:10Z","validity":"2018-06-08T12:00:00Z","tolerance":744,"payload":{"status":"SUCCESS","value":0,"unit":"%","description":"Doplňující informace"}}}

Data budou poslána do console a zobrazena následujícím způsobem:

Line_example.png
Obrázek 20 Console - Řádek hodnot zapsaných pomocí scriptu