Zdarzenia i reakcje
Interfejs definicji zdarzeń, które są wynikiem zmian w danych w systemie. Mechanizm pozwala na elastyczne generowanie powiadomień email/notyfikacji w systemie z pełną kontrolą obsługi tych zdarzeń.
Mechanizm zdarzeń pozwala na konfigurowanie reakcji na występujące zdarzenia w systemie. Mechanizm zdarzeń działa na poziomie Obiektów. Operator systemu ma możliwość definicji zdarzeń na podstawowe operacje wykonywane na obiektach: Utworzenie, Modyfikacja, Usunięcie. Na podstawie tych podstawowych operacji może dodatkowo konfigurować czy system zareaguje na dane zdarzenie modyfikując skrypty sprawdzające. Pozwalają one na wprowadzenie dodatkowych warunków bazujących na danych konkretnego obiektu np. stan. Za pomocą skryptów modyfikujących użytkownik ma możliwość zmiany parametrów zdarzenia na podstawie danych pochodzących z obiektu np. wypełnienie listy adresatów email na podstawie parametrów obiektu np. przypisanej osoby do zdarzenia serwisowego.
Lista zdarzeń pozwala na przeglądanie zrealizowanych obsług zdarzeń w systemie. Jeśli zostanie zdefiniowane zdarzenie dla obiektu, to wszystkie operacje na tym obiekcie będą analizowane przez system. Na podstawie konfiguracji zdarzenia system będzie obsługiwał dane zdarzenie (np. wyśle email) lub określi, że zdarzenie jest ignorowane (np. nie spełnia warunków skryptu sprawdzającego).
W liście zdarzeń przedstawiane są wszystkie zdarzenia i reakcję systemu na nie. Filtr pozwala na selektywne wyświetlanie danych. Aby zobaczyć szczegóły przetwarzania zdarzenia należy wybrać dowolne zdarzenie. System przedstawi szczegóły zdarzenia.
Szczegóły zdarzenia przedstawiają informacje dotyczące zdarzenia, daty utworzenia, przetworzenia przez system oraz datę ważności.
| Data ważności określa czas przez który system będzie przetwarzał dane zdarzenie np. zdarzenie wysłania komunikatu przez email, gdy serwer email nie jest dostępny. W takim przypadku system będzie ponawiał wykonanie tego zdarzenia aż do czasu ważności. Po tym czasie zdarzenie zostanie określone jako niewykonane. |
Po wyborze zakładki 'Dane' wyświetlane są poszczególne reakcje systemu na zdarzenie. Po wyborze poszczególnej akcji przedstawiane są logi w dolnej części okna np. informacje o wysyłce email.
Za pomocą widoków nowego/starego obiektu możemy przeglądnąć strukturę zapisanych obiektów. Pokazywane są dane w formacie JSON.
W widoku Różnica pokazywane są różnice pomiędzy rekordami starym i nowym.
| Te dane można wykorzystać podczas tworzenia reguł zdarzeń. Rekordy pozwalają na dostęp do tych danych przedstawianych tutaj jako dane JSON. Można to wykorzystać w skryptach sprawdzających (np. sprawdzenie nazwy stanu zdarzenia serwisowego) lub w szablonach powiadomień (tytuł/treść emaila). |
Reguły zdarzenia
Aby zdefiniować reakcję systemu na zdarzenia, należy wybrać sekcję 'Reguły zdarzeń'. Po jej wybraniu przedstawiana jest lista reguł zdarzeń, które zostały zdefiniowane w systemie. Dodanie nowej reguły następuje po wyborze przycisku (+).
Definicja reguły zdarzenia (lub jego edycja) jest podzielona na kilka sekcji. Definicja ogólna zdarzenia, edytor skryptu przygotowującego oraz edytor skryptu sprawdzającego.
W definicji reguły zdarzenia określamy nazwę widoczną dla operatora systemu, typ obiektu, którego dotyczy dane zdarzenie (który obiekt będzie przetwarzany przez daną regułę). Typ zdarzenia określa reakcję systemu na zdarzenie tj. czy akcja ma być wykonana gdy dany obiekt zostanie utworzony, zmieniony czy usunięty. Opcja 'Okresowe' dotyczy specjalnych reakcji zdarzeń okresowych wykorzystywanych przez schedulery.
| W polach tekstowych edytora można używać do formatowania specjalnego mechanizmu Markdown. Za jego pomocą można wygenerować klikalne linki, pogrubienia, listy itp. Wyszukaj dokumentację znakowania Markdown na sieci aby poznać jego możliwości. |
Dane podstawowe (zakładka 'Email') pozwalają na wprowadzenie informacji dotyczących podstawowych elementów wiadomości email takich jak tytuł, treść oraz stałe pola adresów email (z listy użytkowników lub lista stała dowolnych adresów).
W polach tekstowych można również wykorzystać dane z obiektów, które są przetwarzane. Wykorzystywana jest do tego notacja z podwójnym nawiasem {{}} nazwa_pola_obiektu. Aby poznać dozwolone pola skorzystaj z dokumentacji w portalu dokumentacji dotyczącej sekcji dostępnych zdarzeń i konfigurowania systemu.
|
| Adresy email mogą być modyfikowane przez skrypt przygotowujący, więc nie zawsze muszą być wprowadzane. Stałe adresy email mogą dotyczyć powiadomień, które zawsze wysyłane są do stałej listy adresatów. |
Skrypt sprawdzający pozwala na dodatkowe wyfiltrowanie zdarzeń nie tylko na podstawie ich typu (utworzenie, edycja, usunięcie). Edytor pozwala na wprowadzenie notacji JavaScript, która może na podstawie własności pól obiektu zdecydować, czy skrypt ma być wykonany czy nie. Szczegółowe dostępne pola opisane są w dokumentacji dostępnej na portalu dokumentacji. Za pomocą tych reguł możemy np. uzależnić wykonanie skryptu od konkretnego stanu zdarzenia serwisowego np. wysłać email tylko, jeśli zdarzenie zostanie rozwiązane.
| Funkcja sprawdzająca powinna ewaluować do wartości true/false. W przypadku gdy wartość sprawdzenia będzie miała wartość true, to zdarzenie zostanie wykonane. |
Skrypt przygotowujący pozwala na dodatkową modyfikację pól wiadomości. Może być wykorzystany do np. aktualizacji listy adresów email na podstawie danych konkretnego obiektu. Np. możemy wysłać email do osoby, która zgłosiła dane zdarzenie serwisowe, albo wysłać email do osoby, która utworzyła zamówienie, jeśli zamówienie zostało zaakceptowane (definiowane w skrypcie sprawdzającym).
| W celu poznania wszystkich możliwości edytorów oraz dostępnych pól obiektów należy odnieść się do dokumentacji szczegółowej na portalu dokumentacji. |
Szablony zdarzeń
W aplikacji dostępne jest archiwum szablonów zdarzeń, które są dostępne dla użytkownika. Szablony zdarzeń pozwalają na szybkie i łatwe dodanie reguł zdarzeń do systemu. Szablony zawierają gotowe reguły zdarzeń, które można dostosować do własnych potrzeb. Po wybraniu przycisku w edytorze zdarzenia przechodzimy do listy szablonów. Po wybraniu przyciski Wybierz dany szablon zostaje wpisany do pól edytora.
Automatyzacja dla poszczególnych modułów
Widok zdarzeń w sekcji konfiguracyjnej pozwala na przegląd wszystkich zdarzeń zdefiniowanych w systemie przez wszystkich użytkowników. Natomiast dla każdego modułu został udostępniony widok, który pozwala na konfigurację zdarzeń oraz harmonogramów dla danego, określonego modułu funkcjonalnego. Jest to realizowane przez dedykowany przycisk w formie błyskawicy, który jest dostępny w głównych widokach modułów.
Za jego pomocą mamy możliwość dostępu do konfiguracji zdarzeń oraz harmonogramów dla danego modułu. W przypadku modułu 'Zdarzenia' dostępne są wszystkie zdarzenia zdefiniowane w systemie. W przypadku innych modułów dostępne są tylko zdarzenia zdefiniowane dla danego modułu.
| Aby użytkownik miał dostęp do konfiguracji poszczególnych elementów (harmonogramu lub zdarzeń) musi mieć odpowiednie uprawnienia. W przypadku braku uprawnień po wejściu do widoku będzie widoczny tylko element, który jest dostępny dla użytkownika. Oczywiście użytkownik musi również mieć uprawnienia do dostępu do danego modułu funkcjonalnego. |
Po wybraniu akcji automatyzacji wyświetlane jest okno, które pozwala na konfigurację poszczególnych elementów automatyzacji.
W widoku zdarzeń mamy możliwość dodania nowych zdarzeń oraz edycji zdarzeń już zdefiniowanych. Dostępne akcje w widoku zdarzeń to:
-
Dodaj - dodanie nowego zdarzenia
-
Aktywuj - aktywacja zdarzenia, tylko zdarzenie aktywne będzie przetwarzane przez system
-
Deaktywuj - deaktywacja zdarzenia, zdarzenie nie będzie przetwarzane przez system
-
Historia - podgląd historii zdarzeń z danego modułu. Pozwala na przeglądnięcie danych oraz dostępnych parametrów zdarzenia
-
Pomoc - dostęp do pomocy dotyczącej konfiguracji zdarzeń określonego modułu
Podgląd i edycja
Edycja lub utworzenie nowego zdarzenia wyświetla okno konfiguracji zdarzenia. W oknie konfiguracji zdarzenia mamy możliwość określenia podstawowych parametrów zdarzenia, takich jak nazwa, typ zdarzenia, okresowość oraz skrypty sprawdzające i przygotowujące. W przypadku tego widoku nie ma możliwości zmiany obiektu, który dotyczy zdarzenie. Obiekt jest zdefiniowany na poziomie modułu funkcjonalnego.
W widoku dostępny jest dodatkowy przycisk, umiejscowiono obok nazwy obiektu, który wyświetla dodatkowe okno z udostępnionymi przez AMAGE szablonami zdarzeń. Szablony pozwalają na wybranie i wprowadzenie reguł do edytorów skryptów sprawdzających i przygotowujących. Znacznie to ułatwia pierwsze korzystanie z modułu i zdarzeń.
Po zapisaniu zdarzenia, jeśli jest aktywne, następuje automatyczne aktywowanie zdarzeń i system reaguje na nowe rejestracje zdarzeń.
Logowanie operacji i podgląd
Aby umożliwić pełny podgląd zdarzeń, które są rejestrowane w systemie, dostępny jest widok logowania operacji. W historii zdarzeń pojawiają się wszystkie zdarzenia, które zostały zarejestrowane w systemie. Dostępne są informacje o zdarzeniu, dacie utworzenia, dacie przetworzenia oraz dacie ważności. Status zdarzenia określa, czy zdarzenie zostało zignorowane, tzn. nie ma do niego reguł, czy zostało wykonane i jego status końcowy.
W szczegółach zdarzenia dostępne są informacje o zdarzeniu, dacie utworzenia, dacie przetworzenia oraz dacie ważności. W zakładce 'Dane' dostępne są informacje o starym i nowym obiekcie, różnica między nimi oraz dane w formacie JSON. Za pomocą tych danych mamy możliwość przeglądnięcia dostępnych pól w rekordach i odpowiednie ich wykorzystanie w skryptach.
Szczegółowe informacje o działaniu automatów i zdarzeń dostępne są w logach. Za pomocą przeglądarki logów mamy możliwość podglądu operacji automatów i postępu w przetwarzaniu zdarzeń.
Szczegółowy podgląd logów pozwala na przeglądanie logów zdarzeń, które zostały zarejestrowane w systemie.
