Konfiguracja programu PlusIndex

Konfiguracja programu PlusIndex odbywa się w pliku config.ini zlokalizowanym w katalogu instalacji aplikacji (zazwyczaj jest to katalog: C:\Program Files\PlusIndex\ ). Poniżej znajduje się szczegółowy opis tego pliku.

Konfiguracja zasobów

• folder_zrodlowy - Folder źródłowy to folder, do którego będą trafiać zeskanowane dokumenty i który podlega monitorowaniu przez aplikację. Może on zawierać podfoldery i wówczas i one będą monitorowane przez aplikację.
• folder_docelowy - Folder, do którego trafiają zatwierdzone przez użytkownika w aplikacji dokumenty. Z folderu tego dokumenty będą wysyłane do systemu przez usługę sieciową, zdefiniowaną pod adresem podaną w parametrze url
• folder_archiwum - Folder, do którego kopiowane są wszystkie dokumenty z folderu źródłowego. Kopiowanie to następuje przed przetwarzaniem dokumentów w przypadku, gdy parametr zapis_do_archiwum ma wartość true.
• folder_tymczasowy - Folder tymczasowy aplikacji, do którego zapisywane są wszystkie robocze pliki powstające podczas pracy aplikacji.

• zapis_do_archiwum = false | true - Parametr określający czy przed przetworzeniem dokumentów, źródłowe wersje dokumentów (w postaci oryginalnej) mają być skopiowane (zarchiwizowane) w katalogu określonym parametrem folder_archiwum.

  Zapis true | false oznacza iż określony parametr może mieć wartość albo true albo false.

Ustawienia logowania działania aplikacji

Aplikacja PlusIndex posiada dwa sposoby logowania operacji jakie wykonuje. W logach tych zapisywane są informacje pozwalające na diagnozę ewentualnych problemów występujących w aplikacji. Parametrem decydującym o sposobie zapisu jest parametr logType.

1. logType = eventLog - Zapis informacji do eventLogu środowiska Windows. Ważne jest by użytkownik, który uruchamia aplikację miał uprawnienia do zapisu i czyszczenia eventLogu środowiska Windows.

2. logType = fileLog - Zapis informacji odbywa się do pliku tekstowego. Nazwę i ścieżkę zapisu pliku logowania definiuje się w pliku PlusIndex.exe.config. W pliku tym w sekcji log4net należy ustawić odpowiednio parametr File:

   Fragment pliku PlusIndex.exe.config

   	<log4net>
           <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
               <param name="File" value="c:\Temp\PlusIndex.log" />
               <param name="AppendToFile" value="true" />
               <layout type="log4net.Layout.PatternLayout">
                   <param name="Header" value="[Start]\r\n" />
                   <param name="Footer" value="[Stop]\r\n" />
                   <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
               </layout>
           </appender>        
           <root>
               <level value="INFO" />
               <appender-ref ref="LogFileAppender" />            
           </root>
       </log4net>    

    
   

Obsługiwane formaty plików

Aplikacja PlusIndex obsługuje większość graficznych typów plików. Lista obsługiwanych plików wygląda następująco: tif, pdf, jpg, bmp, pcx, gif, png. Aby określić, które z podanych rozszerzeń mają być brane pod uwagę przez aplikację należy ustawić parametr formaty_plikow podając po przecinku wmagane rozszerzenia.

• formaty_plikow = *.tif,*.pdf,*.jpg,*.bmp,*.pcx,*.gif,*.png

Ponadto w aplikacji można też podać format wysyłanych dokumentów. Jeśli parametr wysylanie_w_PDF ma wartość inną niż true, wówczas dokumenty wysyłane są w formacie natywnym. Jeśli jednak parametr ten ma wartość true, wówczas wszystkie dokumenty przed wysłaniem konwertowane są do formatu pdf.

• wysylanie_w_PDF = true | false

Działanie aplikacji w tle

Aplikacja PlusIndex potrafi automatycznie przetwarzać dokumenty znajdując się w tzw. tray, tzn. w momencie gdy jest zminimalizowana. O jej zachowaniu decyduje kilka parametrów:

• automatyczne_przetwarzanie = true | false - parametr określający, czy kody na dokumentach z folderu źródłowego rozpoznawane będą automatycznie, czy jedynie ręcznie przez użytkownika po wybraniu opcji Rozpoznaj.
• automatyczne_zatwierdzanie = true | false - parametr określający, czy dokumenty z rozpoznanymi kodami i klasami dokumentów będą automatycznie wysyłane do systemu Plus Workflow czy dopiero w momencie wyboru przez użytkownika opcji Zatwierdź wszystkie bądź opcji Zatwierdź (dostępnej z poziomu menu kontekstowego na poszczególnych dokumentach)

Konfiguracja połączenia z systemem

Aplikacja PlusIndex do łączenia się z systemem wykorzystuje WebService'y udostępniane przez system PlusWorkflow. Z tego też względu do poprawnej pracy aplikacji wymagane jest otwarcie portu pod którym działa system PlusWorkflow. Adres pod którym znajduje się system definiuje się w parametrze url podając adres usługi sieciowej:

• url=<adres system>/services/ReleaseService

url=http://localhost:8080/PlusWorkflow/services/ReleaseService

W aplikacji można również zdefiniować sposób logowania się do aplikacji. Przed rozpoczęciem pracy należy zautoryzować się użytkownikiem systemu PlusWorkflow podając jego login, hasło oraz ewentualnie domenę. Możliwe jest również ustawienie aplikacji w taki sposób by kolejne uruchamianie aplikacji nie wymagało logowania się. Służą do tego dwa parametry sso oraz uzytkownik. W przypadku gdy parametr sso ma wartość true a poprzednio do aplikacji zalogował się użytkownik zdefiniowany w parametrze uzytkownik wówczas dostęp do aplikacji uzyskiwany jest bez logowania.

• sso = true | false
• uzytkownik = <nazwa uzytkownika>

Definicja zegarów aplikacji

W aplikacji PlusIndex można zdefiniować czasy co jaki będą wykonywane niektóre operacje w sposób automatyczne. Parametr zegar_odswiezania determinuje częstotliwość monitorowania folderu źródłowego w poszukiwaniu nowych plików do przetworzenia. Możliwe jest również ustawienie czasu co jaki znalezione w folderze źródłowym dokumenty mają być przetwarzane. Decyduje o tym parametr o nazwie zegar_przetwarzania. Oba parametry podawane są w milisekundach.

• zegar_odswiezania = <wartość całkowita w ms>
• zegar_przetwarzania = <wartość całkowita w ms>

Ponadto możliwe jest również zdefiniowanie globalnego czasu, o której dokumenty mają zostać przesyłane do systemu PlusWorkflow. Służy do tego parametr o nazwie czas_wyslania. Możliwe jest podanie kilka godzin o której ma następować wysyłka dokumentów. Wówczas kolejne godziny rozdzielane są średnikiem.

• czas_wyslania = HH:MM;[HH:MM]

W przypadku zatwierdzenia przez użytkownika przetworzonych dokumentów, otrzymuje on pytanie kiedy dokumenty mają zostać przesłane do systemu.

Możliwe są następujące warianty wyboru:

1. W przypadku wyboru opcji Tak, dokumenty wysyłane są natychmiast.
2. W przypadku wyboru opcji Nie, dokumenty wysyłane są o godzinach zdefiniowanych w parametrze czas_wyslania
3. W przypadku wyboru opcji Anuluj wysyłka dokumentów zostaje przerwana.

Ustawienia orientacji rozpoznawania kodów

Aplikacja PlusIndex umożliwia określenie orientacji rozpoznawania kodów kreskowych. Parametrem określającym to rozpoznawaniem są: 0st, 90st, 180st, 270 st.

• 0st = true | false
• 90st = true | false
• 180st = true | false
• 270st = true | false

Określenie formatów rozpoznawanych kodów kreskowych

Aplikacja PlusIndex potrafi rozpoznawać większość popularnych typów kodów kreskowych. Wspieranymi typami kodów są: Code11, Code39, Code93, Code128, 2of5Interleaved, Codabar, EAN8, EAN13, UPCA, UPCE, Add2, Add5, PostNet, PDF417, DataMatrix, QRCode. Możliwe jest również włączenie rozpoznawania tylko wybranych kodów (np. po to by ignorować obce kody w innych formatach). Aby to zrobić parametrowi odpowiadającemu nazwie typu kodu należy przypisać wartość true. W przeciwnym wypadku parametr ten musi mieć wartość false.

Kody jednowymiarowe

• Code11 = true | false
• Code39 = true | false
• Code93 = true | false
• Code128 = true | false
• 2of5Interleaved = true | false
• Codabar = true | false
• EAN8 = true | false
• EAN13 = true | false
• UPCA = true | false
• UPCE = true | false
• Add2 = true | false
• Add5 = true | false

Kody pocztowe

• PostNet = true | false

Kody dwuwymiarowe

• PDF417 = true | false
• DataMatrix = true | false
• QRCode = true | false

Definicja klas dokumentów

W aplikacji PlusIndex możliwa jest obsługa wielu typów dokumentów tzw. klas dokumentów. Przydział przetworzonego dokumentu do danej klasy może odbywać się na podstawie rozpoznanego kodu kreskowego lub jego fragmentu lub też typ ten może być ręcznie wskazany przez użytkownika. Opisy poszczególnych klas powinny być podane w sekcjach: [klasa nr], przy czym jest to tylko wewnętrzny identyfikator definiujący sekcję opisującą przetwarzanie danego typu dokumentów. Identyfikator ten zawsze powinien składać się ze słowa "klasa" po którym musi występować kolejny numer zaczynając od jedynki. Definicja poszczególnych klas wygląda następująco:

[klasa 1]
nazwa_klasy = <dowolna nazwa klasy>
id_klasy = <identyfikator klasy z systemu PlusWorkflow>
regex = <wyrażenie regularne określające wzorzec dopasowania rozpoznanego kodu>
<nazwa indeksu 1> = <barcode>|stala wartosc
.....
<nazwa indeksu n> = <barcode>|stala wartosc
czas_wyslania = HH:MM;[HH:MM]
nowa_wersja_dokumentu = true | false

Znaczenie poszczególnych parametrów jest następujące:

• nazwa_klasy - dowolna nazwa klasy dokumentów identyfikująca poszczególne typy dokumentów. Nie musi mieć takiej samej nazwy co w systemie PlusWorkflow
• id_klasy - unikalny identyfikator klasy dokumentów z systemu PlusWorkflow
• regex - wyrażenie regularne określające wzorzec dopasowania rozpoznanego kodu kreskowego. W momencie znalezienia kodu kreskowego z wartością pasującą do podanego wzorca, dokument ten zostanie przypisany do tej klasy.
• nazwa_indeksu - nazwa indeksu z systemu PlusWorkflow z klasy o identyfikatorze podanym w parametrze id_klasy. Wartością tego parametru może być albo predefiniowana stała o nazwie <barcode> oznaczająca rozpoznany z dokumentu kod kreskowy. Indeksowi temu można też przypisać dowolnie inną stałą teksotwą, typu lokalizacja skanowania, osoba skanująca itp. W definicji danej klasy można wymienić więcej niż jeden indeks z podanymi np. wartościami stałymi (domyślnymi)
• czas_wyslania - godzina określająca czas, o której dokumenty przypisane do tej klasy dokumentów, zostaną przesłane do systemu PlusWorkflow. Parametr niewymagalny. W przypadku jego braku zostanie użyta zmienna globalna określona w sekcji [zegary]
• nowa_wersja_dokumentu - parametr określający czy wysyłany dokument w przypadku występowania takich samych wartości indeksów ma być zapisany jako nowa wersja (wartość parametru true) czy jako nowy dokument (wartość false).

Definicja separacji dokumentów

Aplikacja PlusIndex posiada kilka metod separacji dokumentów. O ile definicja wyrażeń regularnych w sekcji klasy dokumentów określa przynależność danego dokumentu do danej klasy dokumentów, o tyle definicja wyrażeń regularnych w separacji dokumentów określa wspólne grupy dokumentów. Pojęcie grupy dokumentów dotyczy kilku dokumentów, być może należących do różnych klas dokumentów, które mogą zostać opisane wspólnymi wartościami różnych indeksów. W aplikacji można zdefiniować nadrzędną klasę dokumentów, z której odczytana wartość danego indeksu może zostać przepisana do innego dokumentu należącego do innej kasy dokumentów w ramach tej samej grupy. Aby określić tą klasę należy zdefiniować wartość wyrażenia regularnego dopasowującego odczytany kod kreskowy do podanego wzorca. Nazwą parametru musi być nazwa klasy dokumentów podana w parametrze nazwa_klasy w sekcji klasy dokumentów a wartością wyrażenie regularne:

• <dowolna nazwa klasy z sekcji klasy> = wyrażenie regularne określające wzorzec dopasowania rozpoznanego kodu kreskowego dla separacji. W momencie znalezienia kodu kreskowego z wartością pasującą do podanego wzorca, dokument ten tworzy nową grupę dokumentów w ramach której może następować wspólne indeksowanie.

W sekcji separacji dokumentów można również określić tryb separacji. Tryb ten opisany jest parametrem o nazwie tryb:

• tryb = simplex | simplex_page | duplex

i może przyjmować wartości simplex, simplex_page lub duplex.

• simplex oznacza że dokumenty skanowane są jednostronnie a kod kreskowy znajduje się na osobnym arkuszu, który nie jest zapisywany do dopasowanej klasy dokumentów,
• simplex_page oznacza że dokumenty skanowane są jednostronnie a kod kreskowy znajduje się na pierwszej stronie dokumentu przypisanego do dopasowanej klasy dokumentów,
• duplex oznacza że skanowanie jest dwustronne i obie strony pomijane są w zapisie dokumentu
  
  

Określenie wspólnych indeksów

Jak wspomniano w poprzednim punkcie, aplikacja PlusIndex umożliwia grupowy opis wszystkich dokumentów należących do tej samej grupy. Dana grupa może posiadać wspólne indeksy zachowujące się w ten sposób, iż zmiana wartości indeksu w dowolnym dokumencie z grupy powoduje zmianę wartości indeksów w pozostałych dokumentach, o ile należą one do klasy dla której zdefiniowano takie łączenie indeksów. Definicję taką tworzy się w sekcji [sticking] w której jako parametr podaje się nazwę indeksu, dla którego chcemy włączyć przepisywanie wartości, a jako wartość podawane są albo nazwy klas dokumentów z sekcji klas, dla których ma być włączone przepisywanie indeksów (oddzielone średnikami), albo * (gwiazdka), określająca iż przepisywanie indeksów ma się odbywać w ramach wszystkich klas dokumentów.

• <nazwa indeksu 1> = * | <dowolna nazwa klasy z sekcji klasy 1>;<dowolna nazwa klasy z sekcji klasy 2>;.....;<dowolna nazwa klasy z sekcji klasy n>
• ....
• <nazwa indeksu n> = * | <dowolna nazwa klasy z sekcji klasy 1>;<dowolna nazwa klasy z sekcji klasy 2>;.....;<dowolna nazwa klasy z sekcji klasy n>