Wstęp

Katalog domowy jest jednym wspólnym miejscem do trzymania danych/ustawień aplikacji takich jak:

  1. logi (domyślnie)
  2. wtyczki
  3. konfiguracja
  4. XPDL
  5. katalog tymczasowy

Elementy katalogu domowego

Podczas pierwszego uruchomienia systemu z ustawionym katalogiem domowym, powstaną poniższe jego elementy z domyślnymi ustawieniami.
Jednak jest możliwość podania także własnych ustawień w podanym miejscu.

Elementy konfiguracyjne

To elementy umieszczone w katalogu domowym, które służą do ustawień działania PlusWorkflow.

ElementDomyślne ustawieniaLokalizacja własnych ustawieńUwagi
Konfiguracja ścieżki katalogubrak (wyjątek instalowanie za pomocą instalatora)parametr plusworkflow.home w web.xmlDecyduje o włączeniu katalogu domowego.
Tu ustawiona ścieżka dalej używana jako <home-dir>
Konfiguracja bazy danychwbudowane w system,
ale powstaje <home-dir>/config/db.properties z pustymi wartościami parametrów.
W takim przypadku system korzysta z domyślnej wbudowanej bazy danych.
<home-dir>/config/db.properties
z podaniem odpowiednich wartości parametrów dot zewnętrznej bazy
 

Konfiguracja parametrów systemu

wbudowane w system<home-dir>/config/PlusWorkflow.conf
poza ustawieniami bazy co jest robione jak opisano powyżej
Nie zalecane wprowadzanie własnych ustawień przez nadpisanie conf'a. Od wersji 3.2.22 zaleca się ustawianie własnych ustawień parametrów w Administracja->Konfiguracja systemu->Parametry systemu.
Konfiguracja logówwbudowane w system<home-dir>/config/Log4j.xml 

Pozostałe elementy

To elementy umieszczone w katalogu domowym, które nie służą do ustawień działania, ale zawierają już konkretne elementy potrzebne do działania albo efekty działania PlusWorkflow.

ElementLokalizacjaUwagi
Pliki logów<home-dir>/logsale w powyższej konfiguracji logów można zmienić lokalizację gdzie będą trafiały logi
Zainstalowane wtyczki<home-dir>/data/plugins 
Katalog tymczasowy<home-dir>/temp 
Mapy procesów<home-dir>/XPDL 

Kompatybilność wstecz

Jeżeli w pliku web.xml nie został skonfigurowany katalog domowy, to:

Katalog domowy jest mimo wszystko ustawiany (domyślnie ../PlusWorkflow Home) – dlatego mogą tam trafić logi (jeżeli plik nie został nadpisany), będzie tam temp, katalog użytkownika (user.dir) etc.

Konfiguracja katalogu domowego

Aby ustawić/zmienić katalog domowy trzeba ustawić jego elementy konfiguracyjne we wskazanym w 'Elementy konfiguracyjne' lokalizacji własnych ustawień :

Konfiguracja ścieżki katalogu

 Ustawienie ścieżki katalogu jest obligatoryjne, bo decyduje o włączeniu katalogu domowego.

	<context-param>
		<param-name>plusworkflow.home</param-name>
		<param-value>../PlusWorkflow Home</param-value>
	</context-param>

Konfiguracja bazy danych

Ustawienia dot bazy danych można zrobić poprzez ustawienie parametrów w pliku.

# Database connection configuration
# [Connection]
# Database name
db.name=
# Database server type [postgresql, oracle, mssql, db2, db2as400]
db.type=
# Database server host (without port)
db.host=
# Port on which database server accepts connections
db.port=
# Database user
db.username=
# Database user password
db.password=
# [Optional] JDBC connection URL (if empty, connection URL will be build based on properties above)
db.connectionUrl=

# [Connection pool configuration]
# Maximum pool size (default 30)
db.pool.size=30
# Minimum number of idle connections in pool (default 5)
db.pool.idle=5
# Timeout for acquiring connection from the pool (defaults to 5 minutes)
db.pool.connectionTimeout=300000

Jeżeli parametry dot bazy danych (sekcja 'Database connection configuration'), nie są podane to system domyślnie uruchomi się na wbudowanej bazie PostgreSQL.

Jeżeli parametry te zostaną podane aby skorzystać z bazy zewnętrznej, to parametr 'connectionUrl' nie musi być podany.
Jednak jeśli z jakichś względów zostanie on wypełniony to parametry 'name', 'type', 'host', 'port' muszą nadal być wypełnione, pomimo ich podania w 'connectionUrl'.
Ponadto konieczne wtedy jest zapewnienie odpowiednio tych samych wartości.

Konfiguracja parametrów systemu

Zalecanym sposobem ustawiania parametrów jest ich ustawianie z GUI PlusWorkflow tj. w 'Administracja' -> 'Konfiguracja systemu' -> 'Parametry systemowe'
Plik z parametrami w ogóle nie powinien być podłączony.

Konfiguracja logów

Polega na podpięciu własnego pliku ustawień log4j, w miejscu wskazanym w 'Elementy konfiguracyjne' lokalizacja własnych ustawień.

Włączenie katalogu domowego

Aby po raz pierwszy włączyć katalog domowy, nie wszystkie ustawienia są konieczne. Potrzebne są z kolei dodatkowe kroki, jeśli chcemy włączyć katalog domowy na działającym już systemie.
Poniższy opis pokazuje co trzeba zrobić, a co jest opcjonalne w zależności od sytuacji.
Natomiast bardziej szczegółowy sposób ustawiania elementów konfigurowalnych jest opisany w 'Konfiguracja katalogu domowego', a informacje o miejscu ich wykonania znajduje się w opisie elementów tj. w 'Elementy konfiguracyjne'.

Na nowym systemie

Aby nowo przygotowywany system działał z Katalogiem domowym należy wykonać następujące ustawienia w zależności sposobu instalacji i potrzeb.

Instalowanym bez Instalatora

 WymaganeUwagi
Ustawienie ścieżki katalogu(plus) 
Ustawienie własnej bazy danych(plus)**Nie wymagane tylko na systemach tymczasowych np. demonstracyjnych.
Wtedy ten krok można pominąć, a system domyślnie uruchomi się na wbudowanej bazie danych.
Ustawienie własnych wartości wybranych parametrów systemu(minus) 
Ustawienie własnych logów(minus) 

Instalowanym za pomocą Instalatora

Na nowym systemie, który jest instalowany za pomocą instalatora wystarczy podać podczas instalacji w oknie instalator'a, ścieżkę katalogu domowego. A parametry dot bazy danych, tylko jeśli korzystamy z zewnętrznej bazy danych.
Wtedy elementy konfiguracyjne  zostaną odpowiednio wypełnione przez instalator.

Jak już system zostanie zainstalowany instalatorem to zmienić dotychczasowe ustawienia lub wykonać dodatkowe dot. parametrów systemu lub logów można zrobić tak samo jak dla systemu instalowanego tradycyjnie.

Na działającym systemie (bez katalogu domowego)

Aby zmigrować do katalogu domowego system (z tą samą bazą, procesami itp), który wcześniej działał bez katalogu domowego, należy wykonać następujące ustawienia w zależności od potrzeb :

 WymaganeWymagana dodatkowa czynność
Ustawienie ścieżki katalogu(plus) 
Ustawienie własnej bazy danych(plus)Należy usunąć konfigurację bazy z pliku context.xml i web.xml (tag 'resource-ref').
Ustawienie własnych wartości wybranych parametrów systemu(plus)

Należy usunąć konfigurację parametru 'Shark_Conf' z pliku web.xml
Jeśli używany był PlusWorkflow.conf z własnymi ustawieniami parametrów to zalecane jest jego zlikwidowanie i ustawienie tych zmienionych parametrów w Konfiguracji systemu->Parametry systemu.
Jeśli jednak ustawienia parametrów zostaną nadpisane poprzez umieszczenie PlusWorkflow.conf w miejscu własnych ustawień (nie zalecane), to trzeba z tego pliku usunąć parametr 'WorkingDirectory'.

Ustawienie własnych logów(plus)Należy usunąć konfigurację dot. parametru o nazwie 'log4jConfigLocation' z pliku web.xml
Migracja zainstalowanych wtyczek(plus)Przekopiować zawartość obecnego katalogu z wtyczkami do nowej lokalizacji (wg info o lokalizacji własnych ustawień).
Migracja zainstalowanych map procesów(plus)Przekopiować zawartość obecnego katalogu z mapami XPDL do nowej lokalizacji (wg info o lokalizacji własnych ustawień).
Migracja logów(minus)Przekopiować zawartość obecnego katalogu z logami do nowej lokalizacji (wg info o lokalizacji własnych ustawień).
Jeśli tego nie zrobimy to logi będą powstawały od nowa w nowej lokalizacji.