Page History

...

1. addField(Object / parameterId, position) - dodaje pole parametru na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji
2. removeField(parameterId) - usuwa pole parametru
3. hide (parameterId) - ukrywa parametr
4. show(parameterId) - pokazuje parametr
5. focusField(parameterId) - ustawia kursor w polu parametru
6. addLabel("Label text", position) - dodaje etykietę na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji
7. addCheckbox(Object, position) - dodaje checkbox na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
   1. id - identyfikator checkbox'a typu String, możliwe jest ustawienie wartości checkbox'a za pomocą identyfikatora
   2. name - nazwa pola
   3. description - opis pola
   4. bindedFieldId - identyfikator parametru typu logicznego, jego wartość odzwierciedla, czy checkbox jest zaznaczony, zmiana zaznaczenia checkbox'a wpływa na wartość powiązanego pola
8. addCombobox(Object, position) - dodaje listę rozwijaną na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
   
   1. id - identyfikator parametru typu String, który będzie w formie listy rozwijanej, jeśli id nie jest podane, parametr nie istnieje lub zmienna jest innego typu, niż string, to do formularza parametrów jest dodawana niezależna lista rozwijana
   2. name - etykieta pola
   3. description - opis pola
   4. value - wartość początkowa
   5. optional - informuje, czy wymagane jest podanie wartości (domyślnie: false)
   6. forceSelection - informuje, że parametr może przyjmować tylko wartości znajdujące się na liście (domyślnie: true)
   7. remote - konfiguracja pobierania danych z serwera, jej brak informuje, że dana lista jest statyczną listą (domyślnie: null), zawiera takie właściwości jak:
      1. url - url zwracający dane z serwera dla dynamnicznej listy rozwijanej, może być także w postaci funkcji, która przyjmuje następujące parametry:
         
         1. options - dodatkowe parametry przekazywane do funkcji
            1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
      2. fields - pola, jakie są zwracane z serwera, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
         1. name - nazwa pola
         2. type - typ pola (string, boolean, integer, float, date)
      3. remoteSort - informuje, czy sortowanie ma się odbywać po stronie serwera, czy po stronie przeglądarki (domyslnie: false - po stronie przeglądarki)
      4. pageSize - rozmiar strony (domyślnie: 25)
      Serwer musi zwrócić obiekt json z polami:
      1. total - całkowita liczba wyników,
      2. data - pobrane dane z uwzględnieniem stronnicowania
   8. values - lista wartości dla statycznej listy rozwijanej, właściwość jest tablicą obiektów, z których każdy posiada następujące własności
      1. id - identyfikator wartości
      2. display - nazwa wartości
      3. description - opis wartości
   9. valueField - nazwa pola, którego wartość ma być ustawiana jako wartość parametru
   10. displayField - nazwa pola, którego wartość jest wyświetlana na liście
   11. template - szablon opisujący sposób wyświetlania wartości na liście, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
       1. label - etykieta dla pola
       2. field - nazwa pola
   12. sort - umozliwia określenie sortowania danych z serwera, właściwość jest tablicą, który posiada obiekty o następujących własnościach:
       1. property - nazwa pola, po którym występuje sortowanie
       2. direction - kierunek sortowania (ASC/DESC)
   13. listeners - obiekt zawierający zdarzenia, obsługowane są następujące zdarzenia
       
       1. change - funkcja wykonywana po wybraniu wartości z listy, przyjmuje następujące parametry:
          1. value - wartość pola parametru
          2. options - dodatkowe parametry przekazywane do funkcji
             1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
       2. blur - funkcja wywoływana po wyjściu z pola, przyjmuje następujące parametry:
          1. value - wartość pola parametru
          2. options - dodatkowe parametry przekazywane do funkcji
             1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
9. getFieldPosition(parameterId) - zwraca pozycję pola parametru, jeżeli parametr znajduje się w tabeli, to zwracana jest pozycja pola parametru tabeli
10. getValue(parameterId, asString) - zwraca wartość pola parametru, wartość może być zwrócona w postaci string (asString=true)
11. setValue(parameterId, value) - ustawia wartość pola parametru
12. addButton(Object, position) - dodaje przycisk na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
    
    1. text - teskt przycisku
    2. iconCls - systemowa klasa css dla ikony przycisku
    3. tooltip  - tooltip przycisku
    4. handler - funkcja wykonywana po kliknięciu w przycisk
    5. scope - scope dla funkcji wykonywanej po kliknięciu w przycisk, domyślnie: window
13. addFieldToArray(parameterId) - dodaje nowe pole na ostatniej pozycji w parametrze tabelarycznym, pole nie jest dodawane do parametru tabelarycznego, który znajduje się w tabeli
14. removeFieldFromArray(parameterId, position) - usuwa pole z danej pozycji z parametru tabelarycznego, pole nie jest usuwane z parametru tabelarycznego, który znajduje się w tabeli
15. setFieldValueInArray(parameterId, position, value) - ustawia wartość pola na danej pozycji w parametrze tabelarycznym
16. getArraySize(parameterId) - zwraca ilość pól w parametrze tabelarycznym lub 0, jeśli pole nie jest parametrem tabelarycznym
17. resetArray(parameterId) - usuwa pola wiersze (poza pierwszym) z parametru tabelarycznego i czyści wartość pierwszego pola, pola nie są usuwane z parametru tabelarycznego, który znajduje się w tabeli
18. removeLastArrayFields(parameterId, amount) - usuwa określoną ilość pól wierszy z parametru tabelarycznego i czyści wartość pierwszego pola, pola nie są usuwane z parametru tabelarycznego, który znajduje się w tabeli
19. addDataChooserMapping(Object) - dodaje mapping data choose'a, ma znaczenie tylko dla komponentu data chooser'a, obiektmappingu zawiera następujące właściwości:
    1. id - id mappingu
    2. description - opis mappingu
    3. variableId - id zmiennej procesu, na którą jest mapowana wybrana wartość w data chooser
    4. name - tekst wyświetlany dla mappingu podczas prezentacji rezultatów data chooser'a na formularzu zadania
    5. hidden - informuje, czy mapping ma być ukryty na formularzu zadania
    6. verify - informuje, czy mapping ma być walidowany na formularzu zadania
    7. readOnly - informuje, które wartości nie mogą być edytowane w danym mappingu, akceptowane wartości to:
       1. true/false - zmienna typu boolean, informuje, że żadna z wartości mappingu nie może być edytowana
       2. string - zmienna typu string, informuje, która z wartości mappingu nie może być edytowana (akceptowane wartości to: id, description, variableId, name, hidden, verify)
       3. array - zmienna tabelaryczna, informuje, które z wartości mappingu nie mogą być edytowane (akceptowane wartości to: id, description, variableId, name, hidden, verify)
20. resetDataChooserMappings() - usuwa wszystkie mappingi data choose'a, ma znaczenie tylko dla komponentu data chooser'a
21. addTable(Object, position) - dodaje tabelę na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, obiekt definicji tabeli zawiera następujące właściwości:
    
    1. id - identyfikator tabeli, który pozwala ukrywać/pokazywać/usuwać pole
    2. name - nazwa tabeli
    3. description - opis tabeli
    4. hidden - określa, czy tabela ma zostać ukryta
    5. blocked - określa, czy pojawią się przyciski dodawania/usuwania wierszy w utworzonej tabeli, domyślnie: false
    6. notEmpty - określa, czy wszystkie pola w tabeli muszą mieć dodany przynajmniej jeden wiersz
       Metoda zwraca API tabeli, które posiada następujące operacje:
       1. addField(Object / parameterId, position) - dodaje pole parametru tabelarycznego na określonej pozycji, parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji
       2. addCombobox(Object, position) - dodale listę rozwijaną w formie tabeli na określonej pozycji, parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, definicja listy rozwijanej - patrz punkt 8.
       3. addRow([ Object ], position) - dodaje nowy wiersz do tabeli na określonej pozycji, parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, pierwszy parametr jest opcjonalny i zawiera wartości poszczególnych pól w tabeli, definicja obiektu jednej wartości jest następująca:
          1. id - identyfikator pola tablicowego
          2. value - wartość pola
       4. removeRow(position) - usuwa wiersz tabeli na określonej pozycji, parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest usuwany z ostatniej
       5. clear - czyści zawartość tabeli
22. addRow(position) - dodaje pusty wiersz na pola parametrów ułożone horyzontalnie na określonej pozycji, parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, metoda zwraca API dla wiersza, które jest tożsame z API V2 (dodawanie kolejnych pól realizujemy więc metodą addField z pozycji 1.)
23. disable(parameterId) - blokuje pole parametru
24. enable(parameterId) - odblokowuje pole parametru
25. resetValue(parameterId, silent) - usuwa wartość pola parametru, jeżeli silent ma wartość true, to po zmianie wartości nie jest wykonywana funkcja onChange
26. hasVariableValue(parameterId, position) - informuje, czy pole parametru posiada zmienną jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
27. hasVariableArrayValue(parameterId, position) - informuje, czy pole parametru posiada zmienną tabelaryczną jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
28. hasFunctionValue(parameterId, position) - informuje, czy pole parametru posiada funkcję jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
29. setNotEmpty(parameterId, notEmpty) - pozwala ustawić wartość właściwości notEmpty
30. setErrorHandling(Object) - pozwala ustawić obsługę błędów aplikacji systemowej, funkcja dostępna tylko dla komponentów aplikacji, obiekt obsługi błedu przyjmuje następujące właściwości:
    1. type - typu string, doopuszczalne wartości to STOP i CONTINUE
    2. comment - typu string lub obiekt pobrany bezpośrednio jako wartość innego parametru
    3. userMessage - typu string lub obiekt pobrany bezpośrednio jako wartość innego parametru
    4. addErrorToComment - typu boolean lub obiekt pobrany bezpośrednio jako wartość innego parametru
    5. setters - obiekt zawierający następujące właściwości:
       1. variables - tablica identyfikatorów zmiennych, wartości typu string lub obiekt pobrany bezpośrednio jako wartość innego parametru
       2. values - tablica wartości zmiennych, wartości typu string lub obiekt pobrany bezpośrednio jako wartość innego parametru
31. block(parameterId) - blokuje możliwość zmiany rozmiaru pola tablicowego i tabelatycznego (ukrywa przyciski dodawania/usuwania pól)
32. unblock(parameterId) - odblokowuje możliwość zmiany rozmiaru pola tablicowego i tabelatycznego (pokazuje przyciski dodawania/usuwania pól)
33. addEmptyLine(position) - dodaje pustą linię na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji
34. addFieldSet(Object, position) - dodaje zgrupowany zestaw pól na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, obiekt definicji zgrupowanego zestawu pól zawiera następujące właściwości:
    1. id - identyfikator zgrupowanego zestawu pól
    2. title - tytuł zgrupowanego zestawu pól
    3. collapsible - określa, czy zgrupowany zestaw pól może być zwijany i rozwijany, domyślnie: false
    4. collapsed - określa, czy zgrupowany zestaw pól jest początkowo zwinięty, domyślnie: false
35. collapseFieldSet(id) - zwija zgrupowany zestaw pól
36. expandFieldSet(id) - rozwija zgrupowany zestaw pól
37. toggleFieldSet(id) - zmienia stan zgrupowanego zestawu pól w zależności od tego, czy jest on zwinięty/rozwinięty
38. addColorPicker(Object / parameterId, position) - dodaje paletę kolorów na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), parametr position jest opcjonalny, jeśli nie jest podany, to obiekt jest dodawany na ostatniej pozycji, paleta kolorów może zostać jedynie dodana do parametrów typu STRING
39. isDataChooserInTable(id) - zwraca true, jeśli zmienna o podanym identyfikatorze jest dynamiczną listą i jest umiejscowiona w tabeli, w przeciwnym razie zwraca false, możliwe jest pominięcie id, jeżeli jesteśmy aktualnie w edycji zmiennej procesu typu dynamiczna lista
40. activateRebuildParameters() - aktywuje przebudowanie dynamicznego formularza parametrów po wystąpieniu następujących zdarzeń
    1. zmiana położenia zmiennej procesu typu dynamiczna lista
41. deactivateRebuildParameters() - dezaktywuje przebudowanie dynamicznego formularza parametrów po wystąpieniu następujących zdarzeń
    1. zmiana położenia zmiennej procesu typu dynamiczna lista
42. showMessage(Object) - wyświetla wiadomość w pop-up'ie z przyciskiem OK, obiekt konfiguracji zawiera następujące właściwości:
    1. message - treść wiadomości
    2. title - tytuł okna
43. getAllTasks - zwraca listę wszystkich zadań, które aktualnie występują w procesie. Obiekt każdego zadania na liście posiada następujące właściwości:
    1. id - identyfikator definicji zadania
    2. name - nazwa zadania
44. getAllRoles - zwraca listę wszystkich ról, które aktualnie występują w procesie. Obiekt każdej roli na liście posiada następujące właściwości:
    1. id - identyfikator roli
    2. name - nazwa roli
45. getAllGlobalTables - zwraca listę wszystkich globalnych tabel dynamicznych, które aktualnie występują w procesie. Obiekt każdej tabeli na liście posiada następujące właściwości:
    1. id - identyfikator tabeli
    2. name - nazwa (tytuł) tabeli
    3. columns - lista identyfikatorów zmiennych procesu, które zostały użyte jako kolumny tabeli
46. getGlobalTable(tableId) - zwraca definicję globalnej tabeli dynamicznej lub null, jeśli nie istnieje tabela o podanym identyfikatorze. Obiekt tabeli posiada następujące właściwości:
    1. id - identyfikator tabeli
    2. name - nazwa (tytuł) tabeli
    3. columns - lista identyfikatorów zmiennych procesu, które zostały użyte jako kolumny tabeli
47. showHint(parameterId, hint, type) - wyświetla podpowiedź pod danym parametrem/tabelą. Funkcja przyjmuje następujące parametry:
    1. parameterId - identyfikator parametru, może być też identyfikatorem tabeli
    2. hint - treść podpowiedzi
    3. type - typ podpowiedzi (odpowiada za kolor tekstu), dostępne wartości to:
       1. INFO - czarny
       2. SUCCESS - zielony
       3. ERROR - czerwony
48. showHintInArray(parameterId, position, hint, type) - wyświetla podpowiedź pod danym polem w parametrze tabelarycznym. Funkcja przyjmuje następujące parametry:
    1. parameterId - identyfikator parametru, może być też identyfikatorem tabeli
    2. position - indeks parametru w tabeli
    3. hint - treść podpowiedzi
    4. type - typ podpowiedzi (odpowiada za kolor tekstu), dostępne wartości to:
       1. INFO - czarny
       2. SUCCESS - zielony
       3. ERROR - czerwony
49. hideHint(parameterId) - ukrywa podpowiedź pod danym parametrem/tabelą
50. hideHintInArray(parameterId, position) - ukrywa podpowiedź pod danym polem w parametrze tabelarycznym

Combobox API:

1. addValues(Object/Array) - dodaje do listy rozwijanej kolejne pozycje (patrz values w metodzie addCombobox), dotyczy tylko tych list rozwijanych, które działają lokalnie
2. setValues(Object/Array) - zmienia pozycje na liście rozwijanej (patrz values w metodzie addCombobox), dotyczy tylko tych list rozwijanych, które działają lokalnie
3. setUrl(url) - ustawia url zwracający dane z serwera, dotyczy tylko tych list rozwijanych, które pobierają dane z serwera, wartość parametru url musi być typu String
4. setForceSelection(forceSelection) - ustawia wartość pola forceSelection

...

1. getFieldPosition(parameterId) - zwraca pozycję pola parametru, jeżeli parametr znajduje się w tabeli, to zwracana jest pozycja pola parametru tabeli
2. getValue(parameterId, asString) - zwraca wartość pola parametru, wartość może być zwrócona w postaci string (asString=true)
3. getArraySize(parameterId) - zwraca ilość pól w parametrze tabelarycznym lub 0, jeśli pole nie jest parametrem tabelarycznym
4. hasVariableValue(parameterId, position) - informuje, czy pole parametru posiada zmienną jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
5. hasVariableArrayValue(parameterId, position) - informuje, czy pole parametru posiada zmienną tabalaryczną jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
6. hasFunctionValue(parameterId, position) - informuje, czy pole parametru posiada funkcję jako wartość, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to sprawdza wartość tylko polu na konkretnej pozycji, w przeciwnym przypadku sprawdzane są wszystkie aktualnie dodane pola
7. getFunctionReturnType(parameterId, position) - zwraca typ wartości zwracanej przez funkcję podanej jako wartość danego parametru, parametr position jest uwzględniany dla pól tablicowych, jeżeli jest podany, to zwraca typ tylko dla pola na konkretnej pozycji, w przeciwnym przypadku zwracana jest tablica typów
8. getVariableType(parameterId, position) - zwraca typ zmiennej podanej jako wartość danego parametru, parametr position jest uwzględniany dla pól tablicowych, jeżeli jest podany, to zwraca typ tylko dla pola na konkretnej pozycji, w przeciwnym przypadku zwracana jest tablica typów
9. markError(parameterId, position) - zaznacza pole jako błędne, parametr position jest uwzględniany dla tabeli i pól tablicowych, jeżeli jest podany, to zaznacza pola na konkretnej pozycji, w przeciwnym przypadku zaznaczane są wszystkie aktualnie dodane pola
10. showErrorMessage(errorMessage) - wyświetla komunikat błędu
11. showHint(parameterId, hint, type) - wyświetla podpowiedź pod danym parametrem/tabelą. Funkcja przyjmuje następujące parametry:
    1. parameterId - identyfikator parametru, może być też identyfikatorem tabeli
    2. hint - treść podpowiedzi
    3. type - typ podpowiedzi (odpowiada za kolor tekstu), dostępne wartości to:
       1. INFO - czarny
       2. SUCCESS - zielony
       3. ERROR - czerwony
12. showHintInArray(parameterId, position, hint, type) - wyświetla podpowiedź pod danym polem w parametrze tabelarycznym. Funkcja przyjmuje następujące parametry:
    1. parameterId - identyfikator parametru, może być też identyfikatorem tabeli
    2. position - indeks parametru w tabeli
    3. hint - treść podpowiedzi
    4. type - typ podpowiedzi (odpowiada za kolor tekstu), dostępne wartości to:
       1. INFO - czarny
       2. SUCCESS - zielony
       3. ERROR - czerwony
13. hideHint(parameterId) - ukrywa podpowiedź pod danym parametrem/tabelą
14. hideHintInArray(parameterId, position) - ukrywa podpowiedź pod danym polem w parametrze tabelarycznym