Akcje

Sekcja Akcje

Sekcja Akcje umożliwia dodanie do wniosku akcji dla wybranych komponentów inicjujących zdarzenia.

Aby zdefiniować akcję na wniosku należy w pierwszej kolejności dodać w formularzu komponent, dla którego chcemy akcję zdefiniować (np. Trigger) oraz komponent, którego akcja dotyczy (np. Popup).

Ilustracja 1. Sekcja ze zdefiniowanymi akcjami

Dodanie akcji

Po kliknięciu przycisku Dodaj akcję na górze sekcji nad pozostałymi akcjami (o ile już jakieś były na wniosku), zostaje dodany pusty wiersz, w którym wybieramy najpierw źródło akcji w polu Wybierz źródło akcji. Na liście dostępne będą tylko te komponenty wniosku, dla których można zdefiniować akcję.

Ilustracja 2. Wiersz definiowania nowej akcji

Ilustracja 2. Wiersz definiowania nowej akcji

Ilustracja 3. Wiersz przykładowej akcji SHOW_POPUP po kliknięciu checkboxa

Definiowanie zdarzenia dla przycisku Dalej

Podczas definiowania akcji na kliknięcie przycisku Dalej należy pamiętać, aby zapewnić także akcję, która wykona się, gdy podany dla akcji warunek nie zostanie spełniony, ponieważ inaczej użytkownik nie mógłby przejść na kolejną stronę przy niespełnionym warunku dla zdarzenia. Wystarczy dodać akcję z odwrotnym warunkiem dla akcji FORWARD_PAGE.

Ilustracja 4. Przykład akcji otwarcia popupa dla klikniętego przycisku Dalej na Page1

Ilustracja 5. Przykład akcji dla odwrotnego warunku pozwalającego przejść dalej w standardowy sposób ze strony Page1

Wniosek demo: demoPopup

Definiowanie akcji dla komponentu Oświadczenia

Dla Oświadczenia - Statements w konkretnym oświadczeniu należy w actionBindings dodać zdarzenie (Event) równe EDIT. Oświadczenie, które będzie takie zdarzenie miało zdefiniowane będzie miało wyświetloną specjalną opcję edycji danych, której kliknięcie wyświetli popup.

Ilustracja 6. Przykład oświadczenia ze zdefiniowaną akcją

Wniosek demo: demoStatementsPopup

Zdefiniowane zdarzenia dla Slidera

Slider jest w stanie obsłużyć zdarzenie zdefiniowane w walidatorze (musi on w komunikacie błędu wysłać akcję EMIT_EVENT). Podczas dodawania akcji należy w liście rozwijanej akcji wybrać pozycję z listy dopuszczalnych zdarzeń, która z kolei jest zdefiniowana w implementacji walidatora.

Zdefiniowane zdarzenia dla pomocy kontekstowej Pola tekstowego i Pola wyboru wartości z listy

Dla komponentów: Pole tekstowe - TextField oraz Pole wyboru wartości z listy - Combobox zawierających etykietę (label) można zdefiniować akcję otwarcia popupa na kliknięcie w przycisk pomocy kontekstowej. Przed zdefiniowaniem akcji należy dodać do komponentu pomoc kontekstową (tooltip).

Ilustracja 7. Przykład akcji zdefiniowanej dla tooltipa komponentu Pole tekstowe

Wnioski demo: demoTextField, demoCombobox, demoPopup

PageService jako akcja

Jeśli na wniosku zdefiniujemy PageService to możemy go wybrać w sekcji Właściwości - po jego wybraniu możliwe jest wybranie akcji CALL.

Akcja przekierowania na zdefiniowany returnUrl

Istnieje możliwość podpięcia akcji (np. na kliknięcie Triggera), która uruchomi przekierowanie na returnUrl (REDIRECT_TO_RETURN_URL), którego wartość pobierana jest ze zmiennej sesyjnej o takiej nazwie (zmienna sesyjna returnUrl musi być exposed).

Akcja przekierowania na zdefiniowany URL

Istnieje możliwość podpięcia akcji (np. na kliknięcie Triggera), która uruchomi przekierowanie na podany przez użytkownika adres URL, którego wartość jest ustalana w momencie definiowania akcji - REDIRECT.

Akcja wykona się nawet jeżeli jakiś walidator podświetli jakieś dane jako niewłaściwe.

Akcja parkowania po wejściu na konkretną stronę

Istnieje możliwość zdefiniowania akcji parkowania po wejściu na konkretną stronę: PARK_FORM_WITH_PROVIDED_HASH. Należy wtedy określić akcję dla komponentu strony (np. ze zdarzeniem ON_PAGE_ENTER). Aby mechanizm parkowania zadziałał, należy pamiętać o ustawieniu wartości zmiennej sesyjnej hashForUnparking, która jest potrzebna do odparkowania wniosku.

Akcja wejścia na nowy wniosek zasilonym modelem danych z podanego procesu

Istnieje możliwość zdefiniowania akcji wejścia na nowy wniosek, który na start zostanie zasilony modelem danych z konkretnego procesu. Należy wtedy określić akcję START_FORM_BASED_ON_PROCESS na komponencie Trigger. W ramach tej akcji należy skonfigurować nazwę wniosku (formName) oraz processInstanceId, z którego zostanie pobrany model. Pamiętaj, że processInstanceId musi być wskazaniem na zmienną sesyjną, ponieważ tylko zmienna sesyjna jest obsługiwana. Aktualnie konfiguracja akcji nie jest możliwa z poziomu Designera, należy wykorzystać zakładkę "Źródło". Poniżej przykładowa konfiguracja.

<formAction id="5392a77a-5b2b-4664-b918-b2b65004736f" handler="START_FORM_BASED_ON_PROCESS" event="CLICK">
  <formActionSources>
    <formActionSource>GesTrigger1</formActionSource>
  </formActionSources>
  <formActionParameters>
    <formActionParameter name="formName" value="esg_test_preview_wniosek"/>
    <formActionParameter name="processInstanceId" value="nazwaZmiennejSesyjnej"/>
  </formActionParameters>
</formAction>

Akcje - startowanie Aplikacji

Dostępność funkcjonalności zależy od licencji i może nie być dostępna we wszystkich wdrożeniach.

Akcja START_APPLICATION jest odpowiedzialna za startowanie procesu ustawionego jako punkt startowy.

Ilustracja 8. Wiersz definiowania akcji START_APPLICATION

Akcja START_APPLICATION przyjmuje następujące parametry:

Nazwa aplikacji	Wskazanie procesu, który ma zostać wystartowany.
Przekieruj na kolejny krok procesu	Warunek JAVASCRIPT. Wskazanie czy ma nastąpić automatyczne przekierowanie na kolejnego user taska. Domyślna wartość: false

Akcja uruchamiania instancji procesu

Akcja START_PROCESS_AND_RESUME jest odpowiedzialna za wystartowanie instancji procesu i przekierowanie na zadanie użytkownika. W ramach akcji trzeba zdefiniować nazwę procesu, który ma zostać wystartowany.

Ilustracja 9. Wiersz definiowania akcji START_PROCESS_AND_RESUME

Akcja START_PROCESS_AND_RESUME przyjmuje następujące parametry:

Klucz definicji procesu	Nazwa definicji procesu, który ma zostać wystartowany.
Numer sprawy (Business key)	Biznesowy identyfikator sprawy

Po uruchomieniu procesu w instancji ustawiana jest zmienna procesowa sys_process_start_user_id, zawierająca identyfikator użytkownika uruchamiającego proces. Zmienną tę można wykorzystać np. w konfiguracji BPMN (candidate users) dla user taska, aby użytkownik tworzący proces miał dostęp do tego zadania.

Akcja zatwierdzenia zadania użytkownika w procesie

Akcja COMPLETE_TASK_AND_RESUME jest odpowiedzialna za zatwierdzenie zadania użytkownika i przekierowanie na następne zadanie.

Ilustracja 10. Wiersz definiowania akcji COMPLETE_TASK_AND_RESUME

Akcja przekierowania na nowy wniosek

Akcja LOAD_NEW_FORM umożliwia przekierowanie na nowy wniosek. W ramach akcji należy zdefiniować nazwę wniosku (formName) na który należy przekierować. Można także dodać dodatkowe parametry, które zostaną przekazane na nowy wniosek (aktualnie nie jest to możliwe z poziomu Deginera, należy w tym celu wykorzystać zakładkę "Żródło" i w akcji dodać kolejny "formActionParameter").

Przykładowe komponenty wysyłające zdarzenia

Komponent (Źródło akcji)	Możliwe zdarzenie	Opis
Page (strona)	NEXT	Akcja na kliknięcie przycisku dalej na stronie wniosku
	ON_EXIT	Akcja na wyjście ze strony
	ON_PAGE_ENTER	Akcja wejścia na konkretną stronę
	SAVE_DRAFT	Akcja na kliknięcie przycisku zapisu tymczasowego wniosku
Popup	SAVE	Akcja na kliknięcie przycisku zapisu na komponencie Popup
	HIDDEN
Oświadczenia (Statements)	EDIT	Akcja na kliknięcie przycisku edycji na komponencie oświadczeń
Oświadczenia zasilane z usługi (FedStatements)	EXPAND_STATEMENT	Akcja na kliknięcie rozwijacza na komponencie zasilanych oświadczeń
Pole tekstowe (GesTextField)	TOOLTIP_CLICKED	Akcja na kliknięcie tooltipa komponentu
Pole wyboru wartości z listy (GesCombobox)	TOOLTIP_CLICKED	Akcja na kliknięcie tooltipa komponentu
	VALUE_CHANGED	Akcja na zmianę wartości comboboxa
Trigger	CLICK	Akcja na kliknięcie komponentu
Checkbox	CLICK_MORE_INFO	Akcja na kliknięcie linku more info komponentu checkbox
	CHECK	Akcja na zaznaczenie checkboxa
	UNCHECK	Akcja na odznaczenie checkboxa
RadioGroup	VALUE_CHANGED	Akcja na zmianę wartości komponentu
TileGroup	VALUE_CHANGED	Akcja na zmianę wartości komponentu
TileGroup	TILE_CLICKED	Akcja na kliknięcie pojedynczego kafla w grupie kafli

Przykładowe komponenty odbierające zdarzenia

Komponent obsługujący akcje	Rodzaj akcji formularza	Opis
Checkbox	CHECK	Zaznaczenie checkboxa
	UNCHECK	Odznaczenie checkboxa
	TOGGLE	Zmiana wartości checkboxa na przeciwną
Oświadczenia zasilane z usługi (FedStatements)	CHECK_FED_STATEMENT	Zaznacza wymagane oświadczenie z listy oświadczeń
Page (strona)	FORWARD_PAGE	Przejście do następnej strony (tożsame z kliknięciem przycisku Dalej, Wyślij wniosek itp.)
	BACKWARD_PAGE	Przejście do poprzedniej strony (tożsame z kliknięciem przycisku Cofnij, Powróć itp.)
	REDIRECT_TO_RETURN_URL	Przekierowanie na url zdefiniowany w zmiennej sesyjnej returnUrl
	REDIRECT	Przekierowanie na url zdefiniowany w polu dostępnym po wyborze typu akcji REDIRECT
	SAVE_DRAFT	Zapis tymczasowy wniosku
PageService	CALL	Wywołanie usługi
Popup	SHOW_POPUP	Otwarcie komponentu popup zdefiniowanego w polu Komponent obsługujący akcję
	CLOSE_POPUP	Zamknięcie komponentu popup
	SAVE_POPUP	Zapisanie komponentu popup
Załączniki (Uploadfile)	CLEAR_UPLOAD_FILE	Czyszczenie dodanego załącznika (działa dla akcji ON_PAGE_ENTER)
Form	PARK_FORM_WITH_PROVIDED_HASH	Parkowanie wniosku
Trigger	START_APPLICATION	Startowanie procesu (procesu ustawionego jako punkt startowy) wskazanej w parametrze applicationName aplikacji
Trigger	START_FORM_BASED_ON_PROCESS	Akcja wejścia na nowy wniosek (parametr formName) zasilony model z podanej instancji procesu (parametr processInstanceId).

Wnioski demo: demoAkcje, demoTooltipy