Właściwości formularza

Zakładka Właściwości umożliwia konfigurację parametrów dotyczących zachowania, wyglądu i interakcji formularza w czasie jego działania. Parametry te wpływają na to, jak formularz jest prezentowany użytkownikowi, w jaki sposób komunikuje się z usługami oraz jakie elementy interfejsu są widoczne. Właściwości są pogrupowane w sekcje tematyczne.

Ilustracja 1. Wygląd zakładki "Właściwości"

Sekcja "Ogólne"

Opis wniosku

Pole tekstowe pozwalające na dodanie krótkiego opisu lub komentarza do projektu formularza. Opis ten nie jest prezentowany użytkownikowi końcowemu, ale ułatwia identyfikację w repozytorium i w pracy zespołowej.

Serwisy wejścia

W sekcji tej znajduje się lista usług, które są podpięte na wniosku jako serwisy startowe. Usługi te uruchomią się na początku życia wniosku, jeśli warunek aktywności jest spełniony. Usługi wejścia wykonywane są sekwencyjnie, zgodnie z kolejnością na liście. W trybie edycji istnieje możliwość dodania i usunięcia serwisu wejścia oraz zdefiniowania warunku uruchomienia usługi.

Ilustracja 2. Sekcja "Serwisy wejścia" z dodanymi usługami

Serwisy mapujące parametry wejścia

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

Sekcja Serwisy mapujące parametry wejścia umożliwia podłączenie usług, których zadaniem jest zasilenie pól formularza danymi jeszcze przed jego uruchomieniem. Serwisy te uruchamiane są automatycznie przy wejściu na wniosek - zarówno podczas standardowego otwarcia formularza, jak i w przypadku jego odparkowania (wznowienia sesji).

Dzięki tym usługom można np. przekazać dane klienta z systemu zewnętrznego, ustawić wartości startowe pól lub otworzyć wniosek na określonej stronie.

Cechy charakterystyczne serwisów mapujących

  • nie posiadają parametrów wyjściowych,

  • wynik działania serwisu jest bezpośrednio mapowany na pola formularza lub zmienne sesyjne,

  • mogą określać stronę, na której formularz ma się otworzyć,

  • wykonują się zawsze jako pierwsze - jeszcze przed serwisami wejścia.

Przykład implementacji (ServiceProxy)

W celu zasilenia pola należy w usłudze zwrócić w mapie klucz, który będzie posiadał identyfikator pola na wniosku oraz wartość, która zostanie mu przypisana. Nie należy definiować outputFields dla pól zwracanych z metody callService(). Aby otworzyć wniosek na określonej stronie należy przekazać do wyjściowej mapy zmienną recentlyRequestedPageMid i przekazać do niej mid odpowiedniej strony.

@Component
@Service(AbstractServiceProxy.class)
public class DemoMappingEntryService extends AbstractServiceProxy {

    private final static String TEXT_FIELD = "GesComplexComponent1.GesTextField1";
    private final static String PAGE_MID = "_recentlyRequestedPageMid";

    public DemoMappingEntryService() {
        this.name = "DemoMappingEntryService";
        this.description = "For test purposes ONLY!";
    }

    @Override
    public List<Map<String, String>> callService(Map<String, List<String>> map)
            throws ServiceProxyException {
        return Collections.singletonList(ImmutableMap.of(
                TEXT_FIELD, "Wartość przekazana z usługi DemoMappingEntryService",
                PAGE_MID, "Page2"));
    }
}

Wniosek demo: demoSerwisMapujacyParametryWejscia

Serwisy wyjścia

W sekcji tej znajduje się lista usług, które są podpięte na wniosku jako serwisy końcowe. Serwisy te uruchomią się przed końcem życia wniosku, jeśli warunek aktywności jest spełniony.

Sekcja "Wygląd"

Sekcja ta odpowiada za konfigurację elementów interfejsu widocznych w trakcie wypełniania wniosku.

Panel boczny i dolny

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

Pozwala włączyć lub wyłączyć widoczność dodatkowych paneli (np. menu bocznego z informacjami, powiadomieniami lub blokami treści). Panele mogą być wykorzystywane do prezentowania przydatnych linków czy elementów cross-sell.

Do paneli można podpinać artefakty typu Treść (TextContent), wybierane z repozytorium. Edycja panela (dodania warunku widoczności, nasłuchiwań, stylów czy wybranie slotu) wymaga kliknięcia ikony ołówka, a zapisanie zmian kliknięcia symbolu zapisu. O położeniu dodanej treści decyduje opcja Slot.

Ilustracja 3. Panel boczny i dolny - przykład definiowania treści

Ilustracja 4. Przykładowy wygląd panelu bocznego na wniosku

Widoczność kroków

Kontroluje wyświetlanie górnego poziomego paska postępu (tzw. kroków formularza). Jego ukrycie może być stosowane we wnioskach jednostronicowych lub uproszczonych procesach.

W sekcji można określić warunek widoczności belki kroków oraz wskazać elementy, które wzbudzają tę zmianę (tzw. nasłuchiwanie na elementy).

Ilustracja 5. Przykład zdefiniowanego warunku widoczności belki kroków
Ilustracja 6. Przykład kroków na wniosku

Widoczność paska/przycisku nawigacji

Widoczność paska nawigacji umożliwia określenie, czy dolny pasek nawigacyjny (z przyciskami Cofnij/Dalej/Wyślij) ma być widoczny. Natomiast w sekcji Widoczność przycisku nawigacji określa się tylko warunek pokazywania przycisku Dalej/Wyślij. W obu sekcjach należy też pamiętać o wskazaniu elementów wzbudzających daną zmianę (tzw. nasłuchiwanie).

Ilustracja 7. Sekcja "Widoczność przycisku nawigacji"

Widoczność dodatkowego elementu nagłówka

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

Umożliwia wyświetlania dodatkowego elementu na pierwszej pozycji nagłówka strony (np. ikony, przycisku propagującego akcję). Rodzaj wyświetlanego elementu może się różnić w zależności od wdrożenia i nie jest gwarantowane jego wystąpienie we wszystkich implementacjach.

Bottom Bar

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

Decyduje o tym czy stopka formularza ma być prezentowana użytkownikowi. Może być ukryta warunkowo – np. na stronach z informacjami lub podsumowaniem.

Panic Button (FAB)

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

Określa, czy przycisk pływający na stronie wniosku, otwierający dodatkowe okno (FAB – Floating Action Button) ma być widoczny na formularzu.

Widoczność

Widoczność przycisku ustala się w podsekcji Widoczność, gdzie określa się warunek pokazania przycisku oraz element, który ma tę zmianę wywoływać (nasłuchiwanie). Dzięki temu przycisk może być widoczny tylko w określonych sytuacjach, np. po zaznaczeniu pola lub w danym kroku wniosku.

Maskowanie numeru telefonu

W sekcji Maskowanie można zdefiniować, czy numer telefonu w okienku przycisku ma być maskowany (np. częściowo ukryty). Widoczność numeru określa się za pomocą warunku i nasłuchiwania na element wzbudzający zmianę.

Dodatkowe ustawienia

W podsekcji Dodatkowe dane można wskazać komponenty formularza, których wartości zostaną przekazane do konfiguracji przycisku - numer telefonu, id czy wersję konfiguracji. Opcja ta dostępna jest tylko w wybranych wdrożeniach.

Ilustracja 8. Widoczność sekcji "Panic Button" z ustawionymi warunkami i parametrami

Konfiguracja techniczna

Rozmiar oraz położenie okna przeglądarki, a także adres witryny, do którego prowadzi definiowane są dla danej instalacji w pliku konfiguracyjnym webforms.xml. Przykładowe wartości:

<floatingActionButton>
    <windowPositionX>100</windowPositionX>
    <windowPositionY>100</windowPositionY>
    <windowSizeX>100</windowSizeX>
    <windowSizeY>100</windowSizeY>
    <actionLink>http://consdata.pl</actionLink>
</floatingActionButton>

Parametry konfiguracyjne:

  • windowPositionX – odległość okna od lewej krawędzi (px)

  • windowPositionY – odległość okna od góry (px)

  • windowSizeX – szerokość okna (px)

  • windowSizeY – wysokość okna (px)

  • actionLink – adres witryny otwieranej w nowym oknie; może zawierać zmienne formularza dostępne podczas uruchamiania wniosku, np.:

<actionLink>http://consdata.pl?nazwawniosku=${formId}&numerwniosku=${formInstanceNumber}</actionLink>

Tłumaczenia i klucze tekstowe

Napisy na komponencie można dostosować, dodając tłumaczenia w głównym szablonie formularza:

Klucz tłumaczenia
Opis
Domyślna treść

iew.fab.need.help

tytuł w popupie startowym

„Potrzebujesz pomocy?”

iew.fab.well.call.up

opis w popupie startowym

„Oddzwonimy do Ciebie jak najszybciej…”

iew.fab.order.call

treść buttona w popupie startowym

„Zamów kontakt”

iew.fab.thank.you.title

tytuł w popupie podziękowania

„Wkrótce do Ciebie oddzwonimy”

iew.fab.thank.you.desc

opis w popupie podziękowania

""

iew.fab.error.could.not.order.conversation.title

tytuł w popupie błędu

„Nie udało się zamówić rozmowy”

iew.fab.error.try.again.desc

opis w popupie błędu

„Spróbuj ponownie za chwilę”

Wnioski demo: demoFab, demoFabZmienioneLitera

Styl postępu ładowania

Definiuje sposób prezentacji wskaźnika ładowania podczas inicjalizacji formularza. Domyślna wartość to "preloader". Dostępne style mogą się różnić w zależności od szaty graficznej (np. pasek postępu, spinner, animacja logo).

Warunkowe tytuły wniosku

Umożliwia zdefiniowanie różnych tytułów wyświetlanych w nagłówku formularza w zależności od spełnienia określonych warunków. Każdy tytuł posiada przypisany warunek widoczności (np. zależny od danych), dzięki czemu można dynamicznie zmieniać nagłówek w zależności od etapu wniosku czy roli użytkownika.

Definicja tytułów

Każda definicja tytułu jest prezentowana w osobnym wierszu tabeli. Dany wiersz zawiera:

  • Klucz tytułu – identyfikator tłumaczenia lub tekst stały wyświetlany w nagłówku formularza,

  • Warunek widoczności – wyrażenie logiczne określające, kiedy tytuł ma być użyty,

  • Elementy wzbudzające zmianę (nasłuchiwanie) – lista komponentów lub zmiennych (oddzielonych przecinkami), których zmiana powoduje ponowną ocenę warunku,

  • Przyciski edycji i usunięcia – umożliwiają modyfikację lub usunięcie wiersza definicji tytułu,

  • Przycisk zapisu – widoczny w trakcie edycji wiersza; zapisuje wprowadzone zmiany,

  • Uchwyt do zmiany kolejności – pozwala przeciągnąć tytuł i ustawić jego priorytet (kolejność sprawdzania warunków).

Wiersze są przetwarzane od góry do dołu, więc jeśli kilka warunków jest spełnionych, wyświetli się tytuł z najwyższego wiersza.

Ilustracja 9. Przykład zdefiniowanych czterech warunkowych tytułów

Jeśli zmiana tytułu wniosku zależy od przejścia między stronami, to w warunku używamy zmiennej currentPageMid. Pozwoli to na zmianę tytułu zarówno przy przejściu do następnej strony, jak i przy cofaniu się.

Wniosek demo: demoFormTitles

Wniosek demo: demoWlasciwosciSzablonuWniosku

PreviousPodgląd definicji formularza (XML)NextZakładka Audyt, Naruszenia WCAG

Last updated

Was this helpful?