Versions Compared

Old Version 8

changes.mady.by.user Grzegorz Konowalczyk

Saved on

compared with

New Version 9

changes.mady.by.user Grzegorz Konowalczyk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parametry ogólne
Nazwa parametruOpisUwagi
ActiveOkreś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.
ShareIdNazwa własna utworzonej konfiguracji.Nie ma wpływu na przetwarzanie, jest jedynie wykorzystywana jako identyfikator np. logach programu.
SharePathŚcieżka przetwarzanego katalogu.Ta sama ścieżka może być wykorzystywana w różnych konfiguracjach [Arch#].
ArchiveClassIdentyfikator klasy dokumentów.

Wartość w postaci liczby całkowitej.

SearchSubDirectoryParametr 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.
SaveAsNewVersionParametr określający, czy w przypadku takich samych indeksów dokument zapisać jako nowa wersja.Możliwe wartości: [true, false]
ProcessFilesUnmodifiedByCzas od momentu modyfikacji pliku, po jakim zaczynać dopiero przetwarzanie pliku.Wartość w postaci liczby całkowitej reprezentująca liczbę minut od momentu modyfikacji pliku, po jakiej zaczynać dopiero przetwarzanie pliku.
SortFilesByOpcjonalny parametr służący do określenia kolejności importowania dokumentów.

Możliwe wartości:

  • name - sortowanie po nazwie,
  • date - sortowanie po dacie.

Domyślnie kolejność przetwarzania jest nieokreślona.

SortFilesDirectionOpcjonalny parametr słuzący do określenia kierunku przetwarzania importowania dokumentów.

Możliwe wartości:

  • asc - rosnąco,
  • desc - malejąco.

Domyślnie kierunek przetwarzania jest rosnący.

FileTypeTyp przetwarzanych dokumentów, domyslnie raw.

Możliwe wartości: [RAW, XML].

Gdy podany jest nieobsługiwany typ to plik jest pomijany

FileRegExpRegex, po którym następuje filtrowanie plików po ich pełnych ścieżkachJeżeli pełna ścieżka pliku nie spełnia regexa, to plik jest pomijany.
FileNameRegExmpRegex, po którym następuje filtrowanie plików po ich nazwach.Jeśli nazwa pliku nie spełnia regexa, to plik jest pomijany.
Parametry związane z okresowym uruchamianiem DirectoryMonitor
Nazwa parametruOpisUwagi
CheckAtTimeParametr określający czy przetwarzać katalogi o godzinie ProcessTime.

Możliwe wartości: [true, false].

ProcessTimeGodzina o której mają byc przetwarzane katalogi, gdy wybrany jest parametr CheckAtTime.

Godzina w formacie:

  • hh:mm
CheckPeriodicParametr określający, czy przetwarzać katalogi co określony czas PeriodMożliwe wartości: [true, false].
PeriodOdstęp czasowy, co który mają byc przetwarzane katalogi.

Wartość w postaci liczby całkowitej reprezentującej okres czasowy w milisekundach.

Parametry związane z typem plików RAW
Nazwa parametruOpisUwagi
CopyRawFilesParametr określajacy czy zapisywać pliki RAW w osobnym katalogu RawFileDestinationPath.Możliwe wartości, [true, false].
RawFileDestinationPathŚcieżka do zapisu plików RAW, jeżeli wybrano opcję CopyRawFiles.Wartość w postaci tekstu reprezentującym ścieżkę do katalogu, do którego mają być zapisywane pliki RAW.
DeleteRawFilesJest to parametr określający czy ma nastąpić usunięcie źródłowego pliku RAW jeżeli z powodzeniem przeniesiono go do archiwum,Możliwe wartości, [true, false].
RawFileRegExpRegex, którym następuje filtrowanie znalezionych ścieżek plików.Jeżeli w regexie jest grupa (oznaczona okrągłymi nawiasami), to przechwycona grupa jest używana jako nowa ścieżka pliku.
RawFileMaskTekst, którym mozna podmienić ścieżkę pliku.Można w tekście wykorzystywać przechwycone grupy z RawFileRegExp w postaci $1, $2 ... itd.
RawFileOnErrorParametr określający operację do wykonania dla plików RAW, których nie udało się dodać do archiwum.

Możliwe wartości:

  • None -> brak działania (domyślnie),
  • Copy -> kopiowanie do RawFileErrorDirectory,
  • Move -> przenoszenie do RawFileErrorDirectory,
  • Delete -> usuwanie pliku.
RawFileErrorDirectoryŚcieżka do katalogu dla plików RAW, których nie udało się dodać do archiwum.Wartość w postaci tekstu reprezentującym ścieżkę do katalogu, do którego mają być zapisywane pliki RAW, których nie udało się dodać do archiwum.
Parametry związane z typem plików XML
Nazwa parametruOpisUwagi
CopyXMLFilesParametr określajacy czy zapisywać pliki XML w osobnym katalogu XMLFileDestinationPath.Możliwe wartości, [true, false].
XMLFileDestinationPathŚcieżka do zapisu plików XML, jeżeli wybrano opcję CopyXMLFiles.Wartość w postaci tekstu reprezentującym ścieżkę do katalogu, do którego mają być zapisywane pliki XML.
DeleteXMLFilesJest to parametr określający czy ma nastąpić usunięcie źródłowego pliku XML jeżeli z powodzeniem przeniesiono go do archiwum,Możliwe wartości, [true, false].
XMLRawFileTagParametr określający ścieżkę do tagu w pliku XML, który zawiera nazwę pliku do wgrania do archiwum.

Ścieżka do tagu powinna być jednoznaczna. W przypadku braku jednoznaczności wybrana zostanie pierwsza pasująca wartość (TODO do sprawdzenia!).

Ścieżka musi był pełna (zawierać wszystkie kolejne tagi).

Przykładowo dla pliku XML:

Code Block
languagexml
collapsetrue
<a>
    <b>
        <c>ścieżka do pliku/plik.pdf</c>
    </b>
    <d>
        <c>inna wartość</c>
    </d>
</a>

Wartość tagu może wynosić jeden z:

  • XMLRawFileTag = <a><b><c>
  • XMLRawFileTag = <b><c>

Nie powinna wynosić:

  • XMLRawFileTag = <a><c>
  • XMLRawFileTag = <c>
XMLRawFileAttributeParametr określający nazwę atrybutu tagu w pliku XML, który zawiera nazwę pliku do wgrania do archiwum, jeżeli w samym tagu XMLRawFileTag się ona nie znajduje.

Przykładowo dla pliku XML:

Code Block
languagexml
collapsetrue
<a>
    <b>
        <c AA="ścieżka do pliku/plik.pdf" BB="inna wartość"/>
    </b>
</a>

Wartości XMLRawFileTag i XMLRawFileAttribute mogą wynosić:

  • XMLRawFileTag = <b><c>
  • XMLRawFileAttribute = AA
XMLFileOnErrorParametr określający operację do wykonania dla plików XML, których nie udało się dodać do archiwum.

Możliwe wartości:

  • None -> brak działania (domyślnie),
  • Copy -> kopiowanie do XMLFileErrorDirectory,
  • Move -> przenoszenie do XMLFileErrorDirectory,
  • Delete -> usuwanie pliku.
XMLFileErrorDirectoryŚcieżka do katalogu dla plików XML, których nie udało się dodać do archiwum.

Wartość w postaci tekstu reprezentującym ścieżkę do katalogu, do którego mają być zapisywane pliki XML, których nie udało się dodać do archiwum.

Parametry związane z niestandardowymi zapytaniami do baz danych (# - kolejny numer zaczynając od 1, gdyż zapytań może być wiele)
Nazwa parametruOpisUwagi
DBURL#Adres URL połączenia z bazą, 
SQLQuery#Zapytanie do bazy danych, którego wyniki mogą być później wykorzystywane jako wartości indeksów.

W zapytaniu można użyć wartości indeksów, które zostały określone już w inny sposób (np. z nazwy, daty czy pliku xml).

W takim wypadku wartość indeksu należy użyć jako: $IndexN (gdzie N to numer jednego z indexów tam gdzie IndexN_Type jest różny od SQL).

DBUser#Login użytkownika do bazy danych, 
DBPassword#Hasło użytkownika do bazy danych. 
JDBCDriver#Sterownik do bazy danych. 
AllOccurence#Parametr określający czy ten sam plik jest dodawany do archiwum tyle razy ile rekordów zwróci zapytanie zamiast tylko raz z użyciem pierwszego rekordu.

Dla każdego rekordu ustawiane są wartości odpowiednich indeksów z typem SQL. Pozostałe indeksy dla każdego pliku będą miały tą samą wartość.

Ten parametr może wystąpić tylko raz w pliku konfiguracyjnym (brane jest pod uwagę tylko pierwsze takie wystąpienie).

...