Wtyczka BusinessTrip służy do rozliczania delegacji pracowników, zastępuje wcześniej służący do tego moduł PlusDelegacje.
Założenia :
- na komputerze użytkownika musi być połączenie z internetem, aby pobrać kursy walut z NBP.
- odcinki trasy muszą być wprowadzane w kolejności chronologicznej.
- szablony dokumentów Word (docx) muszą być zapisane przynajmniej w MS Word 2013. Nie mogą być zapisane w tzw zgodności do wcześniejszych wersji Word.
- ustawiony w PlusWorkflow.conf parametr 'WorkingDirectory', co jest konieczne do generowania dokumentów pdf
Rodzaje konfiguracji.
Ta dokumentacja zastępuje całkowicie sposób konfiguracji opisany i obowiązujący dla 'plusDelegacji'.
Poniżej opisane sposoby konfiguracji wpływają na sposób działania wtyczki oraz następujące w niej rozliczenie delegacji.
| Rodzaj | Opis | Format | Ustawianie wartości |
|---|---|---|---|
| kliencka | zawiera parametry ustawiane indywidualnie dla każdego wdrożenia | parametry akcji | w PWE w parametrach akcji Business Trip |
| domyślna | zawiera pozostałe parametry potrzebne do działania wtyczki, które albo wynikają z przepisów lub założeń lub najczęściej nie jest potrzebne indywidualne ustawienie podczas wdrożenia | plik json | ładowana automatycznie przy uruchomieniu z zawartego we wtyczce pliku, który zawiera przyjęte domyślne wartości. |
| zmieniona | zawiera parametry jak w konfiguracji domyślnej, ale tylko te które wymagają jednak zmiany w danym wdrożeniu | plik json | Aby zmienić parametr z konfiguracji domyślnej trzeba utworzyć lokalny poprawny plik json, zawierający tylko te parametry, które chcemy zmienić. Wczytana konfiguracja jest ładowania automatycznie przy uruchomieniu i automatycznie nadpisuje konfigurację domyślną. Aby dokonać zmian w tej konfiguracji trzeba ponownie wczytać przygotowany plik z kompletnymi zmianami. |
Konfiguracja kliencka.
Parametry ogólne dot. ustawień sposobu działania rozliczenia.
| Parametr akcji | Opis | Ustawienie obligatoryjne? |
|---|---|---|
| 'Czy zapisać zmienne? | jeśli 'Tak' to przed otwarciem okna do rozliczenia delegacji, zostaną zapisane wszystkie zmienne na formularzu zadania. Jeśli 'Nie' to otworzy okno bez zapisywania zmiennych. Uwaga, jeśli ustawiono 'Tak' to włączyć też standardowe 'zapisz formularz', które znajduje się przy definiowaniu przycisku akcji. Obecnie to nie działa, ale zostanie naprawione i zastąpi to zapisywanie we wtyczce. | Tak |
| Czy tabela wydatków widoczna? | określa czy tabela wydatków ma być wyświetlana czy też nie. | Tak |
| Czy ostrzegać, gdy daty niezgodne? | Czy moduł ma wyświetlać ostrzeżenie, gdy delegacja przekroczyła wnioskowany czas. | Tak |
| Czy okno rozliczenia widoczne? | 'Tak', powoduje wyświetlenie okna rozliczenia. 'Nie' powoduje powrót do zadania bez pokazywania okna rozliczenia. | Tak |
| Czy rodzaj wydatku widoczny? | określa czy kolumna "Rodzaj wydatku" w tabeli wydatków jest wyświetlana czy też nie. | Tak |
| Rodzaje wydatków | wartości wyświetlane w polu "Rodzaj wydatku" (typ: combo) podczas dodawania rekordu do tabeli wydatków. | Nie |
| Odświeżanie kursu, etap | Identyfikator etapu, na którym data ma zawsze być ustalana na dzisiejszą datę. | Nie |
| Odświeżanie kursu, dzisiaj/z pola | 'Nie' powoduje, że gdy występuje etap z ciągłym odświeżaniem daty kursu, data kursu jest pobierana ze wskazanego pola (id_czytanego_pola). | Nie |
| Odświeżanie kursu, Id pola | Identyfikator wskazanego pola, z którego ma być czytana data. | Nie *może być konieczny do kursu waluty dla delegacji zagranicznej |
| Podsumowanie pdf drukować? | 'tak' powoduje generowanie podsumowania rozliczenia | Tak |
| Podsumowanie pdf, klasa | klasa dokumentów archiwum PWFL, pod którą wygenerowane podsumowanie zostanie podłączone | Nie |
| Podsumowanie pdf, szablon | nazwa szablonu dokumentu procesu PWFL, służącego do generowania podsumowania | Nie |
| Karta pojazdu pdf, drukować? | 'tak' powoduje generowanie karty ewidencji pojazdu. | Tak |
| Karta pojazdu pdf, klasa | klasa dokumentów archiwum PWFL, pod którą wygenerowana karta zostanie podłączona | Nie |
| Karta pojazdu pdf, szablon | nazwa szablonu dokumentu procesu PWFL, służącego do generowania karty | Nie |
Parametry wejściowe :
Parametry wejściowe to wskazanie źródła skąd rozliczenie delegacji ma brać potrzebne informacje początkowe.
W praktyce dla poniższych parametrów można wskazać zmienne procesu zawierające dane, które zostaną przekazane z procesu wniosku delegacji do rozliczenia delegacji.
| Parametr akcji | Opis | Ustawienie |
|---|---|---|
| Numer delegacji | zmienna procesu z której zostanie pobrane id delegacji. Wcześniej musi być zapewniona unikalność tych id, ale nie ma narzuconego formatu. | Tak |
| Typ delegacji | zmienna procesu z której zostanie pobrana informacja o typie rozliczanej delegacji. Tj 'kraj' jeśli w Polsce, 'zagranica' jeśli poza granicami Polski. Domyślnie 'kraj'. | Nie |
| Imię i nazwisko | zmienna procesu z której zostanie pobrane imię i nazwisko | Nie |
| Cel delegacji | zmienna procesu z której zostanie pobrany cel delegacji | Nie |
| Data rozpoczęcia | zmienna procesu z której zostanie pobrana data początku delegacji | Nie |
| Data zakończenia | zmienna procesu z której zostanie pobrana data końca delegacji | Nie |
| Miasto | zmienna procesu z której zostanie pobrane miejsce delegacji | Nie |
| Kraj | zmienna procesu z której zostanie pobrane kraj delegacji | Nie |
| Rodzaj transportu | zmienna procesu z której zostanie pobrany rodzaj transportu | Nie |
| Data wydania zaliczki | zmienna procesu z której zostanie pobrana data wydania zaliczki pracownikowi. *Uwaga, dla delegacji zagranicznej ustawienie tej informacji może być niezbędne podczas rozliczania w zależności od ustawień w json w parametrze 'kurs_do_obliczen' . Wtedy wg tej daty są pobierane kursy walut używane w rozliczeniu. Dlatego przy określaniu tej daty należy zastosować obowiązujące w danej firmie zasady dot. ustalania kursów walut, które mogą być powiązane z typem delegacji, datą zaliczki oraz datami delegacji. | Nie* |
Parametry wyjściowe :
Parametry wyjściowe to wskazanie które i gdzie mają zostać przekazane informacje z rozliczenia delegacji do procesu w którym uruchomiono rozliczenie.
W praktyce to zmapowanie poniższych parametrów na zmienne procesu umieszczone w następujących tabelach dynamicznych procesu.
...
| Parametr akcji | Ustawienie obligatoryjne? |
|---|---|
| Numer delegacji | Nie* *ale jeśli chcemy zapisać w tabeli wydatków jakąkolwiek daną to musi być też zmapowany 'Numer delegacji'. |
| Nazwa wydatku | Nie |
| Koszt | Nie |
| Waluta | Nie |
| Data | Nie |
| Rodzaj wydatku | Nie |
Konfiguracja domyślna.
Konfiguracja domyślna zawiera następujące parametry ustawione domyślnie najczęściej wykorzystywanymi wartościami.
| Parametr | Opis |
|---|---|
| wydatki_waluty | symbole walut, w których ma być możliwość zarejestrowania poniesionych wydatków |
| kilometrowka | zawiera kategorie oraz przypisane koszty. |
| kilometrowka_dla | określa dla jakiego typu pojazdu, ma zostać wyliczona kilometrówka. |
| wymog_ewidencji_pojazdu | określa dla jakiego typu pojazdu ma być wymagane uzupełnienie pól dot ewidencja pojazdu. |
| srodek_transportu | wszystkie środki transportu, dostępne do wyboru dla osoby rozliczającej delegację. |
| nawa_polskiej_waluty | nazwa polskiej waluty, używanej w procesie. |
| before_save_on_map | zmienna określająca metodę, która ma zostać wywołana tuż przed zapisaniem danych w procesie - metoda przyjmuje dwa parametry: "Map<String, Object>" - mapowane zmienne oraz "DB_roz_del" - obiekt zawierający wszystkie informacje o delegacji i zwraca mapę wartości Map<String, Object> np. public static Map<String, Object> beforeWriteToProcess(Map<String, Object> zmienna, DB_roz_del delegacje) |
| kraj | mapa wartości, zawiera koszty: diety, ryczałtów dla delegacji krajowej. |
| zagranica : | część konfiguracji dotycząca delegacji zagranicznej. |
| wartość true, powoduje rozdzielenie ryczałtów na poszczególne kraje (w walucie tych krajów). Wartość false, powoduje zliczenie wszystkich ryczałtów i przeliczenie ich na PLN. |
| procent diety, w przypadku gdy pracodawca zapewnił posiłek w delegacji zagranicznej. |
| ustawienia dotyczące sposobu wybierania daty dla kursów walutowych. |
| wersja mapy, od której odświeżanie będzie funkcjonować. |
| ile dni ma zostać odjętych od daty dzisiejszej. Domyślną wartością jest -1 (data z wczoraj). |
| wartość true, powoduję, że moduł będzie odczytywał datę dla kursów walutowych, ze wskazanego pola. |
| w polu, można wskazać, ile dni ma zostać odjętych od daty wskazanej w polu. |
| wartość true, powoduje, możliwość przekazania daty z poziomu javascriptu (identyfikator data_wydania_zaliczki, w array'u identyfikatorów, przekazywanych w funkcji javascript). |
| wartość true, powoduje, że data zaliczki, przekazana z poziomu javascript, jest ważniejsza od daty z wcześniejszego rozliczenia wskazanej delegacji. |
| lista dostępnych walut w których może nastąpić rozliczenie |
| lista stawek diet i walut dla krajów, wg których nastąpi rozliczenie dla poszczególnych krajów |
| lista dostępnych krajów w rozliczeniu |
| typy pojazdów, dla których, rozpoczęcie, zakończenie naliczania diety następuje "od razu", tzn. wylot powoduję naliczanie diety dla kraju przylotu (docelowego) od momentu startu samolotu. Do takich środków lokomocji, należą, samolot oraz statek. Ustawienie to, jest używane tylko i wyłącznie przy kalkulacji diety. Nie powinno się go zmieniać. |
Konfiguracja zmieniona.
Jest opcjonalna. Powinna zawierać tylko te parametry konfiguracji domyślnej, które jednak muszą zostać zmienione, bo domyślna wartość nie jest odpowiednia.
Sposób działania i ustawienia zmienionej wartości opisano powyżej.
| Info | ||
|---|---|---|
| ||
Zachowany został istniejący w 'plusDelegacje' mechanizm określania daty wg. której są pobierane kursy walut z NBP. Działa jak opisano w Konfiguracja. |
Uruchomienie wtyczki 'BusinessTrip'.
...
Ta dokumentacja dot uruchomienia zastępuje całkowicie sposób instalacji opisany i obowiązujący dla 'plusDelegacji'.
Uruchomienie na systemie, gdzie wcześniej nie działały 'plusDelegacje'.
Wykonaj następujące kroki :
...
Teraz po uruchomieniu procesu, wypełnieniu zmiennych ustawionych do przekazywania wartości do obligatoryjnych parametrów wejściowych i kliknięciu zdefiniowanego przycisku, powinno się uruchomić okno rozliczania delegacji.
...
Uruchomienie zamiast działających obecnie 'plusDelegacje'.
Trzeba wykonać następujące kroki w oparciu o istniejące już ustawienia dla 'plusDelegacje :
...
| Tip | ||
|---|---|---|
| ||
Po wykonania aktualizacji z plusDelegacji do Business Trip zalecane jest całkowite wyłączenie i usunięcie plusDelegacji oraz podniesienie otwartych procesów delegacji do wersji, gdzie ustawione jest wykorzystanie Business Trip do rozliczania. |
Mapowanie parametrów na parametry w 'plusDelegacje'.
| Rodzaj parametru klienckiego | naNwa/grupa parametru klienckiego | Odpowiednik w 'plusDelegacje 3.1' tj. w 'businessTripConf.json' |
|---|---|---|
| Ogólne | Czy tabela wydatków widoczna? | tabela_wydatkow_widoczna |
| Czy ostrzegać, gdy daty niezgodne? | ostrzezenie_gdy_daty_niezgodne | |
| Czy okno rozliczenia widoczne? | pokaz_okno_rozliczenia | |
| Czy rodzaj wydatku widoczny? | rodzaj_wydatku_widoczny | |
| Rodzaje wydatków | rodzaj_wydatku | |
| Odświeżanie kursu, etap | etap_z_ciaglym_odswiezaniem_kursu | |
| Odświeżanie kursu, dzisiaj/z pola | odswiezanie_dzisiaj_czy_z_pola | |
| Odświeżanie kursu, Id pola | id_czytanego_pola | |
| Podsumowanie pdf drukować? klasa szablon | generowanie_pdf_podsumowanie_rozliczenia | |
Karta pojazdu pdf, drukować? | generowanie_pdf_karta_ewidencji_pojazdu | |
| Wejściowe | wszystkie | mapping_zmienne_procesu |
| Wyjściowe | Tabela podsumowań | mapping_podsumowan |
| Tabela kosztów | mapping_kosztow | |
| Tabela wydatków | mapping_wydatkow |
...
Parametry domyśle mają swoje odpowiedniki o tej samej dokładnie nazwie w 'businessTripDefaultConfig.json' z 'plusDelegacje'.
Sposób działania.
Sposób działania rozliczenia pozostał bez zmian, więc aktualny jest sposób działania opisany w obu wersjach 'plusDelegacje'.
Zmienił się tylko sposób uruchomienia i konfiguracji, co zostało opisane w osobnych punktach.