Wstęp
Konfiguracja wtyczki jest plikiem JSON o odpowiedniej strukturze, którą można stworzyć na podstawie poniższego opisu. Pisanie JSONa powinno zacząć się od stworzenia obiektu z polem menus będącym listą obiektów menu.
...
- id (string) - identyfikator filtra (unikalny w obrębie widoku)
- name (string) - nazwa filtra wyświetlana jako etykieta pola
- alias (string) - identyfikator parametru wejściowego źródła, z którym ma być powiązany filtr. Przy wywołaniu źródła wartość filtra zostanie wstawiona jako wartość parametru wejściowego o tym podanym identyfikatorze.
- type (string) - typ filtra. Dostępne typy: string, integer, double, boolean, date, list. Po wybraniu odpowiedniego typu, pole nie pozwoli na wprowadzenie błędnej wartości "z ręki" np. nie będzie można wpisać dowolnego ciągu znaków do pola typu integer.
- source (object) - obiekt źródła do pobrania danych, jeżeli typem jest list (opis poniżej).
- defaultValue (string) - domyślna wartość, która zostanie ustawione w filtrze po wejściu w widok i automatycznie wyszukana jeżeli parametr "searchOnLoad" na widoku ustawione jest na true
- dynamicDefaultValue (object) - obiekt źródła do pobrania wartości domyślnej. Konfiguracja jak w filtrze source. Źródło musi zwracać jeden wynikrekord z jedną kolumną.
Info |
---|
Jeżeli nie określono typu filtra, będzie on taki, jak typ odpowiadającego parametru wejściowego w źródle danych dla widoku. UWAGA. Nie wszystkie typy filtrów są obsługiwane przez wszystkie typy źródeł np. w Źródłach danych na podstawie zapytań do bazy nie jest obsługiwany typ date. Przeglądarka wyśle wartość ustawionego filtru w formacie unix time (należy ją samemu skonwertować w zapytaniu SQL). |
...
- id (string) - identyfikator linku (unikalny w obrębie widoku)
- name (string) - nazwa linku
- action (object) - obiekt akcji, która zostanie uruchomiona po kliknięciu w link
- showCondition (object) - obiekt warunku wyświetlania linku
- columnId (string) - id kolumny, która jest użyta w warunku
- operator (string) - operator, którego używamy w porównaniu (możliwe wartości: isempty, isnotempty, eq, noteq, gt, lt, ge, le)
- value (string lub number) - wartość, którą używamy do porównania
- columnValue (string) - id kolumny użytej do porównania (nie można użyć value i columnValue jednocześnie)
group (object) - używane dla wielu warunków (przykłady poniżej)
Code Block title Przykład konfiguracji linku dla pojedynczego warunku wyświetlania { "id":"showCommentsWindowLink", "name":"Zarządzaj komentarzami", "action":{ "type":"showComments" }, "showCondition":{ "columnId":"valuelong", "operator":"gt", "value":100, "columnValue":null, "group":null } }
Code Block title Przykład konfiguracji linku dla wielu warunków wyświetlania { "id":"goToActivityFormLink", "name":"Przejdź do formularza zadania", "action":{ "type":"showActivityForm", "mapping":{ "processId":"processId", "activityId":"activityId" } }, "showCondition":{ "columnId":null, "operator":"and", // możliwe wartości: or lub and "value":null, "columnValue":null, "group":[ { "columnId":"processId", "operator":"isnotempty", "value":null, "columnValue":null, "group":null }, { "columnId":"activityId", "operator":"isnotempty", "value":null, "columnValue":null, "group":null } ] } }
Obiekt podsumowania
- source (object) - obiekt źródła, z którego będą pobierane dane dla ostatniego dodatkowego wiersza
- loadOnce (boolean) - flaga określająca, czy podsumowanie ma być załadowane tylko raz przy wejściu w widok, czy za każdym razem przy zmianie sortowania, filtrów itd.
- inputMappings (list) - lista obiektów mapowania identyfikatorów kolumn z identyfikatorami wejściowymi źródła
- inputId (string) - identyfikator filtra
- alias (string) - identyfikator parametru wejściowego źródła
- outputMappings (list) - lista obiektów mapowania identyfikatorów kolumn z identyfikatorami wyjściowymi źródła
- outputId (string) - identyfikator kolumny, w której mają zostać wyświetlone dane
- alias (string) - identyfikator parametru wyjściowego źródła
...