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.

Radzaje konfiguracji.

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.

zmieniona

zawiera parametry jak w konfiguracji domyślnej, ale tylko te które wymagały 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ć.
Potem trzeba go wczytać w Administracja->Konfiguracja systemu->Delegacje. Nadpisze to tylko te wybrane parametry, ale wszystkie ich wartości oraz umieści plik z tą konfiguracją na serwerze w '...\plugins\data\com_suncode_plugin-business-trip\config'.

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.
Natomiast aby całkowicie usunąć całkowicie tą konfigurację trzeba wczytać plik z pustym json'em lub usunąć wcześniej załadowany plik z serwera w powyżej wskazanej lokalizacji.

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?		Tak
Czy ostrzegać, gdy daty niezgodne?		Tak
Czy okno rozliczenia widoczne?		Tak
Czy rodzaj wydatku widoczny?		Tak
Rodzaje wydatków
Odświeżanie kursu, etap
Odświeżanie kursu, dzisiaj/z pola
Odświeżanie kursu, Id pola		*może być konieczny do kursu waluty dla delegacji zagranicznej
Podsumowanie pdf drukować?		Tak
Podsumowanie pdf, klasa
Podsumowanie pdf, szablon
Karta pojazdu pdf, drukować?		Tak
Karta pojazdu pdf, klasa
Karta pojazdu pdf, szablon

Parametry wejściowe :

Aby ustawić parametry wejściowe należy ustawić dla poniższych parametrów zmienne procesu zawierające dane które zostaną przekazane z procesu wniosku delegacji do rozliczenia delegacji.

Parametr akcji	Opis	Ustawienie obligatoryjne?
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		Nie
Cel delegacji		Nie
Data rozpoczęcia		Nie
Data zakończenia		Nie
Miasto		Nie
Kraj		Nie
Rodzaj transport		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 :

Aby ustawić parametry wyjściowe należy zmapować poniższe parametry na zmienne procesu umieszczone w tabelach dynamicznych. Wg tego ustawienia do tych zmiennych zostaną zapisane informacje z rozliczenia delegacji.

Tabela podsumowań (obligatoryjna):

Parametr akcji	Opis	Ustawienie obligatoryjne?
Numer delegacji		Tak

Tabela kosztów (obligatoryjna):

Parametr akcji	Opis	Ustawienie obligatoryjne?
Numer delegacji		Tak

Tabela wydatków (opcjonalna):

Parametr akcji	Opis	Ustawienie obligatoryjne?
Numer delegacji	*Ale jeśli chcemy zapisać w tabeli wydatków jakąkolwiek daną to musi być też zmapowany 'Numer delegacji'.	Nie*

Konfiguracja domyślna i zmieniona.

Konfiguracja domyślna zawiera następujące parametry ustawione 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) { return zmienna; }
kraj	mapa wartości, zawiera koszty: diety, ryczałtów dla delegacji krajowej.
zagranica :	część konfiguracji dotycząca delegacji zagranicznej.
rozdziel_ryczalty	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.
wysokosc_diety_gdy_pracodawca_zapewnil_posilek	procent diety, w przypadku gdy pracodawca zapewnił posiłek w delegacji zagranicznej.
kurs_do_obliczen :	ustawienia dotyczące sposobu wybierania daty dla kursów walutowych. Uwaga, kolejne trzy parametry dot odświeżania kursu można ustawić w konfiguracji klienckiej.
odswiezanie_kursu_na_etapie_od_wer_pakietu	wersja mapy, od której odświeżanie będzie funkcjonować.
odswiezanie_ile_dni_odjac_od_dzisiaj	ile dni ma zostać odjętych od daty dzisiejszej. Domyślną wartością jest -1 (data z wczoraj).
czy_czytac_z_pola	wartość true, powoduję, że moduł będzie odczytywał datę dla kursów walutowych, ze wskazanego pola.
ile_dni_odjac_od_daty_pola	w polu, można wskazać, ile dni ma zostać odjętych od daty wskazanej w polu.
czy_obslugiwac_date_zaliczki	wartość true, powoduje, możliwość przekazania daty z poziomu javascriptu (identyfikator data_wydania_zaliczki, w array'u identyfikatorów, przekazywanych w funkcji javascript).
czy_data_zaliczki_wazniejsza_od_daty_z_rozliczenia	wartość true, powoduje, że data zaliczki, przekazana z poziomu javascript, jest ważniejsza od daty z wcześniejszego rozliczenia wskazanej delegacji.
waluty
dieta
kraje
granica_odrazu	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ć.

Domyślne wartości parametrów można znaleźć w projekcie wtyczki w .../resources/config/businessTripDefaultConfig.json
W konfiguracji zmienionej mogą zostać zmienione wszystkie wartości powyżej wymienionych parametrów konfiguracji domyślnej.

Uruchomienie wtyczki na systemie gdzie nie działały 'plusDelegacje' :

Pod przyciskiem na formularzu ustawić akcję wraz z ustawieniem odpowiednich mapowań parametrów wejściowych i parametrów wyjściowych - Krytyczne.

Uruchomienie wtyczki zamiast działających obecnie 'plusDelegacje' :

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.
Jednakże równoległe działanie działanie plusDelegacji do czasu rozliczenia starych procesów także jest możliwe.

NEW

porównać domyślne ustawienia parametrów znajdujące się w 'businessTripDefaultConfig.json' z ustawieniami, które były przed aktualizacją w 'businessTripConf.json'
jeśli dla takiego parametru są identyczne wartości to nic nie robimy, natomiast jeśli wartości są inne to przekopiować parametr z wartościami do własnego nowo utworzonego pliku json.
po zakończeniu porównania, jeśli plik zawiera choć jeden parametr, załadować ustawienia z utworzonego pliku z własną konfiguracją w administracja->konfiguracja systemu->delegacje
ustawić w akcjach parametry analogicznie jak ich odpowiedniki z ustawieniami przed aktualizacją w 'businessTripConf.json'

OLD

Pod przyciskiem na formularzu ustawić akcję 'Delegacje' wraz z ustawieniem odpowiednich mapowań jak dla 'mapping_zmienne_procesu' znajdujące się w pliku json z konfiguracją.- Krytyczne.

Dla parametru 'Data wydania zaliczki' trzeba zaimplementować w akcji analogiczny mechanizm ustawiania jaki był zastosowany w skrypcie js odpalającym plusDelegacje 3.1. Mechanizm wynika z reguł stosowanych w danej firmie.

W pliku konfiguracji json usunąć wszystkie ustawienia dla 'mapping_zmienne_procesu' - Ważne.
W w/w akcji ustawić odpowiednie mapowania jak dla 'mapping_wydatkow', "mapping_podsumowan" i "mapping_kosztow" znajdujące się w pliku json z konfiguracją.

Parametr w plusDelegacje 3.1	Odpowiednik w akcji
Parametr w plusDelegacje 3.1	Rodzaj parametru	Nazwa parametru
saveVariables funkcji DelegacjeModule_runModule wywoływanej w skrypcie js uruchamiającym moduł plusDelegacje 3.1	Ustawienie	'Czy zapisać zmienne?'

W pliku konfiguracji BusinessTripConf.json usunąć wszystkie ustawienia dla :

- 'mapping_wydatkow'
- 'id_tabeli_wydatkow'
- "id_tabeli_podsumowan"
- "mapping_podsumowan"
- "id_tabeli_kosztow"
- "mapping_kosztow"

Szablon dot rozliczania trasy poprawić, tj w pierwszym wierszu tabeli dot. rozliczania trasy w każdej komórce wpisać wartość 'T'.
Używane oba szablony docx dokumentów zapisać w MS Word 2013, bez tzw zgodności do wcześniejszych wersji.
Szablon dot. podsumowania trasy podpiąć w archiwum do klasy o nazwie jak ustawione jest w json w "generowanie_pdf_podsumowanie_rozliczenia"."klasa_dokumentu". Oraz nadać nazwę szablonu którą skopiować do parametru json "generowanie_pdf_podsumowanie_rozliczenia"."nazwa_szablonu"
Szablon dot. ewidencji pojazdu podpiąć w archiwum do klasy o nazwie jak ustawione jest w json w "generowanie_pdf_karta_ewidencji_pojazdu"."klasa_dokumentu". Oraz nadać nazwę szablonu którą skopiować do parametru json "generowanie_pdf_karta_ewidencji_pojazdu"."nazwa_szablonu".
Usunąć całkowicie z json parametr "generowanie_pdf_podsumowanie_rozliczenia"."sciezka_do_szablonu"
Usunąć całkowicie z json parametr "generowanie_pdf_karta_ewidencji_pojazdu"."sciezka_do_szablonu"
Jeśli po dodaniu do archiwum dokumentu, mają sie zaktualizować wartości jego indeksów to ustawić w Administracja->Archiwim->Akcje przepisanie indeksów z procesu do archiwum na ustawionych w "generowanie_pdf_podsumowanie_rozliczenia"."klasa_dokumentu" i "generowanie_pdf_karta_ewidencji_pojazdu"."klasa_dokumentu" klasach dokumentów.

Rozliczenie dla procesów utworzonych jeszcze przed zaktualizowaniem plusDelegacji do BusinessTrip (kroki opisane powyżej), nie będzie działało poprawnie w BusinessTrip.
Poprawne rozliczenie po aktualizacji jest tylko możliwe jeśli proces delegacji został utworzony także w BusinessTrip.
Procesy utworzone wcześniej muszą zostać rozliczone w PlusDelegacjach.