Interfejs do edycji procesów

Moduł proc dysponuje interfejsem html pozwalającym edytować procesy, obiekty złożone oraz uprawnienia do stanów i przejść. Obiekty interfejsu zawarte są w pliku jPalio.jar, co umożliwia ich szybkie dodanie w dowolnym systemie. Należy w tym celu wykonać jednokrotnie w dowolnym obiekcie funkcję $proc.createOrReplaceHtmlInterface(). Po wykonaniu funkcji należy odświeżyć drzewo katalogów w jDesignerze. W katalogu głównym pojawi się katalog "Zarządzanie procesami", zawierający obiekty interfejsu. Aby uzyskać dostęp do stron interfejsu, należy dodać linki do stron 90010, 90020, 90030, 90050.

Interfejs oparty jest o identyfikatory obiektów i stron, a nie o kody (był tworzony dla wersji jpalio nie obsługującej jeszcze kodów). Katalogi, obiekty i strony posiadają identyfikatory > 90000.

Interfejs był testowany na bazie Oracle oraz postgreSQL.

W katalogu "Zarządzanie procesami > 03 Obiekty referencyjne dla procesów" można znaleźć przykłady obiektów różnych typów.

Nazwy obiektów

Ze względu na dużą liczbę obiektów jpalio istniejących na ogół w systemie, podczas wskazywania tychże obiektów w formularzach interfejsu zaistniała konieczność ograniczenia liczby obiektów wyświetlanych na liście. Aby obiekty jpalio były widoczne na listach, konieczne jest nadanie im określonych prefiksów w nazwie (nie w kodzie):

"Proc state" dla obiektów stanu
"Proc error" dla obiektów błędu
"Proc obj" dla pozostałych obiektów, używanych do budowania obiektów złożonych

Zalecane jest także nadawanie nazwom obiektów odpowiednich literowych suffiksów, określonych w rozdziale "Obiekty określane dla stanów i przejść".

Konfiguracja interfejsu

Interfejs html umożliwia dostosowanie kolorów interfejsu (obiekt 90041) oraz sposobu definiowania uprawień (obiekt 90040). Różne systemy mogą używać jednego lub dwóch zestawów uprawnień. Do wskazania ilości używanych zestawów służy zmienna UseOwnerRights, null oznacza jeden zestaw uprawnień, not null dwa. W zmiennych StateRightTypes, StateRightTypesOwner, TransitionRightTypes, TransitionRightTypesOwner można określić dostępne typy uprawnień dla stanów i przejść, podanie jednej pozycji tabeli spowoduje, iż w formularzu do edycji uprawnień będą wyświetlane checkboxy, podanie większej ilości typów wygeneruje listę rozwijaną.

Edycja procesów

Edycja procesów jest dostępna na stronie 90010.

Rys. Tabela procesów.

W tabeli procesów wyświetlone są zdefiniowane procesy. Przyciski "Zablokuj" i "Odblokuj" umożliwiają zmianę statusu procesu. "Usuń" usuwa proces oraz wszystkie przypisane do niego stany, przejścia i obiekty złożone. Przycisku należy używać ze szczególną ostrożnością, gdyż akcja nie jest w żaden sposób potwierdzana. "Kopiuj" tworzy kopię procesu oraz wszystkich przypisanych do niego stanów, przejść, obiektów złożonych oraz uprawnień do stanów i przejść. Kliknięcie na nazwie procesu powoduje przeniesienie do formularza właściwości procesu.

Rys. Formularz właściwości procesu.

Formularz właściwości procesu umożliwia określenie nazwy procesu, jego identyfikatora tekstowego, oraz obiektu stanu i błędu dla procesu. Aby na liście obiektów stanu i błędu widoczne były obiekty jpalio, ich nazwa musi zaczynać się odpowiednio od "Proc state" lub "Proc error".

Edycja obiektów

Edycja obiektów jest dostępna na stronie 90020.

Rys. Tabela obiektów.

Na stronie z tabelą obiektów można dodawać, usuwać i kopiować obiekty złożone. Kliknięcie nazwy obiektu przenosi do formularza właściwości obiektu.

Rys. Formularz właściwości obiektu.

Formularz właściwości obiektu złożonego umożliwia określenie nazwy, przynależności do procesu oraz składowych obiektów jpalio. Określenie przynależności do procesu powoduje, że obiekt będzie kopiowany i usuwany razem z procesem. Obiekty nie przypisane do procesów będą wyświetlane na listach obiektów złożonych w formularzach właściwości stanów i przejść wszystkich procesów. Przycisk ze znakiem "^" służy do zmiany kolejności wykonania obiektów składowych - przesuwa dany obiekt składowy o pozycję wyżej. Wybranie pozycji na liście "nty obiekty jpalio" i zapisanie danych obiektu spowoduje pojawienie się kolejnej listy "nty obiekty jpalio", umożliwiającej dodanie następnego obiektu. Zapis pozycji "nty obiekty jpalio" z wartością pustą spowoduje usunięcie danej pozycji.

Pod formularzem właściwości obiektu wyświetlana jest tabela stanów i przejść, w których obiekt jest używany. Kliknięcie pozycji tabeli przenosi do formularza właściwości odpowiedniego stanu.

Edycja stanów i przejść

Edycja stanów i przejść jest dostępna na stronie 90030.

Rys. Tabela stanów.

Na stronie edycji stanów i przejść wyświetlane są dwie tabele. Kliknięcie pozycji w pierwszej z nich przenosi do edycji klikniętego stanu i jego przejść. Kliknięcie pozycji w drugiej tabeli pozwala edytować cały proces jednocześnie.

Rys. Formularz właściwości stanu.

Formularz właściwości stanu służy do edycji właściwości stanu i przejść z nim powiązanych. Dane przejść są wcięte względem danych stanów. Stany są wyświetlane w kolejności odpowiadającej numerowi stanu.

Znaczenie pól formularza właściwości stanu, kolejno od góry:

id stanu - bazodanowe id stanu (id stanu w tabeli j_states)
zaznacz - pole służące do wskazania kilku stanów przy usuwaniu za pomocą przycisku "usuń zaznaczone stany"
numer stanu - pole obowiązkowe, jest to numeryczny identyfikator stanu, wartość tego identyfikatora jest przechowywana razem z instancją procesu i oznacza jej bieżący stan,
text_id - identyfikator tekstowy stanu, został wprowadzony aby umożliwić odwoływanie się do stanów bez użycia numerów stanów lub id bazodanowych stanów. Odwoływanie się do stanów za pomocą identyfikatora tekstowego pozwala na skopiowanie procesu, jego modyfikację i wykonywanie akcji za pomocą tych samych obiektów jpalio co w poprzedniej wersji procesu (nie występuje konieczność zmiany wewnątrz obiektów jpalio zmodyfikowanych numerów stanów). Identyfikator tekstowy pozwala określić bazodanowe id stanu za pomocą funkcji getStateIdByTextId(). Id bazodanowe umożliwia pobranie dowolnej właściwości stanu, np. numeru stanu za pomocą funkcji getStateNumber()
nazwa stanu - nazwa stanu
tytuł strony - tytuł strony ustawiany w zmiennych globalnych PageTitle i _PageTitle przed wykonaniem obiektu stanu, obiektu pozostania w stanie lub obiektu oczekiwania na zakończenie podprocesów
komunikat - komunikat dla użytkownika systemu ustawiany w zmiennych globalnych InfoStr i _InfoStr przed wykonaniem obiektu stanu, obiektu pozostania w stanie lub obiektu oczekiwania na zakończenie podprocesów, np. "Proszę wypełnić formularz zgłoszenia"
ostrzeżenie - komunikat dla użytkownika systemu ustawiany w zmiennych globalnych ErrorStr i _ErrorStr przed wykonaniem obiektu stanu, obiektu pozostania w stanie lub obiektu oczekiwania na zakończenie podprocesów, np. "Ważność zgłoszenia wygaśnie za 2 dni. Proszę potwierdzić lub odrzuć zgłoszenie."
stan nie chroniony uprawnieniami - zaznaczenie pola powoduje, że podczas wyświetlania instancji w danym stanie nie są sprawdzane uprawnienia użytkownika systemu do stanu (stan wyświetlany jest zawsze, niezależnie od uprawnień),
stan archiwum - flaga informacyjna, do wykorzystania w dowolny sposób przez użytkownika
początkowy stan procesu - zaznaczenie tej flagi powoduje, iż stan traktowany jest jako potencjalny początkowy stan procesu i jest wyświetlany na liście stanów docelowych w formularzu właściwości przejścia, co umożliwia wykonywanie przejść międzyprocesowych
początkowy stan podprocesu - zaznaczenie tej flagi powoduje, iż stan traktowany jest jako potencjalny początkowy stan podprocesu i pojawia się na liście stanów "w stanie rozpoczynają się podprocesy o stanach początkowych" w formularzu właściwości stanu
końcowy stan (pod)procesu - flaga informacyjna, do wykorzystania w dowolny sposób przez użytkownika, na ogół wykorzystywana w połączeniu z funkcją isStateLastInProcess() podczas dokonywania zmiany stanu w obiekcie stanu do oznaczania instancji procesu jako zakończone
obiekty i parametry: I - obiekt incjalizacji (pole z listą) i parametr przekazywany do obiektu (pole tekstowe),
obiekty i parametry: P - obiekt prezentacji (pole z listą) i parametr przekazywany do obiektu (pole tekstowe),
obiekty i parametry: S - obiekt pozostania w stanie (pole z listą) i parametr przekazywany do obiektu (pole tekstowe),
obiekty i parametry: F - obiekt sprawdzania zakończenia podprocesów
obiekty i parametry: W - obiekt oczekiwania na zakończenie podprocesów
obiekty i parametry: W & F - parametr przekazywany do obiektów: sprawdzania zakończenia podprocesów i oczekiwania na zakończenie podprocesów
w stanie rozpoczynają się podprocesy o stanach początkowych - lista stanów w bieżącym procesie, które mają ustawioną flagę "początkowy stan podprocesu". Numery stanów zaznaczonych na liście są przekazywane jako jeden z parametrów wywołania obiektu prezentacji
pozycja stanu w grafie, X, Y - w chwili obecnej nie wykorzystywane
zapisz zmiany - zapisuje zmiany w całym formularzu (zmiany danych stanu, przejść oraz innych stanów i ich przejść o ile edytowany jest cały proces)
odśwież - ponownie wczytuje formularz danych stanu, ignorując wprowadzone zmiany
uprawnienia - wyświetla okno z uprawnieniami do stanu
kopiuj - kopiuje stan, kopia otrzymuje numer stanu kolejny względem największego numeru stanu w procesie
usuń - usuwa nieodwracalnie stan, akcja jest wykonywana bez jakiegokolwiek potwierdzenia
dodaj przejście, dodaj 2 przejścia, dodaj 3 przejścia, dodaj 4 przejścia - dodaje odpowiednią liczbę przejść do stanu

Znaczenie pól formularza właściwości przejścia, kolejno od góry:

id przejścia - bazodanowe id przejścia (id stanu w tabeli j_transitions)
zaznacz - pole służące do wskazania kilku przejść przy usuwaniu za pomocą przycisku "usuń zaznaczone przejścia"
text_id - identyfikator tekstowy przejścia, został wprowadzony aby umożliwić odwoływanie się do przejść bez użycia bazodanowego id przejścia
nazwa przejścia - tekst wyświetlany na kontrolce wyzwalającej akcję przejścia, np. na przycisku
stan następny (N) - stan, do którego prowadzi przejście
warunek przejścia (C) - obiekt warunku
obiekt przejścia (O) - obiekt przejścia (akcji)
parametr dla C i O - parametr przekazywany do obiektu warunku i obiektu przejścia
nie chronione uprawnieniami - zaznaczenie pola powoduje, że podczas wyświetlania przejść nie są sprawdzane uprawnienia użytkownika systemu do przejścia (przejście wyświetlane jest zawsze, niezależnie od uprawnień)
nie wyświetlaj (przejście automatyczne) - zaznaczenie pola powoduje iż przejście nie jest brane pod uwagę przy wyświetlaniu przejść
po wykonaniu przejścia pozostań w poprzednim stanie - zaznaczenie pola oznacza, iż po wykonaniu przejścia należy wyświetlić obiekt pozostania w stanie określony dla bieżącego stanu a nie instancję procesu w stanie następnym
uprawnienia - wyświetla okno z uprawnieniami do przejścia
przesuń wyżej - zamienia kolejność wyświetlania przejścia bieżącego i poprzedniego. Przejścia w formularzu edycji stanów i przejść są wyświetlane w takiej samej kolejności jak będą wyświetlane w obiekcie przezentacji przy użyciu funkcji displayTransitionsButtons(), displayTransitionsOptions() i displayTransitions()
kopiuj - kopiuje przejście, skopiowane przejście umieszczane jest na końcu listy przejść
usuń - usuwa nieodwracalnie przejście, akcja jest wykonywana bez jakiegokolwiek potwierdzenia

Rola kontrolek umieszczonych pod tabelą stanów stanów i przejść.

dodaj stan, dodaj 2 stany, dodaj 3 stany, dodaj 5 stanów, dodaj 10 stanów - dodaje odpowiednią liczbę stanów do procesu
zapisz zmiany - zapisuje zmiany w całym formularzu (zmiany danych stanu, przejść oraz innych stanów i ich przejść o ile edytowany jest cały proces)
odśwież - ponownie wczytuje formularz danych stanu, ignorując wprowadzone zmiany
lista stanów - przenosi do tabeli stanów i przejść wszystkich procesów
usuń zaznaczone stany - usuwa stany, dla których zaznaczono pole "zaznacz"
usuń zaznaczone przejścia - usuwa przejścia, dla których zaznaczono pole "zaznacz"
wyświetl - przenosi do formularza edycji stanu wybranego z listy obok

Pod tabelą stanów i przejść umieszczono także dwie tabele nawigacyjne.

Służą one do szybkiego przenoszenia do edycji obiektów wykorzystywanych przez stan oraz do przenoszenia do edycji stanów, których przejścia prowadzą do bieżącego stanu lub przenoszenia do edycji stanów, do których prowadzą przejścia bieżącego stanu.

Zmiany wprowadzone w polach formularza są zapisywane tylko po kliknięciu jednego z przycisków "Zapisz zmiany". Użycie dowolnego innego przycisku lub skorzystanie z tabel nawigacyjnych powoduje utracenie wprowadzonych zmian.

Rys. Formularz uprawnień do stanu.

Powyższy formularz jest wyświetlany po kliknięciu przycisku "uprawnienia" w formularzu edycji stanu lub przejścia. Na rysunku została przedstawiona edycja uprawnień do stanu, edycja uprawnień do przejścia wygląda i jest obsługiwana analogicznie. Aby określić uprawnienia do stanu, należy wybrać dla żądanych ról typ uprawnienia z listy i kliknąć przycisk "zapisz". Akcja "odśwież" przeładowuje formularz, ignorując wprowadzone zmiany. Jeśli interfejs zostałby skonfigurowany tak, aby używać jednego typu uprawnień, zamiast list rozwijanych zostałyby wyświetlone pola wyboru typu checkbox. Zaznaczenie pola wyboru oznacza nadanie uprawnienia.

Edycja uprawnień do stanów i przejść

Edycja uprawnień do stanów i przejść jest dostępna na stronie 90050.

Rys. Formularz uprawnień.

Strona ta udostępnia znacznie wygodniejszy interfejs do edycji uprawnień niż dostępny w formularzu edycji stanów i przejść. Wyświetlane są jednocześnie uprawnienia do wszystkich stanów i przejść wybranego procesu (pole "stany i przejścia procesu") oraz wszystkich lub wybranych ról. Role można ograniczyć do pojedynczej roli za pomocą pola "uprawnienia dla roli", do wybranej roli i ról do niej podrzędnych (pole "uprawnienia dla poddrzewa ról") lub do grupy wskazanych ról (pole "uprawnienia dla wybranych ról", zaznaczanie wielu ról po poprzez klikanie z wciśniętym klawiszem shift lub ctrl). Jeśli interfejs jest skonfigurowany tak, aby używać jednego typu uprawnień dla stanów/przejść, zamiast list rozwijanych zostaną wyświetlone pola wyboru typu checkbox. Zaznaczenie pola wyboru oznacza nadanie uprawnienia. Zmiany wprowadzone w uprawnieniach są zapisywane po kliknięciu przycisku "ustaw skojarzenia", znajdującego się pod tabelą uprawnień.