Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
  • przycisk na formularzu zadania do którego podpinamy akcję uruchamiającą wtyczkę 'Business Trip' nie może powodować, że zadanie przestanie być dostępne dla danego użytkownika np. przycisk akceptacji
  • preferowany separator dziesiętny dla kwot, można ustawić dla parametru 'DecimalSeparator'  w 'Konfiguracja systemu'->'Parametry systemu'. Domyślnie jako separator jest używany znak ustawiony w parametrze 'DecimalSeparator' w conf'ie, a jeśli nie ma to przecinek.
    Status
    titlev1.2.3+
  • w systemie musi być zainstalowana wtyczka PCM (Plugin Configuration Manager) w minimalnej wersji 1.0.0 
    Status
    titlev1.2.26+

Kompatybilność z PlusWorkflow

Aby wtyczka mogła zostać uruchomiona i działała poprawnie, konieczne jest instalowanie odpowiedniej wersji do wersji PlusWorkflow.

...

*dla starszych wersji PlusworkFlow, dostępny był moduł plusDelegacje, którego zastąpiła wtyczka.

Rodzaje konfiguracji.

Ta dokumentacja zastępuje całkowicie sposób konfiguracji opisany i obowiązujący dla 'PlusDelegacje'.
Poniżej opisane sposoby konfiguracji wpływają na sposób działania wtyczki oraz następujące w niej rozliczenie delegacji.

RodzajOpisFormatUstawianie wartości
klienckazawiera parametry ustawiane indywidualnie dla każdego wdrożeniaparametry akcjiw PWE w parametrach akcji Business Trip
domyślnazawiera 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.
Można go znaleźć w projekcie wtyczki w .../resources/config/businessTripDefaultConfig.json

Status
titlev1.2.26+

Podgląd i edycja konfiguracji znajduje się w polu tekstowym w panelu zarządzania konfiguracjami wtyczek (PCM).

Status
titlev4.0.5+

Po wgraniu wtyczki do pola tekstowego ładowana jest automatycznie najnowsza konfiguracja z pliku json znajdującego się w projekcie wtyczki w .../resources/config/

Jeśli w katalogu domowym w ...\plugins\data\com_suncode_plugin-business-trip\config znajduje się plik businessTripCustomConfig.json, który zawiera tylko wybrane parametry z innymi wartościami niż w konfiguracji domyślnej pozyskiwanej z projektu wtyczki, wówczas w polu tekstowym konfiguracji wtyczki zostanie wyświetlona najstarsza wersja konfiguracji (przed zmianami stawek z 2022-07-28) zaktualizowana o te odpowiednie pola. Najnowsza konfiguracja nie doda się automatycznie w PCM, ponieważ konfiguracja z customowymi zmianami różni się od domyślnych ustawień.

 

zmieniona

zawiera parametry jak w konfiguracji domyślnej, ale tylko te które wymagają jednak zmiany w danym wdrożeniu

Status
titlev1.2.26+

w polu tekstowym w panelu zarządzania konfiguracjami wtyczek (wtyczka Plugin Configuration Manager - PCM) w zakładce Business Trip istnieje możliwość zmiany domyślnych parametrów.

Status
titlev4.0.5+

Aktualne wersje konfiguracji będą automatycznie dodawane jako kolejne zakładki w PCM pod warunkiem, że ostatnia konfiguracji nie była modyfikowana. Jeżeli najnowsza konfiguracjia w PCM różni się od tej domyślnej z wtyczki (była modyfikowana), to nowe wersje konfiguracji nie będą dodawane.

Można dodawać swoje konfiguracje podając w polu "effective_date" datę, od której nowa konfiguracji ma obowiązywać. Konfiguracja do obliczeń zostaje wybrana na podstawie daty zakończenia delegacji. Nazwa nowego pliku w PCM nie ma znaczenia.

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'.

Aby dokonać zmian w tej konfiguracji trzeba ponownie wczytać przygotowany plik z kompletnymi zmianami.

Status
titlev1.2.26+

Aby zmienić parametry z konfiguracji domyślnej trzeba udać się do pola tekstowego w Administracja -> Konfiguracja systemu -> Konfiguracja wtyczek -> Zainstalowane wtyczki -> Business Trip. Ukaże się konfiguracja wtyczki o nazwie config-data (JSON) (wyjątkiem jest najstarsza wersja i ma nazwę "config (JSON)") w postaci pola tekstowego i zmieniamy w nim te parametry, które chcemy zmodyfikować. Po każdej zmianie klikamy w przycisk Zapisz plik.

Konfiguracja kliencka.

Parametry ogólne dot. ustawień sposobu działania rozliczenia.
Parametr akcjiOpisUstawienie
obligatoryjne?
Wartość domyślna
'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.
 
Tak'Tak'
Czy tryb tylko do odczytu?
Status
titleV1.2.8+

określa czy ma być dozwolona jakakolwiek zmiana danych.
Jeśli 'Tak' to brak możliwości edycji pól i jakiejkolwiek operacji na delegacji. W przeciwnym razie dostępny standardowy pełny tryb pozwalający na pełną obsługę.
Nie'Nie'
Czy tabela wydatków widoczna?
określa czy tabela wydatków ma być wyświetlana czy też nie.Tak'Tak'
Czy ostrzegać, gdy daty niezgodne?Czy moduł ma wyświetlać ostrzeżenie, gdy delegacja przekroczyła wnioskowany czas.Tak'Tak'
Czy okno rozliczenia widoczne?
'Tak', powoduje wyświetlenie okna rozliczenia. 'Nie' powoduje powrót do zadania bez pokazywania okna rozliczenia.Tak'Tak'
Czy rodzaj wydatku widoczny?
określa czy kolumna "Rodzaj wydatku" w tabeli wydatków jest wyświetlana czy też nie.
Parametr usunięty. Rodzaj wydatku jest widoczny jeśli zdefiniowane są wartości w parametrze 'Rodzaje wydatków'
Status
titleV1.2.8+
Tak'Tak'
Rodzaje wydatkówwartości wyświetlane w polu "Rodzaj wydatku" (typ: combo) podczas dodawania rekordu do tabeli wydatków.
Jeśli tu nie będzie zdefiniowanych wartości to pole nie zostanie wyświetlone w wydatkach
Status
titleV1.2.8+

Nie 
Czy forma płatności widoczna?
Status
titlev1.2.5+

określa czy kolumna "Forma płatności" w tabeli wydatków jest wyświetlana czy też nie.
 Parametr usunięty. 'Formy płatności' są widoczne jeśli zdefiniowane są wartości w parametrze 'Formy płatności'
Status
titleV1.2.8+
Nie'Nie'
Formy płatności
Status
titlev1.2.5+
wartości wyświetlane w polu "Forma płatności" (typ: combo) podczas dodawania rekordu do tabeli wydatków.
Jeśli tu nie będzie zdefiniowanych wartości to pole w wydatkach nie zostanie wyświetlone w wydatkach
Status
titleV1.2.8+
Nie 
Typy dokumentów
Status
titlev1.2.9+

wartości wyświetlane w polu "Forma płatności" (typ: combo) podczas dodawania rekordu do tabeli wydatków.
Jeśli tu nie będzie zdefiniowanych wartości to pole w wydatkach nie zostanie wyświetlone w wydatkach

Status
titlev1.2.9+

Nie 
Odświeżanie kursu, etapIdentyfikator 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 polaIdentyfikator 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 rozliczeniaTak'Nie'
Podsumowanie pdf, klasaklasa dokumentów archiwum PWFL, pod którą wygenerowane podsumowanie zostanie podłączoneNie 
Podsumowanie pdf, szablonnazwa szablonu dokumentu procesu PWFL, służącego do generowania podsumowania
Nie 
Karta pojazdu pdf, drukować?
'tak' powoduje generowanie karty ewidencji pojazdu.Tak'Nie'
Karta pojazdu pdf, klasaklasa dokumentów archiwum PWFL, pod którą wygenerowana karta zostanie podłączonaNie 
Karta pojazdu pdf, szablonnazwa szablonu dokumentu procesu PWFL, służącego do generowania kartyNie 
Ukryte pola
Status
titleV1.2.8+
lista pól które zostaną ukryte i nie będą widoczne w GUI. Na osobnej stronie zostało opisane jakie pola są możliwe do ukrycia. - Ukrywanie pólNie 
Parametry wejściowe :

Parametry wejściowe to wskazanie źródła skąd rozliczenie delegacji ma pobrać 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.
Dzięki czemu przekazane wartości będą widoczne w rozliczeniu w panelu 'Dane podstawowe'.

...

Info
titleZmienne dla danych wejściowych

Zmienne procesu wykorzystywane w parametrach wejściowych, to muszą być zmienne gdzie można wybrać tylko pojedyncze wartości dlatego np. nie mogą być to zmienne w tabeli dynamicznej.
Poza zmiennymi ustawianymi w parametrach 'Kwota zaliczki', 'Waluta zaliczki' lub 'Inne do przekazania , gdzie można ustawić zmienną z tabeli albo spoza i potem analogicznie użyć w szablonie pdf.

Status
titlev1.2.11+

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

Zalecany typ
wartości w zmiennej

Ustawienie
obligatoryjne?
Numer delegacjiTekstowyNie*
*ale jeśli chcemy zapisać w tabeli wydatków jakąkolwiek daną
to musi być też zmapowany 'Numer delegacji'.
Nazwa wydatkuTekstowyNie
KosztKwotowyNie
WalutaTekstowyNie
DataDataNie
Rodzaj wydatkuTekstowyNie
Forma płatności
Status
titlev1.2.5+
TekstowyNie
Typ dokumentu
Status
titlev1.2.9+
TekstowyNie
Kurs waluty
Status
titlev1.2.19+
KwotowyNie
Współczynnik
Status
titlev1.2.19+
KwotowyNie

Konfiguracja domyślna.

Konfiguracja domyślna zawiera następujące parametry ustawione domyślnie najczęściej wykorzystywanymi wartościami.
ParametrOpis
effective_date
Status
titlev4.0.5+
data wejścia w życie konfiguracji (konfiguracja będzie wybierana na podstawie daty zakończenia delegacji)
Status
titlev4.0.5+
wydatki_walutysymbole walut, w których ma być możliwość zarejestrowania poniesionych wydatków
kilometrowkazawiera kategorie oraz przypisane koszty.
kilometrowka_dlaokreśla dla jakiego typu pojazdu, ma zostać wyliczona kilometrówka.
wymog_ewidencji_pojazduokreśla dla jakiego typu pojazdu ma być wymagane uzupełnienie pól dot ewidencja pojazdu.
srodek_transportuwszystkie środki transportu, dostępne do wyboru dla osoby rozliczającej delegację.
nawa_polskiej_walutynazwa polskiej waluty, używanej w procesie.
before_save_on_map
Status
titlev1.2.25+
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 "BusinessTrip" - 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, BusinessTrip delegacja)
{
    return zmienna;
}

Parametr usunięty. Teraz jest możliwość dodawania klas i metod klienckich. Szczegóły tutaj.

Status
titlev1.2.25+

krajmapa 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
      Status
      titlev1.2.24+

wersja mapy, od której odświeżanie będzie funkcjonować.

Parametr usunięty. Kurs walutowy pobierany jest na podstawie daty ustawionej w parametrze akcji "Pobierz kurs z".

Status
titlev1.2.24+

    • 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
      Status
      titlev1.2.24+

wartość true, powoduję, że moduł będzie odczytywał datę dla kursów walutowych, ze wskazanego pola.

Parametr usunięty. Kurs walutowy pobierany jest na podstawie daty ustawionej w parametrze akcji "Pobierz kurs z".

Status
titlev1.2.24+

    • 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
      Status
      titlev1.2.24+

wartość true, powoduje, możliwość przekazania daty z poziomu javascriptu (identyfikator data_wydania_zaliczki, w array'u identyfikatorów, przekazywanych w funkcji javascript).

Parametr usunięty. Kurs walutowy pobierany jest na podstawie daty ustawionej w parametrze akcji "Pobierz kurs z".

Status
titlev1.2.24+

    • czy_data_zaliczki_wazniejsza_od_daty_z_rozliczenia
      Status
      titlev1.2.24+

wartość true, powoduje, że data zaliczki, przekazana z poziomu javascript, jest ważniejsza od daty z wcześniejszego rozliczenia wskazanej delegacji.

Parametr usunięty. Kurs walutowy pobierany jest na podstawie daty ustawionej w parametrze akcji "Pobierz kurs z".

Status
titlev1.2.24+

  • waluty
    Status
    titlev1.2.26+

lista dostępnych walut w których może nastąpić rozliczenie

Parametr usunięty. W nowych delegacjach parametr nie jest brany pod uwagę.

Status
titlev1.2.26+

  • dieta
lista stawek diet i walut dla krajów, wg których nastąpi rozliczenie dla poszczególnych krajów
  • kraje
lista dostępnych krajów w rozliczeniu
  • 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.

Z powodu ogólnych zasad rozliczania delegacji zagranicznej nie zaleca się modyfikować tej listy. Jeżeli Klient chce takiej zmiany, to musi świadomie podjąć o tym decyzję, ponieważ zmieni się sposób rozliczania delegacji.

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
titleZachowany mechanizm określania daty kursu waluty obcej

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.
Jedynie trzy parametry, które są brane pod uwagę w tym mechaniżmie zostały umieszczone w konfiguracji klienckiej, natomiast pozostałe 6 pozostało w jsonie z konfiguracją domyślną w parametrze 'kurs_do_obliczen'.

Sposób działania.

Obliczanie delegacji.

Algorytm wyliczania delegacji opisany jest tutaj.

Data kursu walutowego. 
Status
titlev1.2.24+

Kurs walutowy pobierany jest na podstawie daty ustawionej w parametrze akcji "Pobierz kurs z". Parametr ten przyjmuje wartości:

...