Wstęp
Katalog domowy jest jednym wspólnym miejscem do trzymania danych/ustawień aplikacji takich jak:
- logi (domyślnie)
- wtyczki
- konfiguracja
- XPDL
- 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.
| Element | Domyślne ustawienia | Lokalizacja własnych ustawień | Uwagi |
|---|---|---|---|
| Konfiguracja ścieżki katalogu | brak (wyjątek instalowanie za pomocą instalatora) | parametr plusworkflow.home w web.xml | Ten element decyduje o włączeniu katalogu domowego. |
| Konfiguracja bazy danych | wbudowane 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. Obecnie zaleca się ustawiać własne ustawienia parametrów w Administracja->Konfiguracja systemu->Parametry systemu. |
| Konfiguracja logów | wbudowane 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.
| Element | Lokalizacja | Uwagi |
|---|---|---|
| Pliki logów | <home-dir>/logs | ale 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:
- 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.
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
Od wersji 3.2.2X 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
Jednak aby po raz pierwszy włączyć katalog domowy, nie wszystkie ustawienia są konieczne. Są z kolei być potrzebne dodatkowe kroki, jeśli chcemy włączyć katalog domowy na działającym już systemie.
Poniższy opis pokazuje co trzeba zrobić w różnych sytuacjach.
Na nowo instalowanym systemie
Na nowo przygotowywanym systemie, aby działał on z Katalogiem domowym należy wykonać następujące ustawienia w zależności od potrzeb i sposobu instalacji.
Instalowanym bez Instalatora
| Wymagane | Uwagi | |
|---|---|---|
| Ustawienie ścieżki katalogu | ||
| Ustawienie własnej bazy danych | *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 | ||
| Ustawienie własnych logów |
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 konfiguracja zostanie odpowiednio wypełniona 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ć analogicznie jak opisano w Konfiguracji dla nowego systemu.
Na działającym systemie (bez katalogu domowego)
Aby zmigrować do katalogu domowego system, który wcześniej działał bez katalogu domowego z tą samą bazą danych, należy wykonać następujące ustawienia w zależności od potrzeb :
| Wymagane | Uwagi | |
|---|---|---|
| Ustawienie ścieżki katalogu | ||
| Ustawienie własnej bazy danych | Należy usunąć konfigurację bazy z pliku context.xml i web.xml (tag 'resource-ref'). | |
| Ustawienie własnych wartości wybranych parametrów systemu | Należy usunąć konfigurację parametru 'Shark_Conf' z pliku web.xml | |
| Ustawienie własnych logów | Należy usunąć konfigurację dot. parametru o nazwie 'log4jConfigLocation' z pliku web.xml | |
| Migracja zainstalowanych wtyczek | Przekopiować zawartość obecnego katalogu z wtyczkami do nowej lokalizacji (wg info o lokalizacji własnych ustawień). | |
| Migracja zainstalowanych map procesów | Przekopiować zawartość obecnego katalogu z mapami XPDL do nowej lokalizacji (wg info o lokalizacji własnych ustawień). | |
| Migracja logów | 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. |
