Dotyczy wersji 2020.1.x; autor: Grzegorz Szlachta
Pobieranie i instalacja WEBCOB Word add-in z Portalu
Konfiguracja dodatku i szablonu
Dbanie o zachowanie DEV/TEST/PROD
Edycja szablonu i śledzenie zmian
Konfiguracja akcji generowanie pliku .docx
System obiegu dokumentów WEBCON BPS pozwala na generowanie plików Word zawierających w treści dane wprowadzone na formularzu. Funkcjonalność ta jest szczególnie przydatna w procesach umów, urlopów czy zamówień, gdzie konieczne jest przedłożenie dokumentu do podpisu. W poniższym artykule zostanie przedstawiony sposób instalacji dodatku WEBCON Word add-in; przygotowanie szablonu oraz konfiguracja akcji do generowania dokumentu .docx. Przykładowy szablon został oparty na procesie umowy o zatrudnienie.
Więcej informacji na temat generowania dokumentów można znaleźć w artykułach -> Akcje związane z plikami docx i xls w WEBCON BPS.
Pobieranie i instalacja WEBCON Word add-in z Portalu
Instalacja dodatku możliwa jest tylko i wyłącznie z poziomu przeglądarki – należy wejść na stronę portalu bezpośrednio przez IE zainstalowany na tej maszynie. Instalacja nie będzie możliwa przez połączenie zdalne RDP czy też z lokalnie zapisanego pliku instalacyjnego. Do poprawnego zainstalowania dodatku wymagany jest również zainstalowany pakiet Office z programem Word.
W menu użytkownika należy kliknąć ikonę w prawym górnym rogu, a następnie wybrać opcję Zainstaluj dodatki MS Office -> Word.
Na ekranie pojawi się komunikat informujący o certyfikacie bezpieczeństwa:
Kliknij przycisk „Install” – na ekranie pojawi się okno informujące o poprawnym zainstalowaniu dodatku.
Instalacja może być uruchomiona tylko i wyłącznie za pomocą przeglądarki Internet Explorer.
Konfiguracja dodatku i szablonu
Konfiguracja dodatku podczas pierwszego uruchomienia w programie Word odbywa się analogicznie w nowych wersjach jak w poprzednich. Przykładowe ustawienia i opis menu dodatku w programie WORD został opisany tutaj:
Dodawanie pól formularza do szablonu
Po skonfigurowaniu połączenia dodatku Word z odpowiednią witryną, należy przystąpić do tworzenia szablonu. Służy do tego przycisk Szablony do generowania plików.
Następnie w panelu, który pojawi się po prawej stronie wybierz aplikację, proces oraz typ dokumentu, z którego będą pobierane wartości na formularzu. Dostaniemy wtedy listę pól możliwych do umieszczenia na szablonie. Dodawanie pól do szablonu można realizować na dwa sposoby: umieszczając kursor na dokumencie w interesującym nas miejscu i podwójnym kliknięciem na nazwę pola z listy lub metodą drag&drop przeciągając pole z listy w odpowiednie miejsce na dokumencie.
Oprócz pól formularza na liście dostępne są pola systemowe, takie jak sygnatura czy kod 2D i kod kreskowy. Metody ich dodawania są takie same jak opisano powyżej.
W szablonie można również umieszczać zdefiniowane na formularzu listy pozycji. Po dodaniu listy pozycji ukaże nam się okno, w którym należy ustawić widoczność, kolejność i nazwy kolumn. Dla kolumn z danymi liczbowymi możliwe jest też dodanie wiersza sumującego wartości.
Po potwierdzeniu konfiguracji listy zostanie ona dodana do szablonu prezentując nazwy wybranych kolumn wraz z jednym, pustym wierszem. Teraz można ustawić styl tabeli za pomocą wbudowanych opcji programu WORD.
Pobieranie danych z innych systemów za pomocą zapytania SQL
W analogiczny sposób jak listy pozycji możemy dodawać tabele danych oparte na zapytaniu SQL, które odnosi się do bazy WEBCON lub zewnętrznego systemu. Tym sposobem jesteśmy w stanie umieścić w pliku Word nie tylko dane znajdujące się na formularzu, ale też odpowiednio przefiltrowane i sformatowane dane np. z systemu ERP czy innej bazy klienta.
Naprzemienne formatowanie listy pozycji w programie WORD
W celu ustawienia naprzemiennego kolorowania wierszy należy kliknąć w tabelę i przejść w ustawienia projektowania tabeli na górnej wstążce. Następnie zaznaczyć opcję Wiersze naprzemienne i wybrać styl z dostępnej listy, lub stworzyć swój własny.
Rezultat działania:
Od wersji 2020 istnieje możliwość umieszczania obrazków na formularzu za pomocą pola typu Obraz. Najnowsza wersja dodatku WEBCON Word Add-in umożliwia dodanie zawartości takiego pola do szablonu. Pola tego typu są standardowo dostępne na liście wszystkich atrybutów, a ich dodanie odbywa się w taki sam sposób. Po dodaniu do szablonu, pole typu obrazek wyświetlane jest na szablonie w następujący sposób:
W stopce dokumentu bardzo często umieszcza się podstawowe dane firmy. Jeżeli dla danego klienta/procesu przewidujemy dużą ilość szablonów, a w pewnym momencie dane które chcemy wyświetlić uległy zmianie, może okazać się, że wprowadzenie modyfikacji wymaga od nas nieproporcjonalnie dużego nakładu pracy i edytowania każdego szablonu z osobna. Aby uniknąć takiej sytuacji warto pomyśleć o przechowywaniu danych firmy w globalnej konfiguracji spółek. Sposób ten sprawi, że zmiana wartości w jednym miejscu będzie mieć efekt w każdym procesie, który odwołuje się do tej konfiguracji.
Aby skonfigurować dane spółki w WEBCON BPS należy przejść do konfiguracji systemu, a następnie dodać nową lub edytować już istniejącą spółkę. Istnieje możliwość wprowadzenia takich danych jak nazwa firmy, numer NIP czy dane kontaktowe jak adres lub nr telefonu. Zapisane dane będą przechowywane w tabeli Companies.
Kolejnym krokiem jest skonfigurowanie pola typu wiersz danych, gdzie odwołamy się właśnie do tabeli Companies. Zdefiniowane kolumny posłużą nam potem w tworzeniu treści stopki.
Zapytanie SQL powinno zostać zdefiniowane w następujący sposób:
Teraz można przystąpić do definicji stopki. W trybie edycji szablonu, kliknij dwukrotnie w obszar stopki na dole dokumentu, a następnie z menu po prawej stronie dodaj wybrane kolumny.
UWAGA!
Nie ma możliwości umieszczania całej tabeli w stopce. Zawartość stopki należy dodawać poprzez klikanie na każdą z kolumn osobno.
Poniżej przykładowa konfiguracja i wynik działania po wygenerowaniu pliku Word.
Dbanie o zachowanie DEV/TEST/PROD
Zdarzają się przypadki, gdy w szablonie chcemy umieścić adres URL, ID grupy lub po prostu typ środowiska, na którym został zarejestrowany formularz. Wysoce rekomendowanym sposobem tworzenia szablonu w takich przypadkach jest zastosowanie konfiguracji zgodnej z DEV/TEST/PROD, czyli wykorzystywanie stałych zawierających sekcje DEV/TEST/PROD w swojej konfiguracji. Podając różne wartości w każdej sekcji, w zależności od środowiska, na którym pracujemy, w wygenerowanym pliku zostanie wstawiona odpowiednia wartość. Taka konfiguracja daje pewność poprawnego działania po operacji import-eksport, ponieważ podczas przenoszenia procesu na inne środowiska system opiera się na GUID’ach atrybutów i powiązanych z nimi konfiguracji. Opis dobrych praktyk wraz z przykładami użycia poszczególnych stałych został opisany tutaj: https://kb.webcon.pl/z-zycia-wdrozeniowca-podejscie-do-konfiguracji-aplikacji-zgodnej-z-dev-test-prod/.
Przykład wygenerowanego pliku
Edycja szablonu i śledzenie zmian
Sposoby przechowywania szablonów dokumentów oraz konfiguracja zostały szczegółowo opisane tutaj: https://kb.webcon.pl/sposoby-przechowywania-szablonow-dokumentow/
Jeżeli zdecydowaliśmy się na umieszczenie szablonu w typowanym procesie dla szablonów dokumentów należy odpowiednio skonfigurować sekcję załączników na takim procesie, aby umożliwić edycję pliku z szablonem. W tym celu należy uruchomić WEBCON BPS – Designer Studio i przejść do procesu szablonów, rozwinąć obieg i kliknąć Formularz podstawowy, a następnie wybrać zakładkę Globalny Szablon formularza (Wybieramy sekcję ZAŁĄCZNIKI). Teraz we właściwościach sekcji należy zaznaczyć opcję Edycja przez listę i zapisać proces.
Taka konfiguracja sprawi, że podczas edycji elementu słownikowego, gdzie zapisaliśmy szablon będzie dostępna opcja ‘Edycja pliku’. To z kolei pozwoli na korzystanie ze wszystkich opcji WEBCON Word Add-in, w tym śledzenie zmian, co zostało szczegółowo opisane tutaj: https://kb.webcon.pl/dodatek-word-porownywanie-wersji/
Konfiguracja akcji generowanie pliku .docx
Akcję generowania pliku Word dodajemy w ustawieniach kroku w zakładce Akcje. W pokazanym przykładzie dodajemy ją w węźle na przejściu ścieżką Generuj umowę. Konfiguracja akcji nie zmienia się w zależności od wybranego węzła.
Wybierz typ akcji z listy: Generuj/Aktualizuj plik Word. Kliknij przycisk „Konfiguruj” i przejdź do ustawień związanych z generowaniem dokumentu.
W konfiguracji akcji pojawiają się 3 tryby działania:
- Nowy plik – Za każdym uruchomieniem akcji utworzy jeden nowy plik
- Nowy plik dla wierszy listy pozycji – Dla każdego wiersza ze wskazanej listy pozycji utworzy oddzielny plik.
- Aktualizacja istniejącego pliku – Zaktualizuje wybrany plik na podstawie kategorii, wyrażenia regularnego lub zapytania SQL. Funkcja przydatna gdy pola formularza podlegają edycji – wtedy podczas zapisu zmian możemy łatwo odświeżyć zawartość pliku.
Wybór szablonu pliku Word może odbyć się na 3 sposoby:
- Z linku
- Z załącznika
- Z procesu szablonów dokumentów (opcja dostępna od wersji 2020
W zakładce wynik ustawiane są parametry zapisu pliku wyjściowego.
Wybór Pokaż na ekranie spowoduje wyświetlenie w oknie przeglądarki podglądu wygenerowanego pliku. Jeżeli zaznaczymy checkbox Zapisz jako załącznik, to plik zostanie dołączony do dokumentu, a jego nazwa ustalona według ustawień w polu Nazwa pliku.
Dodatkowo istnieje możliwość przypisania zapisywanego załącznika do określonej kategorii.
Gdy wrzuciłem listę pozycji do word i sformatowałem odpowiedno kolor czcionki, styl oraz rozmiar. Niektóre kolumny nie zachowały ustawień. Co może być przyczyną?