Interfejs html

Do modułu dołączony jest interfejs html. Interfejs można utworzyć poprzez wywołanie funkcji $report.createOrReplaceHtmlInterface() - zostanie utworzony zestaw obiektów i stron jPalio. Za jego pomocą można zlecić raport, który zostanie wykonany w tle przez zadanie o godzinie określonej we właściwościach raportu. Zadanie trzeba napisać samodzielnie na podstawie przykładu zawartego w interfejsie.

Dodanie raportu polega na dodaniu kilku obiektów wspópracujących z interfejsem html, których szablony są zawarte w interfejsie w katalogu "02 Obiekty referencyjne". Jeden z tych obiektów służy do generowania właściwego raportu.

Obiekt generujący raport jest przypisany do typu raportu określonego w tabeli r_types. Obiekt taki powinien być sparametryzowany. W tabeli r_types istnieją pola param_form_init_object, param_form_display_object, param_form_check_object, param_form_save_object w których system przyjmowania zleceń na raporty przechowuje id obiektów inicjalizujących, wyświetlających, sprawdzających i zapisujących formularz, pozwalający określić parametry raportu. Obiekt zapisujący powinien wywołać funkcję addReport i przekazać do niej tabelę nazw parametrów, zapamiętywanych jako parametry raportu. Parametry te są zapisywane przez addReport w nowym zleceniu na raport danego typu w tabeli r_orders. Przed wykonaniem obiektu raportu parametry są odtwarzane przez funkcję executeReport w kontekście, w którym raport jest wykonywany (ustawiane jako zwykłe parametry jPaliowe). Tabela r_types zawiera także parametry zaczynające się prefiksem default_ określające domyślne warunki wykonywania raportu danego typu. Warunki te są przepisywane do tabeli r_orders wraz z tworzeniem nowego zlecenia na raport. Funkcja wykonująca raport bierze pod uwagę warunki wykonania z r_orders. Nie jest zalecane modyfikowanie warunków wykonania w tabeli r_orders poza interfejsem html. Czas wykonania może być inny niż czas dodania zlecenia na raport, np. można umożliwić ciągłe przyjmowanie zleceń na raporty, ale wykonywać je lub kompresować za pomocą zadania w czasie mniejszego obciążenia.

Po utworzeniu odpowiednich obiektów dla raportu należy w interfejsie html dodać nowy typ raportu, przypisując do niego te obiekty. Aby utworzone obiekty były widoczne w interfejsie do zarządzania raportami ich nazwy muszą zaczynać się ciągiem "Rep obj ". Po poprawnym skonfigurowaniu typu raportu można dodawać zlecenia wykonania raportów tego typu.

Obiekty inicjalizacji i sprawdzania nie są wymagane, interfejs zakłada wtedy, że dane w formularzu zamówienia są poprawne i zawsze po submicie formularza zlecenia wywołuje obiekt zapisu zlecenia.

Przepływ sterowania pomiędzy obiektami służącymi do zlecania raportów prezentuje poniższy diagram.