FormService

FormService allows you to perform basic operations on the form. It has the following functions:

refresh - odświeża formularz aktualnie wykonywanego zadania poprzez odświeżenie okna przeglądarki.
- Parametry funkcji: brak
- Rezultat funkcji: brak

save - zapisuje zmienne formularza (zmienne do edycji, zmienne ukryte, edytowalne tabele dynamiczne). Umożliwia wykonanie określonych akcji po zakończeniu zapisu w zależności od statusu odpowiedzi.

Zapis formularza jest wywoływany asynchronicznie.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

config

Object

{ }

Konfiguracja zapisu formularza. Obiekt posiada następujące właściwości:

- submitMessage (Typ String)

Treść wiadomości widocznej podczas trwania zapisu formularza (domyślnie: '')

- scope (Typ Object)

Scope dla opcjonalnych funkcji wykonywanych po zapisie określonych we właściwościach success i failure (domyślnie: window)

- success (Typ Function)

Opcjonalna funkcja wykonywana po zapisie zakończonym sukcesem (domyślnie: null)

- successParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości success (domyślnie: [form, action] - standardowy rezultat funkcji success dla wysyłania formy)

- failure (Typ Function)

Opcjonalna funkcja wykonywana po zapisie zakończonym niepowodzeniem (domyślnie: null)

- failureParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości failure (domyślnie: [form, action] - standardowy rezultat funkcji failure dla wysyłania formy)

- actionInProgressMessage (Typ String)

Określa wiadomość, jaka ma zostać wyświetlona w ostrzeżeniu, gdy nie można zapisać formularza, gdyż wykonywane są dowolne akcje, na których zakończenie należy poczekać (domyślnie: Form action in progress)

Rezultat funkcji: brak

accept - akceptuje zadanie symulując kliknięcie w wybrany przycisk akceptacji.

Akceptacja formularza jest wywoływana asynchronicznie. Opcjonalne funkcje są wywoływane po operacji wysłania danych z formularza do serwera.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

config

Object

{ }

Konfiguracja akceptacji formularza. Obiekt posiada następujące właściwości:

- actionName (Typ String)

Parametr konfiguracyjny actionName z definicji przycisku akceptacji (ACTION_ACCEPT_BUTTON) (domyślnie: null)

- scope (Typ Object)

Scope dla opcjonalnych funkcji wykonywanych po zapisie określonych we właściwościach success i failure (domyślnie: window)

- success (Typ Function)

Opcjonalna funkcja wykonywana po zapisie zakończonym sukcesem (domyślnie: null)

- successParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości success (domyślnie: [form, action] - standardowy rezultat funkcji success dla wysyłania formy)

- failure (Typ Function)

Opcjonalna funkcja wykonywana po zapisie zakończonym niepowodzeniem (domyślnie: null)

- failureParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości failure (domyślnie: [form, action] - standardowy rezultat funkcji failure dla wysyłania formy)

- directAccept (Typ Boolean)

Określa, czy przejść do bezpośredniej akceptacji zadania, tj. z pominięciem sprawdzenia wykonywania AUTO_UPDATE, jsAction, ADDITIONAL_JS_CHECK (domyślnie: false)

Rezultat funkcji: brak

mask - maskuje formularz uniemożliwiając klikanie i wypełnianie pól.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  message String null Informacja wyświetlona na środku maski
- Rezultat funkcji: brak

unmask - usuwa maskę formularza umożliwiając klikanie i wypełnianie pól.
- Parametry funkcji: brak
- Rezultat funkcji: brak

refreshDocuments (od wersji 3.2.59) - odświeża dokumenty na formularzu bez przeładowania strony. Odświeżana jest tabela z dokumentami w zakładce Dokumenty, liczba dokumentów w tytule zakładki Dokumenty oraz widok dokumentów.
- Parametry funkcji: brak
- Rezultat funkcji: brak

getValues - pobiera obiekt zawierający wszystkie wartości zmiennych z formularza w formie pary <klucz, wartość> postaci <id_zmiennej, wartosc_zmiennej>.
- Parametry funkcji: brak
- Rezultat funkcji:
  
  Typ Opis
  Object Obiekt zawierający wartości zmiennych

getVariablesInfo - pobiera obiekt zawierający informacje o wszystkich zmiennych z formularza w formie pary <klucz, wartość> postaci <id_zmiennej, informacje_o_zmiennej>.

Parametry funkcji: brak

Rezultat funkcji:

Typ

Opis

Object

Obiekt zawierający informacje o zmiennych formularza. Obiekt posiada następujące właściwości:

- editable (Typ Boolean)

Informuje, czy zmienna jest edytowalna

- hidden (Typ Boolean)

Informuje, czy zmienna jest ukryta

- readOnly (Typ Boolean)

Informuje, czy zmienna jest tylko do odczytu

- inVariableSet (Typ Boolean)

Informuje, cze zmienna znajduje się w tabeli dynamicznej

showAddDocumentsFromDiscForm - wyświetla okno podłączania dokumentów z dysku do procesu (taki sam panel, jak w zakładce Dokumenty procesu).
- Parametry funkcji: brak
- Rezultat funkcji: brak

showAddDocumentsFromArchiveForm - wyświetla okno podłączania dokumentów z archiwum do procesu (taki sam panel, jak w zakładce Dokumenty procesu).
- Parametry funkcji: brak
- Rezultat funkcji: brak

showAddDocumentsFromTemplateForm - wyświetla okno podłączania dokumentów za pomocą szablonu do procesu (taki sam panel, jak w zakładce Dokumenty procesu).
- Parametry funkcji: brak
- Rezultat funkcji: brak

validateComboBoxes - dokonuje walidacji wszystkich list rozwijanych na formularzu (data chooser, lista użytkowników, lista wartości itd.) oraz zaznacza te listy, które posiadają niepoprawne wartości (także w tabelach dynamicznych). Umożliwia wykonanie określonych akcji po zakończeniu walidacji w zależności od statusu odpowiedzi.

Walidacja list rozwijanych jest wywoływana asynchronicznie.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

config

Object

{ }

Konfiguracja walidacji list rozwijanych. Obiekt posiada następujące właściwości:

checkForm (Typ Boolean)

Określa, czy sprawdzać wymagalność oraz restrykcje na wyrażenia regularne w listach rozwijanych (domyślnie: false)

- submitMessage (Typ String)

Treść wiadomości widocznej podczas trwania walidacji list rozwijanych (domyślnie: '')

- scope (Typ Object)

Scope dla opcjonalnych funkcji wykonywanych po walidacji określonych we właściwościach success i failure (domyślnie: window)

- success (Typ Function)

Opcjonalna funkcja wykonywana po walidacji zakończonej sukcesem (domyślnie: null)

- successParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości success (domyślnie: [form, action] - standardowy rezultat funkcji success dla wysyłania formy)

- failure (Typ Function)

Opcjonalna funkcja wykonywana po walidacji zakończonej niepowodzeniem (domyślnie: null)

- failureParams (Typ Object[])

Tablica określająca parametry przekazywane do funkcji określonej we właściwości failure (domyślnie: [form, action] - standardowy rezultat funkcji failure dla wysyłania formy)

Rezultat funkcji: brak

insertHtml - wstawia fragment kodu HTML w dowolne miejsce na formularzu.

Parametry funkcji:

Nazwa	Typ	Wartość domyślna	Opis
html	String	null	Fragment kodu HTML. W celu upodobnienia wstawionego fragmentu kodu HTML do systemu można wykorzystać następujące klasy CSS: suncode-container-underline (dodaje podkreślenie), suncode-form-label (styl dla etykiety pola), suncode-form-grey-panel (nadaje kolor tła zgodny z formularzem, klasę CSS można dodawać tylko do komponentów div). Dodatkowo, jeżeli chcemy umieścić wstawiany kod po lewej stronie formularza, należy wykorzystać jeden z następujących styli: text-align: left, float: left. Analogicznie kod HTML umieszczamy po prawej za pomocą tych samych właściwości, lecz z wartością right. Dodatkowo możemy wyrównywać komponenty za pomocą styli margin-left: Xpx i margin-right: Xpx. Kod HTML możemy wyśrodkować za pomocą połączenia styli margin-left: auto i margin-right: 0.
variableId	String	null	Identyfikator zmiennej formularza (zmiennej procesu) względem której następuje wstawienie fragmentu kodu HTML. Może to być także identyfikator tabeli dynamicznej. Jeżeli parametr jest pusty lub na formularzu nie istnieje zmienna o podanym identyfikatorze, to fragment kodu HTML jest wstawiany na początku/na końcu formularza (w zależności od parametru before
before	Boolean	false	Informuje, czy fragment kodu HTML powinien zostać wstawiony przed podaną zmienną formularza/tabelą dynamiczną. Jeżeli parametr variableId jest pusty lub na formularzu nie istnieje zmienna o podanym identyfikatorze, to fragment kodu jest wstawiany na początku/na końcu formularza, w zależności od przyjętej wartości parametru
sameLine	Boolean	false	Informuje, czy fragment kodu HTML powinien zostać wstawiony w tym samym wierszu, co podana zmienna formularza/tabela dynamiczna. Jeżeli parametr variableId jest pusty lub na formularzu nie istnieje zmienna o podanym identyfikatorze, to wartość parametru nie ma znaczenia

Rezultat funkcji: brak

hideSaveFormButton - ukrywa przycisk zapisu formularza.
- Parametry funkcji: brak
- Rezultat funkcji: brak

showSaveFormButton - pokazuje przycisk zapisu formularza.
- Parametry funkcji: brak
- Rezultat funkcji: brak

hideShowCommentButton - (od 3.1.15) ukrywa przycisk dodania komentarza.
- Parametry funkcji: brak
- Rezultat funkcji: brak

showShowCommentButton - (od 3.1.15) pokazuje przycisk dodania komentarza.
- Parametry funkcji: brak
- Rezultat funkcji: brak

hideButton - (3.1.13) ukrywa przyciski o podanych nazwach akcji

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

actionName

String

null

Nazwa akcji (actionName) przycisku.

Możliwe jest ukrycie wielu przycisków na raz wywołaniem - wystarczy dodać następne parametry:

formService.hideButton('przyciska', 'przyciskb');

Rezultat funkcji: brak

showButton - (3.1.13) pokazuje przyciski o podanych nazwach akcji

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

actionName

String

null

Nazwa akcji (actionName) przycisku.

Możliwe jest pokazanie wielu przycisków na raz wywołaniem - wystarczy dodać następne parametry:

formService.showButton('przyciska', 'przyciskb');

Rezultat funkcji: brak

hideLabel - (3.1.24) ukrywa etykiety formularza o podanych identyfikatorach

Wtyczka PWE od wersji 2.1-SNAPSHOT z dnia 11.12.2015 nie zmienia identyfikatorów etykiet formularza. Wcześniejsze wersje generują nowe identyfikatory podczas eksportu do nowej wersji pakietu.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

actionName

String

null

Identyfikator etykiety.

Możliwe jest ukrycie wielu etykiet na raz wywołaniem - wystarczy dodać następne parametry:

formService.hideLabel('etykietaa', 'etykietab');

Rezultat funkcji: brak

showLabel - (3.1.24) pokazuje etykiety formularza o podanych identyfikatorach

Wtyczka PWE od wersji 2.1-SNAPSHOT z dnia 11.12.2015 nie zmienia identyfikatorów etykiet formularza. Wcześniejsze wersje generują nowe identyfikatory podczas eksportu do nowej wersji pakietu.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

actionName

String

null

Identyfikator etykiety.

Możliwe jest pokazanie wielu etykiet na raz wywołaniem - wystarczy dodać następne parametry:

formService.showLabel('etykietaa', 'etykietab');

Rezultat funkcji: brak

blockAcceptance - blokuje możliwość akceptacji zadania

Po wywołaniu funkcji zostaje zablokowana możliwość akceptacji formularza. Przyciski akceptacji zostają wyszarzone (ustawione zostaje disabled: false), a przy akceptacji przez JavaScript, wyświetlany zostaje komunikat, iż nie można zaakceptować zadania. Mechanizm nie blokuje akceptacji bezpośredniej. Mechanizm jest zaimplementowany w JavaScripcie - nie ma wpływu na akceptację po stronie serwera.
Liczba blokowań akceptacji jest zliczana, co oznacza, iż musi być tyle samo wywołań funkcji do odblokowania formularza, co blokowań.
- Parametry funkcji: brak
- Rezultat funkcji: brak
unblockAcceptance - odblokowuje możliwość akceptacji zadania
- Parametry funkcji: brak
- Rezultat funkcji: brak
isAcceptanceBlocked - sprawdza, czy akceptacja formularza jest zablokowana
- Parametry funkcji: brak
- Rezultat funkcji: true/false jeżeli akceptacja formularza jest zablokowana/odblokowana