Wstęp

Katalog domowy jest jednym wspólnym miejscem do trzymania następujących elementów PlusWorkflow:

konfiguracji:
- bazy danych,
-parametrów systemu,
-logów,
danych:
-pliki logów,
-zainstalowane wtyczki,
-katalog tymczasowy,
-mapy procesów.

Włączenie katalogu domowego na nowym systemie

Na nowych systemach katalog domowy domyślnie jest włączony (parametr plusworkflow.home w pliku web.xml domyślnie ustawiony na '../PlusWorkflow Home'). Wystarczy ustawić konfigurację bazy danych (w <home-dir>/config/db.properties), a pozostałe ustawienia najlepiej pozostawić domyślne. Dla systemów tymczasowych (np.demonstracyjnych) także ustawienie bazy danych nie jest potrzebne, wtedy PlusWorkflow uruchomi się na wbudowanej bazie.

Z kolei w przypadku instalowania nowego systemu instalatorem wystarczy podać ścieżkę katalogu domowego oraz konfigurację bazy danych w oknie instalatora.

Zmiana ustawień katalogu domowego

Ustawienia katalogu domowego można ustawić poprzez konfigurację jego następujących elementów. Aczkolwiek poza konfiguracją bazy danych, zalecane jest pozostawienie domyślnych ustawień.

Konfiguracja ścieżki katalogu

Lokalizacja: parametr plusworkflow.home w web.xml

Ustawienie ścieżki katalogu jest obligatoryjne, bo decyduje o włączeniu katalogu domowego. Ustawiona tu ścieżka jest dalej w instrukcji określana jako <home-dir>.

Domyślne ustawienie

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

Konfiguracja bazy danych

Lokalizacja: parametry w pliku <home-dir>/config/db.properties

Domyślne ustawienia

# 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 dotyczące bazy danych (sekcja 'Database connection configuration'), nie są uzupełnione to system domyślnie uruchomi się na wbudowanej bazie PostgreSQL.

Jeżeli parametry dotyczące bazy danych (sekcja 'Database connection configuration'), nie są uzupełnione to system domyślnie uruchomi się na zewnętrznej bazie danych, która została w tym pliku skonfigurowana.

Jeżeli parametr db.connectionUrl zostawimy pusty, to wygeneruje się on automatycznie, na podstawie pozostałych parametrów. Ma on dodatkowo wyższy priorytet przy łączeniu z bazą, dlatego jeżeli db.connectionUrl będzie wskazywał na inną bazę, niż parametry wyżej, to system będzie próbował połączyć z bazą na podstawie podanego URLa.

Sterowniki JDBC

Nie należy dodawać sterowników JDBC ręcznie do Tomcata, gdyż projekt systemu zawiera je już w sobie (Postgres, Oracle, SQL Server).

Konfiguracja parametrów systemu

Lokalizacja: PlusWorkflow w 'Administracja' -> 'Konfiguracja systemu' -> 'Parametry systemowe' V3.2.22+

Od wersji 3.2.22 zalecanym sposobem zmiany parametrów jest ich zmiana bezpośrednio w PlusWorkflow.
Natomiast w starszych wersjach można to zrobić poprzez własne ustawienia wartości parametrów w <home-dir>/config/PlusWorkflow.conf

Konfiguracja logów

Lokalizacja: parametry w pliku <home-dir>/config/Log4j.xml

Polega na podpięciu własnego pliku ustawień log4j.

Lokalizacja danych

Jeśli katalog domowy jest włączony to w ustawionym folderze znajdują się następujące dane dotyczące działania PlusWorkflow:

Dane	Lokalizacja	Uwagi
Pliki logów	<home-dir>/logs	to domyślna lokalizacja, którą ewentualnie można zmienić zgodnie z opisem w Konfiguracja logów
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:

wczytywana jest konfiguracja z PlusWorkflow.conf po staremu (parametr w web.xml)
baza danych pobierana jest z context.xml
wtyczki przechowywane są w starym katalogu (skonfigurowanym w suncode-plugins.xml)

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.

Włączenie katalogu domowego 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 kroki w zależności od potrzeb :

Opis kroku	Wymagane	Dodatkowe informacje
Ustaw ścieżkę katalogu w parametrze plusworkflow.home w web.xml (włączenie katalogu domowego)
Przenieś ustawienia bazy danych z context.xml do pliku <home-dir>/config/db.properties		Usuń konfigurację bazy z pliku context.xml i web.xml (tag 'resource-ref').
Przenieś ustawienia parametrów z PlusWorkflow.conf, które mają ustawienia różne od domyślnych. Zmień wartości domyślne parametrów w PlusWorkflow w Administracja' -> 'Konfiguracja systemu' -> 'Parametry systemowe'		Usuń 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 usunięcie 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 web.xml usunąć parametr 'WorkingDirectory'.
Przenieś zawartość dotychczasowego katalogu z wtyczkami do <home-dir>/data/plugins (lub ew. zainstaluj wtyczki od nowa)
Przenieś zawartość dotychczasowego katalogu z mapami procesów do <home-dir>/XPDL
Ustaw domyślne logi (zalecane) parametrem log4jConfigLocation w web.xml lub przenieś własne ustawienia logów		Ustaw wartość parametru log4jConfigLocation na 'classpath:Log4j.xml', wtedy domyślne loggery będą zapisywały logi do domyślnej lokalizacji tj. <home-dir>/logs. Lub tylko jeśli to niezbędne, bo nie jest zalecane, ustaw własne ustawienia logów przenosząc plik Log4j.xml do <home-dir>/config, a w parametrze log4jConfigLocation ustaw poprawną ścieżkę do <home-dir>/config/Log4j.xml. Oraz w pliku Log4j.xml ustaw ścieżki powstawania logów na <home-dir>/logs.
Jeśli przeniesiono własne ustawienia logów i została w nich zmieniona lokalizacja powstawania plików z logami, a chcesz kontynuować poprzednie pliki logów to przekopiuj zawartość wcześniejszego katalogu z logami do nowej lokalizacji (ustawionej w <home-dir>/config/Log4j.xml)