FormService

Serwis FormService pozwala na wykonywanie podstawowych operacji na formularzu. Posiada następujące funkcje:

• 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)

    
    

  • 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

• 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