Struktura pliku konfiguracyjnego
Do poprawnego działania PlusDirectoryMonitor potrzebuje pliku konfiguracyjnego, który jest podawany przy wywołaniu programu.
Plik konfiguracyjny:
- w formacie INI
- kodowanie powinno być ustawione na UTF-8 bez BOM
- sekcje konfiguracji:
- ustawienia ogólne [Settings]
- konfiguracja webserwisów [WebService]
- ciągu konfiguracji poszczególnych katalogów do monitorowania i związanych z nimi akcjami [ArchN]
- konfiguracji logów programu [Logger]
Ustawienia ogólne
Sekcja [Settings] zawiera podstawowe ustawienia program. Znajdują się tam następujące parametry:
- ProcessAtStartup - określa czy wraz z uruchomieniem programu ma być od razu wykonane przetwarzanie katalogów. Możliwe wartości true/false.
- ProcessOnce - określa czy program ma zostać wywołany jednorazowo i po przetworzeniu zakończyć swoje działanie, czy też ma cyklicznie monitorować katalogi zgodnie z ustawieniami w konfiguracjach przetwarzania katalogów. Możliwe wartości: true/false.
- ShowInfoMessages - w przypadku uruchomienia PlusDirectoryMonitor jako osobny program osadzony w pasku zadań systemu operacyjnego, parametr ten określa czy mają pojawiać się informacje o udanym lub nieudanym przetworzeniu pliku. Możliwe wartości: true/false.
- Login - parametr określający login użytkownika systemu PlusWorkflow, na którym będą dodawane pliki do archiwum dokumentów. Parametr ten przy pierwszy prawidłowym zalogowaniu się do systemu PlusWorkflow jest szyfrowany i w formie zaszyfrowanej zapisywany do pliku konfiguracyjnego. W przypadku konieczności zmiany loginu zaszyfrowaną wartość można zmienić na tekst jawny i przy kolejnym uruchomieniu zostanie ona ponownie zaszyfrowana.
- Password - parametr określający hasło do sytemu PlusWorkflow na użytkownika podanego w parametrze Login. Podobnie jak login przy pierwszej udanej próbie zalogowania jest ono szyfrowane.
- AccessWithWebService (Opcjonalny) - parametr określający, czy korzystać z webservice. Jeżeli parametr nie jest w ogóle podany lub jest ustawiony na false, to domyślnie korzysta z systemowego API. Jeżeli PlusDirectoryMonitor działa jako samodzielna aplikacja, to zawsze wykorzystuje webservice.
| Nazwa parametru | Opis | Uwagi |
|---|
| ProcessAtStartup | Określa czy wraz z uruchomieniem programu ma być od razu wykonane przetwarzanie katalogów. | Możliwe wartości: [true, false] |
| ProcessOnce | Określa czy program ma zostać wywołany jednorazowo i po przetworzeniu zakończyć swoje działanie, czy też ma cyklicznie monitorować katalogi zgodnie z ustawieniami w konfiguracjach przetwarzania katalogów. | Możliwe wartości: [true, false] |
| ShowInfoMessages | W przypadku uruchomienia PlusDirectoryMonitor jako osobny program osadzony w pasku zadań systemu operacyjnego, parametr ten określa czy mają pojawiać się informacje o udanym lub nieudanym przetworzeniu pliku. | Możliwe wartości: [true, false] |
| | | |
Konfiguracja webserwisów
Sekcja [WebService] zawiera konfigurację połączenia do webserwisów systemu PlusWorkflow. Zawiera następujące parametry:
Konfiguracja przetwarzanych katalogów
W celu skonfigurowania przetwarzania katalogu należy utworzyć sekcję [Arch#] w pliku konfiguracyjnym, gdzie # oznacza kolejny numer konfiguracji przetwarzania katalogu. Każda sekcja [Arch#] dotyczy konfiguracji przetwarzania wybranego katalogu. Poszczególne przetwarzania katalogów odbywają się zgodnie z kolejnością umieszczoną w pliku konfiguracyjnym. W sekcji tej można ustawić następujące parametry:
- Active - określa czy dana konfiguracja ma być aktywna. Gdy wartość równa false podana konfiguracja pomijana jest przy przetwarzaniu, gdy wartość równa true przetwarzanie katalogu odbywa się przy każdym uruchomieniu.
- ShareId - nazwa własna utworzonej konfiguracji. Nie ma wpływu na przetwarzanie, jest jedynie wykorzystywana jako identyfikator np. logach programu.
- SharePath - ścieżka do przetwarzanego katalogu. Ta sama ścieżka może być wykorzystywana w różnych konfiguracjach [Arch#].
- SearchSubDirectory - parametr określający czy mają być przetwarzane podkatalogi katalogu podanego w SharePath. Jeśli ustawiony na true to przetwarzane są pliki we wszystkich podkatalogach katalogu ustawionego w SharePath, jeśli ustawiony na false to przetwarzane tylko pliki z będące bezpośrednio w katalogu z SharePath.
- FileRegExp - wyrażenie regularne dopasowywane do plików. Jeżeli wyrażenie nie zostanie dopasowane do danej nazwy pliku to zostanie on pominięty przy przetwarzaniu.
- SortFilesBy - opcjonalny parametr służący do sortowania importowanych plików do systemu Plus Workflow wg(możliwe jest sortowanie po nazwie, w tym celu nalezy ustawić wartość na "name" (SortFilesBy = name), lub sortowanie po dacie, odpowiednio ustawiamy wartość na "date" (SortFilesBy = date). Kierunek sortowania można określić za pomocą parametru "SortFilesDirection" (Opisany w poniższym podpunkcie). Domyślnie sortowanie jest wyłączone.
- SortFilesDirection - opcjonalny parametr służący do ustawienia kierunku sortowania importowanych plików. Domyślnie ustawione jest sortowanie rosnąco. W celu ustawienia sortowania malejącego należy ustawić wartość na "SortFilesDirection = desc". W przypadku sortowania po dacie w dla pokrywających się dat sortowanie automatycznie odbywa się po nazwie.
Konfiguracja logów
Plik konfiguracyjny jest przy starcie programu wykorzystywany przy konfiguracji logów log4j. Konfiguracja taka powinna być umieszczona w sekcji [Logger] i powinna być zgodna ze standardem konfiguracji log4j. Przykładowa konfiguracja:
log4j.appender.PlusDirectoryMonitor = com.plusmpm.util.logger.DailyRollingFileAppender
log4j.appender.PlusDirectoryMonitor.Threshold = DEBUG
log4j.appender.PlusDirectoryMonitor.File = /home/plusmpm/Logs/PlusDirectoryMonitor.log
log4j.appender.PlusDirectoryMonitor.DatePattern = '.'yyyyMMdd
log4j.appender.PlusDirectoryMonitor.layout = org.apache.log4j.PatternLayout
log4j.appender.PlusDirectoryMonitor.layout.ConversionPattern = %-12t%d{yy-MM-dd HH:mm:ss,SSS} %-5p%23C{1}:%-6L-%x- %m%n
log4j.logger.com.plusmpm.directorymonitor=DEBUG,PlusDirectoryMonitor