Skip to main content

Konfiguracja docuRob WorkFlow

Właściwa konfiguracja produktu docuRob®WorkFlow zapewnia jego prawidłowe i efektywne użytkowanie. Aby to realizować, należy zapoznać się z opisem poszczególnych elementów konfiguracji takich jak, struktura plików konfiguracyjnych oraz z parametry konfiguracji.

Pliki konfiguracyjne

Konfiguracja docuRob®WorkFlow oparta jest na zestawie plików znajdujących się (po zainstalowaniu) w katalogu resources (tj. <katalog instalacji docuRob®WorkFlow>/ reosources). W tabeli 3 wyszczególniono pliki oraz inicjowane przez nie moduły produktu.

PlikModuł produktu
ooworkflow.propertiesdostęp do repozytorium agent zadań automatycznych obsługa zdarzeń sygnalizacja opóźnień logowanie informacji o działaniu systemu zarządzanie archiwum instancji procesów
oorm.propertieszarządzanie zasobami

Tabela 3: Pliki konfiguracyjne docuRob®WorkFlow

Podstawowe parametry

Niniejsza sekcja opisuje podstawowe parametry produktu docuRob®WorkFlow. Dla każdego z parametrów opisano jego znaczenie i podano zestaw dopuszczalnych wartości oraz wartość domyślną.

Dostęp do repozytorium

Konfiguracja dostępu do repozytorium zawarta jest w pliku ooworkflow.properties i składa się z następujących parametrów :

  • datasource.jdbc.driver – wykorzystywany sterownik JDBC - nazwa klasy sterownika implementującej interfejsy JDBC
  • datasource.jdbc.path - specyfikacja połączenia (ang. URL connection string) zgodna z zaleceniami dla danego sterownika
  • datasource.jdbc.username - nazwa wewnętrznego użytkownika bazy danych, który ma dostęp do danych systemu. Najczęściej jest to login właściciela schematu, na którym została utworzona struktura bazodanowa systemu
  • datasource.jdbc.password - hasło wewnętrznego użytkownika bazy danych

Agent zadań automatycznych

Konfiguracja agenta wykonującego zadania automatyczne zawarta jest w pliku ooworkflow.properties i składa się z następujących parametrów :

  • sysperformer – włączenie / wyłączenie wykonywania zadań automatycznych; możliwe wartości : ON - włączony, OFF - wyłączony
  • sysperformer.cleanMissingExecutorsInterval – interwał weryfikacji dostępnych wątków wykonujących zadania automatyczne; wartość – liczba sekund
  • sysperformer.killExpiredOwnTasksInterval – interwał wyszukiwania zadań, które przekroczyły dopuszczalny czas wykonania (patrz parametr sysperformer.maxExecutionTime) w ramach bieżącego węzła
  • sysperformer.killExpiredTasksInterval - interwał wyszukiwania zadań, które przekroczyły dopuszczalny czas wykonania (patrz parametr sysperformer.maxExecutionTime) w ramach wszystkich węzłów w klastrze
  • sysperformer.checkNewTasksInterval - interwał wyszukiwania nowych zadań do wykonania
  • sysperformer.checkOldTasksInterval - interwał wyszukiwania odłożonych zadań
  • sysperformer.idleTime – czas bezczynności
  • sysperformer.maxExecutionTime – maksymalny czas przewidziany na wykonanie zadania
  • sysperformer.maxSimultaneousExecutors – liczba wątków równolegle wykonujących zadania

Obsługa zdarzeń

Konfiguracja obsługi zdarzeń generowanych przez docuRob®WorkFlow zawarta jest w pliku ooworkflow.properties i składa się z następujących parametrów :

  • events – włączenie / wyłączenie generacji zdarzeń; możliwe wartości – odpowiednio ON, OFF
  • events.listeners – lista nazw <nazwa> nasłuchujących klas oddzielonych przecinkami
  • events.listeners.<nazwa> - pełna nazwa klasy (FQN) języka Java implementującej specyficzny interfejs API docuRob®WorkFlow (pl.rodan.ooworkflow.environment.event.WfEventHandler), który umożliwia nasłuchiwanie zdarzeń

Aby umożliwić nasłuch zdarzeń przykładowej klasie com.mysystem.EventsListener, należy włączyć generowanie zdarzeń (1), zdefiniować nasłuchującą klasę (3) oraz uaktywnić jej nasłuch (2) :

  • events=ON
  • events.listeners=my_listener
  • events.listeners.my_listener=com.mysystem.EventsListener

Sygnalizacja opóźnień

Mechanizm sygnalizacji opóźnień umożliwia monitorowanie przez docuRob®WorkFlow ograniczeń czasowych procesów oraz sygnalizację w przypadku ich przekroczenia. Poniższe parametry umożliwiają konfigurację sygnalizacji opóźnień :

  1. notification.system – włączenie / wyłączenie sygnalizacji opóźnień; dopuszczalne wartości to odpowiednio ON, OFF
  2. notification.system.timeslice – interwał pomiędzy kolejnymi odczytami stanu ograniczeń czasowych; czas podawany w minutach

Logowanie informacji o działaniu systemu

Logowanie informacji o działaniu systemu odbywa się w oparciu o bibliotekę Log4j1. Poniższe parametry pliku ooworkflow.properties umożliwiają konfigurację mechanizmu logowania :

  • logger.parameters.file.type - typ pliku, gdzie zapisana jest konfiguracja biblioteki Log4j; Dopuszczalne typy to tekst (wartość txt) i dokument XML (wartość xml)
  • logger.parameters.file - ścieżka dostępu i nazwa pliku konfiguracyjnego. Jeżeli parametr ma wartość this, to oznacza, że konfiguracja biblioteki Log4j jest zawarta w bieżącym pliku

Zarządzanie zasobami

docuRob®WorkFlow czerpie informacje o zasobach zewnętrznych – użytkownikach, grupach użytkowników, zajmowanych stanowiskach – z implementacji trzech interfejsów, których konfiguracja – wskazanie na klasy implementujące – znajduje się w pliku oorm.properties.

  • WfRMUserProcess – wskazuje na implementację interfejsu do odzyskiwania użytkowników (pl.rodan.ooworkflow.environment.wfRM.WfRMUserProcess)
  • WfRMGroupProcess - wskazuje na implementację interfejsu do odzyskiwania grup użytkowników (pl.rodan.ooworkflow.environment.wfRM.WfRMGroupProcess)
  • WfRMUserPositionProcess - wskazuje na implementację interfejsu do odzyskiwania stanowisk zajmowanych przez użytkowników (pl.rodan.ooworkflow.environment.wfRM.WfRMUserPositionProcess)

Standardowo dostarczane są dwie implementacje powyższych interfejsów – pierwsza z nich pozwala odzyskiwać dane z bazy danych na podstawie widoków, natomiast druga wyszukuje informacje z instancji produktu zarządzającego ontologiami docuRob®OntologyManager. Podczas funkcjonowania docuRob®WorkFlow aktywny może być tylko jeden zestaw implementacji w/w interfejsów. W pliku oorm.properties każda z implementacji poprzedzona jest przedrostkiem – odpowiednio db lub tm - dla widoków bazy danych oraz ontologii. Wybór aktywnej implementacji dokonywany jest w pliku ooworkflow.properties poprzez ustawienie parametru :

  • oorm.impl – dopuszczalne wartości : db, tm

przy wyborze tm dodatkowo należy skonfigurować dostęp do serwera docuRob®OntologyManager poprzez ustawienie dwóch parametrów również w pliku ooworkflow.properties :

  • topicmaps.host – adres serwera zarządzającego ontologiami
  • topicmaps.port – port serwera zarządzającego ontologiami

Zarządzanie archiwum instancji procesów

W celu redukcji miejsca zajmowanego przez instancje zakończonych procesów w repozytorium, istnieje możliwość ich archiwizacji. Archiwizacja instancji procesu polega na jego wyeksportowaniu do zewnętrznego zasobu. W ramach repozytorium pozostaje jedynie „ślad” umożliwiający odzyskanie instancji procesu (import z archiwum). Konfiguracja zarządcy archiwum polega na wskazaniu w pliku ooworkflow.properties pełnej nazwy klasy Java (FQN), która implementuje interfejs pl.rodan.ooworkflow.environment.archive.WfArchiveManager :

  • WfArchiveManager – wskazuje na implementację interfejsu zarządcy archiwum

Pozostałe parametry

docuRob®WorkFlow wymaga zmiany domyślnych ustawień pamięci wykorzystywanej przez maszynę wirtualną Java (JVM), czyli zwiększenia inicjalnego maksymalnego rozmiaru sterty JVM (heap size) na 256 megabajtów :

-Xmx256m

Footnotes

  1. Log4j - http://logging.apache.org/log4j/