Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Informacje ogólne

Opisywane narzędzie służy do dodawania plików do publikacji planowanej. Pliki jakie mają zostać dodane, użytkownika w imieniu którego pliki będą dodawane oraz publikację do której pliki zostaną dodane wskazywane są w parametrach konfiguracyjnych tego narzędzia. Narzędzie to uruchamiane jest z linii poleceń i jest dedykowane do wykorzystania w mechanizmach automatyzacji pracy redaktorów biblioteki cyfrowej. Przykładowo może być wykorzystany wtedy gdy mamy zdefiniowany taki oto proces pracy redaktora:

  1. Redaktor tworzy publikację planowaną wprowadzając w jej właściwościach: metadane, prawa użytkowników, przypisanie do kolekcji.
  2. Redaktor skanuje analogową postać publikacji do plików wysokiej jakości (np. do plików graficznych wysokiej rozdzielczości).
  3. Redaktor przesyła pliki wysokiej jakości do systemu automatycznego wprowadzania publikacji.
  4. System automatycznego wprowadzania publikacji konwertuje pliki wysokiej rozdzielczości do plików w formacie w którym biblioteka cyfrowa prezentuje zdigitalizowane zbiory (np. do plików w formacie PDF lub DjVu) oraz wykorzystuje opisywane w tym rozdziale narzędzie do automatycznego dodania tych plików do publikacji planowanej.

W wyniku tych operacji w bibliotece cyfrowej pojawia się normalna publikacja utworzona poprzez automatyczne dodanie plików publikacji. Dzięki temu redaktor może skupić się na wyborze publikacji do skanowania i skanowaniu odpowiednich dokumentów. Resztą (od momenu zeskanowania i przesłania plików) zajmuje się system automatyzacji pracy redaktorów.

Narzędzie znajduje się w każdej wersji dystrybucji systemu dLibra, w katalogu binaries/dlibra-client-publication-files-uploader. Katalog ten zawiera następujące elementy:

  • lib - katalog zawierający potrzebne biblioteki do uruchomienia narzędzia
  • config.xml - plik zawierający informacje o serwerze do którego narzędzie dodawania plików ma się podłączyć
  • users.xml - informacje o użytkownikach w imieniu których narzędzie będzie dodawało pliki do publikacji planowanej.
  • run.bat - skrypt uruchamiający narzędzie w środowisku systemów z rodziny Windows
  • run.sh - skrypt uruchamiający narzędzie w środowisku systemów z rodziny Linux

Do uruchomienia narzędzia do dodawania plików do publikacji planowanej wymagana jest zainstalowana maszyna wirtualna Javy autorstwa firmy Sun w wersji 1.8 lub nowszej. Zazwyczaj po aktualizacji systemu dLibra nie jest potrzebne ponowne pobranie plików narzędzia (chyba że narzędzie przestanie działać).

Konfiguracja narzędzia

Plik config.xml

Plik config.xml jest plikiem XML w którym zapisane są informacje wskazujące na serwer dLibra do którego narzędzie ma zostać podłączone. W pliku można zdefiniować dwie właściwości:

  • Adres serwera dLibra (klucz server)
  • Port na którym serwer dLibra nasłuchuje na połączenia (klucz port)

Domyślny plik wygląda następująco:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>
Configuration file for files uploader. 
Properties in this file specify: server host and server port.
1. Server host
In order to specify server host place an entry which has 'server' as a key. Value specified for this key determines the server host used by the files uploader.
2. Server port
In order to speciy server port place an entry which has 'port' as a key. Value specified for this key determines the server port user by the files uploader.
</comment>
<entry key="server">localhost</entry>
<entry key="port">10051</entry>
</properties>

Jak widać na przykładzie narzędzie będzie podłączało się do lokalnego komputera localhost na porcie 10051.

Plik users.xml

W pliku users.xml znajdują się informacje o użytkownikach w imieniu których narzędzie będzie w stanie dodawać pliki publikacji. Jest to prosty plik XML, który definiuje właściwości gdzie kluczem jest login użytkownika a wartością hasło dostępu do jego konta. Przykładowy plik przedstawiono poniżej:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>
Configuration file for files uploader. 
Properties in this file specify information about users on behalf of which this files uploader works
Each entry in this file is composed of key and value. Key indicates user login and value indicates password for this user.
</comment>
<entry key="jkowalski">mojehaslo</entry>
</properties>

W pliku zdefiniowano dane dostępowe dla jednego użytkownika - login jkowalski oraz jego hasło mojehaslo.

Uruchamianie narzędzia

Skrypty run.bat oraz run.sh mają dwa parametry. Pierwszym jest ścieżka do pliku głównego publikacji. Drugim jest wartość true lub false oznaczająca czy po dodaniu plików nowo stworzone wydanie ma być opublikowane (true) czy nie (false).
Pierwszy parametr poza wskazaniem pliku głównego ma jeszcze dodatkowe znaczenie ponieważ poszczególne elementy ścieżki określają użytkownika w imieniu którego pliki mają być dodane oraz identyfikator publikacji planowanej. Ścieżka ta składa się z następujących elementów:

<PREFIX>/<USER_ID>/out/<PUB_ID>/<MAIN_FILE_NAME>

I tak:

  • <PREFIX> to pierwsza część ścieżki nieistotna z punktu widzenia narzędzia
  • <USER_ID> jest katalogiem którego nazwa jest loginem użytkownika w imieniu którego narzędzie ma dodać pliki publikacji
  • out jest katalogiem zawierającym publikacje danego użytkownika
  • <PUB_ID> jest katalogiem którego nazwa jest identyfikatorem publikacji planowanej do której mają zostać dodane pliki publikacji; zawiera wszystkie pliki publikacji
  • <MAIN_FILE_NAME> jest nazwą pliku głównego publikacji

Przykładowe wykonanie skryptu wygląda następująco:

run C:\pliki\jkowalski\out\223\directory.djvu true

W pierwszym parametrze prefiksem jest C:\pliki, loginem użytkownika jest jkowalski, identyfikatorem publikacji planowanej jest 223 natomiast plik główny publikacji to directory.djvu.
Po wykonaniu tej komendy narzędzie doda do publikacji planowanej o identyfikatorze 223 wszystkie pliki z katalogu C:\pliki\jkowalski\out\223. Plikiem głównym publikacji będzie directory.djvu natomiast publikacja zostanie dodana w imieniu użytkownika jkowalski.

  • No labels