Eksport

Przesyłki i dokumenty przetworzone w systemie FormAnalylyzer RBEE mogą być eksportowane do innych systemów IT automatycznie lub na żądanie. W celu zdefiniowania zakresu eksportowanych danych oraz sposobu i miejsca zapisu tworzone są obiekty definicji eksportu. Obiekty definicji eksportu danych mają zastosowanie podczas eksportu automatycznego. Automatyczny eksport danych realizowany jest przez serwis FormAnalyzer RBEE Eksporter.

Automatyczny eksport danych wykonywany jest dla wszystkich zdefiniowanych schematów eksportu, które mają ustawioną flagę "Aktywny". Eksport danych następuje automatycznie w chwili, gdy określona przesyłka będzie spełniać założone przez schemat eksportu kryteria. W przypadku wystąpienia błędu eksport danych jest powtarzany w kolejnych interwałach czasowych. Informacje o wykonanych procedurach eksportu znajdują się w logach systemu oraz są zapisywane w historii przesyłki/dokumentu.

Schemat automatycznego eksportu przesyłek/dokumentów pozwala na zdefiniowanie następujących atrybutów:

Nazwa

Nazwa schematu eksportu danych. Krótki akronim zrozumiały dla administratorów systemu.

Uwagi

Opis celu i zasad działania utworzonego schematu. Przeznaczony dla administratorów w celu zapisania uwag i informacji dodatkowych.

Aktywna

Serwis eksportu danych - FormAnalyzer RBEE Eksporter realizuje tylko aktywne schematy eksportu danych. Można aktywować i de-aktywować schematy w trakcie pracy systemu.

Zadanie

Ograniczenie eksportowanych przesyłek do takich, które były przetwarzane w ramach określonego zadania.

Zbiór Przesyłek

Ograniczenie eksportowanych przesyłek do takich, które należą do określonego zbioru przesyłek.

Pierwsza data rejestracji przesyłki

Ograniczenie eksportowanych przesyłek do takich, które zostały zarejestrowane nie wcześniej niż wskazana data. Jeżeli data jest pusta to przyjmuje się dowolną datę rejestracji.

Ostatnia data rejestracji przesyłki

Ograniczenie eksportowanych przesyłek do takich, które zostały zarejestrowane nie później niż wskazana data. Jeżeli data jest pusta to przyjmuje się dowolną datę rejestracji.
Wypełnienie zarówno pola "Pierwsza data rejestracji" jak i "Ostatnia" tworzy zakres dat przesyłek do eksportu.

Uwzględniaj dokumenty już wyeksportowane

Eksportowane będą dokumenty spełniające zdefiniowane warunki wyboru i nie wyeksportowane oraz takie, które były już eksportowane z wykorzystaniem innego schematu eksportu.
Dokumenty raz wyeksportowane z wykorzystaniem aktualnego schematu eksportu nie będą ponownie eksportowane.

Przesyłki niesklasyfikowane

Eksportowane będą tylko takie przesyłki/dokumenty, które nie zostały sklasyfikowane.
Obejmuje to przesyłki, których wszystkie dokumenty nie mają określonego typu dokumentu.

Przesyłki błędne

Eksportowane będą tylko przesyłki/dokumenty, które zostały oznaczone jako błędne lub zawierają dokument oznaczony jako błędny - nie spełniający wymagań i odrzucony przez operatora weryfikacji lub algorytm weryfikujący.

Typy eksportowanych dokumentów

Jeżeli wskażemy określone typy dokumentów to tylko takie dokumenty przesyłek będą eksportowane. Jeżeli określona przesyłka nie będzie zawierać żadnego ze wskazanych typów dokumentów to nie zostanie wyeksportowana.

Folder zapisu danych

Folder zapisu danych dostępny dla serwisu FormAnalyzer RBEE Eksporter, w którym będą zapisywane wyniki eksportu danych.
Informacja: w przypadku zastosowania własnej biblioteki eksportu nie ma zastosowania.

Tryb zapisu dokumentu
Metadane

Eksportowane będą wyodrębnione metadane dokumentów.

Tekst

Eksportowana będzie treść dokumentu. Nie będą eksportowane metadane.

Metadane i tekst

Eksportowane będą wyodrębnione metadane dokumentów oraz treść dokumentów.

Oryginały

Wraz z treścią dokumentów można dokonać eksportu obrazów stron i/lub plików źródłowych tworzących przesyłkę.

Załącz obrazy stron

Do folderu eksportu zostaną skopiowane we wskazanym formacie obrazy stron dokumentów.

Załącz pliki źródłowe

Do folderu eksportu zostaną skopiowane pliki źródłowe przesyłki/dokumentów.

Pobierz obrazy/pliki

Dołączenie obrazów stron i/lub plików dokumentów.
Dokument(y) będzie dostępny w formie archiwum zip zawierającego treść dokumentu oraz obrazy stron i/lub pliki źródłowe.
Obrazy stron zostaną zapisane w formie pliku PDF.

Format zapisu dokumentu

Treść dokumentów/przesyłki może być zapisywana w następujących formatach.

XML

Dla każdej eksportowanej przesyłki będzie tworzony odrębny plik XML z treścią danych zgodną z dokonanym wyborem.

CSV

Przesyłki będą zapisywane w docelowym pliku w formie listy linii zapisanych w formie Coma Separated Valu.
Należy ustawić następujące parametry:

Strona kodowa Strona kodowa służąca do zapisu pliku danych. Wybór z listy.
Separator wartości Znak służący do jako separator wartości. Domyślnie "|".
Format daty Format zapisu daty. Wybór z dostępnej listy formatów.
Apostrof wartości tekstowej Ogranicznik wartości tekstowych.
Separator wartości dziesiętnej Separator wartości dziesiętnej przy zapisie liczb. Możliwe do wyboru "." albo ",".
Tekst

Przesyłki będą zapisywane każda w odrębnym pliku w formie tekstowej.
Należy ustawić następujące parametry:

Strona kodowa Strona kodowa służąca do zapisu pliku danych. Wybór z listy.
Format daty Format zapisu daty. Wybór z dostępnej listy formatów.
Separator wartości dziesiętnej Separator wartości dziesiętnej przy zapisie liczb. Możliwe do wyboru "." albo ",".



Usuwanie przesyłek wyeksportowanych

Po pomyślnie wykonanym eksporcie danych przesyłki mogą być automatycznie usuwane. Jeżeli wprowadzona wartość dni oczekiwania jest większa równa 0, to automatyczne usuwanie przesyłek będzie wykonane po wskazanej liczbie dni od daty dokonania eksportu.
Uwaga: Proces automatycznego usuwania przesyłek jest nieodwracalny. Wszystkie dane zostaną usunięte z bazy danych oraz z wolumenów plikowych.

Własna implementacja eksportu

W przypadku gdy dostępny standardowy mechanizm eksportu danych nie jest wystarczający, można uzupełnić system o własną implementację procesu zapisu eksportu dokumentów.
W tym celu należy zaimplementować bibliotekę dll (assembly) w formacie zgodnym z Microsoft .Net Standard 2.0, w wersji 64-bitowej. Biblioteka musi realizować interfejs IExportProvider z modułu Arhat.RBEE.ExportModel.
Gotową bibliotekę należy udostępnić do wykonania przez usługę FormAnalyzer RBEE Exporter (na przykład przez umieszczenie jej w katalogu wykonywalnym usługi). Należy pamiętać o umieszczeniu także wszystkich dodatkowych modułów wymaganych przez tę bibliotekę.

namespace Arhat.RBEE.ExportModel
{
/// <summary>
/// ExportProvider definiuje niezbędny zakres metod dla
/// przetwarzania komunikatów eksportu danych z systemu
/// FormAnalyzer RBEE do dowolnych systemów docelowych.
/// </summary>
/// <example>
/// Poniższy przykład pokazuje eksport przesyłki wraz z dokumentami i ich metadanymi do serwisu zewnętrznego.
/// ...
/// using(var exporter = new CustomExporter())
/// {
///  WybierPrzesylkliDoEksportu();
///  var id = Guid.NewGuid();
///  var date = DateTime.Now;
///  exporter.Initialize(ct, id, date);
///  while(true)
///  {
///  var przesylka = KolejnaPrzesylkaDoeksportu();
///  if (przesylka == null)
///  break ;
///
///  using (CancellationTokenSource cs = new CancellationTokenSource(30000))
///  {
///  var res = exporter.Export(cs.Token, przesylka);
///  if (!res)
///  continue;
///  PrzesylkaZostalaWyeksportowana(przesylka);
///  }
///  }
/// }
/// </example>
public interface IExportProvider : IDisposable
{
/// <summary>
/// Wykonaj zadania jednorazowe inicjalizacji obiektu eksportowania danych.
/// </summary>
/// <param name="cancellationToken">Token udostępniający informacje,
/// że operacja powinna być anulowana.</param>
/// <param name="exportId">
/// Identyfikator kolejny sesji eksportu.
/// Więcej niż jedna przesyłka może być eksportowana w jednej sesji eksportu.
/// </param>
/// <param name="exportDate">Data i czas rozpoczęcia realizacji sesji eksportu.</param>
/// <returns>
/// Flaga oznaczająca powodzenie operacji.
/// Przy niepowodzeniu operacji, jeżeli znana jest przyczyna błędu, metoda powinna zgłaszać wyjątek
/// w przeciwnym wypadku zwrócić false.
/// </returns>
bool Initialize(CancellationToken cancellationToken, Guid exportId, DateTime exportDate);

/// <summary>
/// Wykonaj eksport treści przesyłki.
/// </summary>
/// <param name="cancellationToken">Token udostępniający informacje,
/// że operacja powinna być anulowana.</param>
/// <param name="box">Obiekt zawierający treść przesyłki.</param>
/// <returns>Jeżeli nie można dokonać eksportu przesyłki i znana jest przyczyna to należy
/// zgłosić wyjątek (exception) lub zwrócić wartość false.
/// Wartość true potwierdza wykonanie eksportu.</returns>
bool Export(CancellationToken cancellationToken, BoxExportModel box);
}
}
Plik biblioteki własnej

Nazwa pliku biblioteki własnej (opcjonalnie wraz ze ścieżką dostępu).

Klasa implementacji eksportu

W pełni kwalifikowana nazwa klasy implementującej IExportProvider. Nazwa musi być poprzedzona zastosowaną przestrzenią nazw (namespace).

FormAnalyzer RBEE Eksport przesyłek/dokumentów

Arhat sp.z o.o.
ul. Antoniego Józefa Madalińskiego 23 lok.7 A
02-513 Warszawa, Polska

tel: +48-22-8491225
e-mail: Ten adres pocztowy jest chroniony przed spamowaniem. Aby go zobaczyć, konieczne jest włączenie w przeglądarce obsługi JavaScript.

© 2020 Arhat. All rights reserved. Powered by Indico.pl