Informacje wstępne
Do integracji z systemem eDoręczeń służy zestaw akcji wbudowanych w system Navigator. Do wykonania integracji nie wystarczy jednak tylko skonfigurować system oraz akcje. Potrzebna jest również modyfikacja instalacji systemu.
System Navigator nie łączy się bezpośrednio z serwerami eDoręczeń tylko używa serwisu pośredniego. Jest to produkt firmy Archman który udostępniamy naszym klientom w ramach posiadanych licencji oraz umów serwisowych. Może on być zainstalowany w infrastrukturze klienta lub na serwerach firmy Archman. Ze względu na bezpieczeństwo przesyłanych danych oraz sugerujemy instalację u klienta.
Instalację serwisu wykonują zespoły wdrożeniowe które opiekują się danym środowiskiem.
Konfiguracja systemu
Pierwszą rzeczą, którą należy zrobić to skonfigurować system do komunikacji z serwisem pośredniczącym eDoręczeń. Wybieramy Ustawienia > Pozostałe > Ustawienia i szukamy sekcji e-Doręczenia
Należy tu oczywiście wpisać adres pod którym jest zainstalowany serwis pośredniczący
W tym momencie dobrze jest też skonfigurować skrzynkę eDoręczeń pod integrację z Navigatorem. Jeżeli skrzynka nie jest jeszcze założona to należy wystąpić z nioskiem o założenie skrzynki. Instrukcję konfiguracji skrzynki można znaleźć na stronach rządowych pod adresem Integracja usługi e-Doręczeń – e-Doręczenia – Portal Gov.pl
Przygotowanie systemu
Integracja z eDoręczeniami wymaga dostosowanai systemu. Najlepiej będzie rozbudować formularze pism przychodzących i wychodzących o nowe pola odpowiadające polom eDoręczeń. Lista tych pól jest podana przy sekcji o konfiguracji akcji do pobierania i wysyłania pism.
Drugą rzeczą, którą należy zmodyfikować to formularz kontrahenta. Należy dodać pole, które będzie przechowywało adres skrzynki. Ponieważ każdy podmiot może mieć tylko jedną skrzynkę najlepiej będzie dodać zwykłe pole tekstowe do formularza.
Pobieranie pism z eDoręczeń
Do pobierania pism służy akcja e-Doręczenia: Pobierz wiadomości
Parametry wywołania akcji:
Adres skrzynki e-Doręczeń: Adres skrzynki odbiorcy. Parametr można wpisać ręcznie lub wskazać pole na formularzu, w którym jest przechowywany adres skrzynki
ApiKey: Klucz uwieżytelniający do połączeń z serwisem pośrednim. Klucz należy wygenerować podczas instalacji serwisu pośredniego
Typ: Typ dokumentu, który będzie utworzony na podstawie pobranych danych
Kategoria: Kategoria dokumentu, do której trafi utworzony dokument
Firma: W przypadku wielofirmowości wskazanie do której firmy przypisać tworzony dokument
Użytkownik: Wskazanie użytekonika, który będzie podany jako twórca dokumentu
Odczytać wiadomość: Wartości Tak / Nie. Ustawienie pozwala zdecydować, czy pobranie pisma będzie skutkowała jego odczytaniem.
Adres nadawcy: Adres skrzynki nadawcy
Temat: Temat wiadomości
Treść: Treść wiadomości
ID wątku: Wątek, do którego należy wiadomość
ID wiadomości: ID wiadomości w systemie e-Doręczeń
Data doręczenie: Data doręczenie pisma
Znak sprawy: Sygnatura sprawy, pod którym zarejestrowane jest pobierane pismo.
Załączniki do pisma są pobierane automatycznie i wstawiane do pola Załączniki
Odczytanie pisma
Akcja Odczytaj wiadomość jest analogiczną akcją do pobieranie wiadomości. Służy do oznaczenia wiadomości jako przeczytaną.
Parametry wywołania akcji:
Adres skrzynki e-Doręczeń: Adres skrzynki odbiorcy. Parametr można wpisać ręcznie lub wskazać pole na formularzu, w którym jest przechowywany adres skrzynki
ApiKey: Klucz uwieżytelniający do połączeń z serwisem pośrednim. Klucz należy wygenerować podczas instalacji serwisu pośredniego
ID wiadomości: ID wiadomości, która ma być odczytana. ID wiadomości należy pobrać akcją Pobierz wiadomość
Typ: Typ dokumentu, który będzie utworzony na podstawie pobranych danych
Kategoria: Kategoria dokumentu, do której trafi utworzony dokument
Firma: W przypadku wielofirmowości wskazanie do której firmy przypisać tworzony dokument
Użytkownik: Wskazanie użytekonika, który będzie podany jako twórca dokumentu
Adres nadawcy: Adres skrzynki nadawcy
Temat: Temat wiadomości
Treść: Treść wiadomości
ID wątku: Wątek, do którego należy wiadomość
ID wiadomości: ID wiadomości w systemie e-Doręczeń
Data doręczenie: Data doręczenie pisma
Znak sprawy: Sygnatura sprawy, pod którym zarejestrowane jest pobierane pismo.
Załączniki do pisma są pobierane automatycznie i wstawiane do pola Załączniki
Wysyłanie wiadomości
Do wysyłania wiadomości służy akcja Wyślij wiadomość
Parametry wywołania akcji:
ApiKey: Klucz uwieżytelniający do połączeń z serwisem pośrednim. Klucz należy wygenerować podczas instalacji serwisu pośredniego
Od: Adres skrzynki nadawcy. Parametr można wpisać ręcznie lub wskazać pole na formularzu, w którym jest przechowywany adres skrzynki
Do: Adres skrzynki odbiorcy. Parametr można wpisać ręcznie lub wskazać pole na formularzu, w którym jest przechowywany adres skrzynki
Temat: Temat wiadomości
Treść: Treść wiadomości
Załączniki: atrybut, w którym są przechowywane załączniki do wysłania. Najczęściej należy wskazać ID załączników
Znak sprawy: Sygnatura sprawy, pod którym zarejestrowane jest pobierane pismo.
Wątek: Wątek, do którego należy wiadomość
Użytkownik: Wskazanie użytekonika, który będzie podany jako twórca dokumentu
Identyfikator zadania wysłania wiadomości: Pole techniczne, w którym będzie przechowywana wartość zwrócona przez system eDoręczeń
Wiadomość hybrydowa
Może się zdarzyć tak, że kontrahent do którego wysyłamy wiadomość nie ma skrzynki. W takim wypadku można użyć wysyłki hybrydowej w ramach której Operator Wyznaczony wydrukuje przesłany dokument i dostarczy go do adresata w formie papierowej. Więcej o przesyłce hybrydowej można przeczytać na stronach rządowych.
W systemie Navigator do wysyłki hybrydowej została przygotowana osobna akcja:
Parametry wywołania akcji są bardzo podobne do zwykłej wysyłki:
Dokument: Wskazanie dokumenty, który będzie wysyłany. Z reguły można tu podać pole systemowe ID dokumentu
Do: Adres skrzynki odbiorcy. Parametr można wpisać ręcznie lub wskazać pole na formularzu, w którym jest przechowywany adres skrzynki
Temat: Temat wiadomości
Załączniki: atrybut, w którym są przechowywane załączniki do wysłania. Najczęściej należy wskazać ID załączników
Użytkownik: Wskazanie użytekonika, który będzie podany jako twórca dokumentu
Znak sprawy: Sygnatura sprawy, pod którym zarejestrowane jest pobierane pismo.
Informacja o treści przesyłki
Identyfikator zadania wysłania wiadomości: Pole techniczne, w którym będzie przechowywana wartość zwrócona przez system eDoręczeń
Poza polami związanymi z wysyłką elektroniczną w konfiguracji akcji są też pola dotyczące wysyłki papierowej. Każde z tych pól ma określony zakres wartości które może przyjmować. Należy na formularzu przygotować odpowiednie pola, np. typu radiobutton lub lista rozwijana z wartościami dopuszczalnymi. Oto lista tych pól wraz z dopuszczalnymi wartościami:
Tryb przesyłki: Określa jakie tryb wysyłania przesyłki. Dopuszczalne wartości:
Economic – Ekonomiczna
Priority – Priorytetowa
Rodzaj pisma: Określa rodzaj pisma. Dopuszczalne wartości:
General – pismo ogólne
Administrative – pismo w postępowaniu administracyjnym
Tax – korespondencja z Urzędem Skarbowym
Court_civil – pismo sądowe w postępowaniu cywilnym
Court_criminal – pismo sądowe w postępowaniu karnym
Rodzaj przesyłki: określa rodzaj przesyłki. Dopuszczalne wartości:
Registered – przesyłka rejestrowana
NotRegistered – przesyłka nierejestrowana
Obsługa zwrotu przesyłki: określa co należy zrobić z niedostarczoną przesyłką. Dopuszczalne wartości:
ReturnToSender – zwrot do nadawcy
Destroy – zniszczenie przesyłki
Kolejne parametry określają sposób wydruku przesyłki
Kolor wydruku:
Monochrome – wydruk czarno-biały
Color – wydruk kolorowy
Typ zadruku:
Duplex – wydruk dwustronny
Simplex – wydruk jednostronny
Dodatkowy nadruk na kopercie w polu nadawca: w tym miejscu można podać dodatkowe informacje, które będą drukowane na kopercie
Konfigurując atrybuty na formularzu najwygodniej jest skorzystać z zapytania SQL które utworzy odpowiednią listę wartości. Każda lista powinna się składać z klucza oraz wartości wyświetlanej. Klucze to angielskie określenia podane wyżej wraz z dopuszczonymi wartościami. Przykładowy SQL mógłby wyglądać tak:
SELECT 'Registered' AS ID, 'Rejestrowana' AS Value UNION ALL SELECT 'NotRegistered' AS ID, 'Nierejestrowana' AS VALUE
Pobieranie statusu
Akcja służy do pobierania statusu wiadomości
Jako parametr należy podać ID zadania uzyskany przy wysyłaniu wiadomości. Dodatkowo należy podać standardowe wartości – Dokument na którym pracujemy oraz użytkownika, który zostanie wskazany jako dokonujący zmiany na dokumencie.
Po pobraniu statusu można uzupełnić pola na formularzu tak jak przy akcji pobierania wiadomości
Pobieranie potwierdzeń
Akcja służy do pobierania potwierdzenia dotyczącego wiadomości.Jako parametry akcji należy podać ID zadania uzyskany przy wysyłaniu wiadomości oraz typ wiadomości: wysłana lub odebrana. Dodatkowo należy podać standardowe wartości – Dokument na którym pracujemy oraz użytkownika, który zostanie wskazany jako dokonujący zmiany na dokumencie.
W rezultacie wykonania akcji do pola Załącznik zostanie dodany dokument z potwierdzeniem.
Wyszukiwanie adresu
Adres skrzynki odbiorczej urzędu czy kontrahenta nie zawsze jest znany. Dlatego powstały trzy akcje, które pozwalają na wyszukanie adresu skrzynki według różnych parametrów
Urzędu lub kontrahenta
Najprościej jest wyszukać adres skrzynki po NIP adresata. Wystarczy podać odniesienie do kontrahenta – np. ID dokumentu jeżeli uruchamiamy proces z formularza kontrahenta lub kontrolkę kontrahenta z dokumentu – i standardowe pole Użytkownika. W przypadku wielofirmowości należy wskazać firmę z którą skojarzony jest kontrahent. Wynik wyszukiwania zapisany jest we wskazanym polu.
Osoby fizycznej
W przypadku osoby prywatnej, gdy nie mamy numeru NIP najprościej jest wyszukać adres po numerze PESEL
W tym przypadku należy podać dane osoby: imię, nazwisko i Numer PESEL. Pozostałe dane są takie same jak przy wyszukiwaniu adresu dla firm.
Osoby fizycznej po adresie
Jeżeli nie dysponujemy numerem PESEL osoby, której adresu skrzynki szukamy, możemy posłużyć się akcją wyszukiwania adres skrzynki po adresie zamieszkania osoby.
Wystarczy zamiast numeru PESEL podać adres. Reszta parametrów jest taka sama.