...
Do uruchomienia programu, poza archiwum JAR z tym programem, niezbędna jest maszyna wirtualna Java (JRE) w wersji 5.0 oraz archiwum JAR ze sterownikiem JDBC. Uruchomienie programu następuje poprzez wykonanie następującego polecenia (w jednej linijce):
| No Format |
|---|
java -cp <ścieżka do archiwum JAR ze sterownikiem JDBC> -jar <ścieżka do archiwum JAR z programem> <ścieżka do pliku konfiguracyjnego> <ścieżka do katalogu przeznaczonego na wygenerowany raport> |
PrzykładowoDla konkretnej instalacji opartej na bazie Oracle może ono wyglądać tak:
| No Format |
|---|
java -cp ojdbc14.jar -jar dl-db-analyzer-current.jar moj.conf c:\testy\raport |
Dalsze funkcjonowanie programu zależy od parametrów konfiguracyjnych zdefiniowanych w pliku, którego nazwa została podana jako jeden z parametrów programu powyżej. Plik ten powinien być plikiem tekstowym, w którym każda linijka zawiera informacje na temat odrębnego parametry konfiguracyjnego i ma następującą składnię:
| No Format |
|---|
nazwa parametru=wartość parametru
|
Parametry konfiguracyjne Parametry te można podzielić na parametry ogólne (dotyczące wszystkich rodzajów raportów) oraz parametry związane z konkretnym rodzajem raportu. Aktualnie wyróżnia się następujące parametry ogólne:parametry opisane poniżej.
Ogólne parametry konfiguracyjne
...
Parametry połączenia z bazą danych
...
| No Format |
|---|
hibernate.connection.driver_class hibernate.connection.url hibernate.connection.username hibernate.connection.password |
Powyższe parametry konfigurują połączenie z bazą danych biblioteki cyfrowej, a ich wartości powinny być skopiowane z pliku konfiguracyjnego database.properties znajdującego się w podkatalogu conf katalogu z serwerem dLibry.
| Note | ||
|---|---|---|
| ||
Analizator bazy danych będzie pracował na bazie danych Państwa biblioteki cyfrowej. Nie dokonuje on zmian w tej bazie, jednak jego działanie może w znacznym stopniu tę bazę obciążyć. Dlatego też zaleca się generowanie raportów w godzinach mniejszego obciążenia biblioteki cyfrowej żądaniami czytelników lub też pracę na kopii bazy danych biblioteki. |
...
Inne parametry ogólne
...
| No Format |
|---|
libraryAddress |
className=pl.psnc.dlibra.server.util.databaseanalyser.tagcloud.OAITagCloudGenerator
Ogólne parametry konfiguracyjne
Parametry konfiguracyjne poszczególnych raportów
Wartość tego parametru zawiera adres WWW stron biblioteki cyfrowej, dla której generowany jest raport. Wartość ta wykorzystywana jest do generowania hiperłączy w raporcie i powinna kończyć się znakiem /. Przykładowe poprawne wartości to http://www.wbc.poznan.pl/ czy 
http://dlibra.psnc.pl/biblioteka/.
| No Format |
|---|
className
|
Nazwa klasy odpowiadająca typowi generowanego raportu. Nazwa ta zmienia się w zależności od raportu - szczegółowe informacje znajdują się poniżej, przy informacjach dotyczących konkretnych raportów.
Dostępne raporty
Raport na temat wydań opublikowanych przez określonych użytkowników w określonych zakresie czasu
Raport pozwalający na wygenerowanie zestawienia opublikowanych wydań dodanych przez określonych użytkowników (jeden lub wielu) w podanym zakresie czasu (z dokładnością do miesiąca). Raport zawiera również liczbę wyświetleń każdej publikacji do momentu wygenerowania raportu. Przykładowy raport dla Biblioteki Cyfrowej Projektu dLibra można obejrzeć tutaj.
W celu wygenerowania tego raportu należy podać następującą wartość parametru className:
| No Format |
|---|
className=pl.psnc.dlibra.server.util.databaseanalyser.editorstats.EditorStatsGenerator
|
...
Parametry konfiguracyjne raportu
...
| No Format |
|---|
esg.startMonth=2005.01
esg.endMonth=2007.12
|
Pierwszy i ostatni miesiąc zakresu, dla którego ma zostać wygenerowany raport. Format daty to <rok - 4 cyfry>.<miesiąc - 2 cyfry>. Powyższe wartości spowodują wygenerowanie raportu za okres od stycznia 2005 do grudnia 2007 włącznie.
| No Format |
|---|
esg.users=red1,red2
|
Lista loginów użytkowników (redaktorów), dla których ma być wygenerowany raport. W raporcie będę uwzględnione te publikacje, które ostatnio modyfikowali podani użytkownicy. Można podać jednego użytkownika lub kilku, przy czym poszczególne loginy należy rozdzielać znakiem przecinka.
| No Format |
|---|
esg.separated=false
|
Wartość tego parametru określa, czy raport będzie wygenerowany do pojedynczego pliku (wartość false) czy też dane z poszczególnych miesięcy będą zawarte w osobnych plikach (wartość true).