# Awizacje okresowe

Aby można było utworzyć awizację okresową:

- typ transportu musi mieć ustawioną flagę `allowsPeriodicTransport` na `true`,
- co najmniej jedna firma będąca kontrahentem w zleceniu (przewoźnik, dostawca) musi mieć ustawioną w partnerstwie z pryncypałem flagę `allowsPeriodicTransport` na `true`.

> UWAGA! Flaga w szczegółach kontrahenta będzie możliwa do edycji tylko jeśli w jakimś typie transportu u danego pryncypała flaga `allowsPeriodicTransport` ma wartość `true`.

Jeśli powyższe warunki będą spełnione, podczas tworzenia transportu pod danymi awizacji pojawi się checkbox umożliwiający utworzenie awizacji okresowej:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/periodic-transport-active-checkbox.png>)

Po zaznaczeniu go, widoczna będzie sekcja z danymi awizacji okresowej:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/periodic-transport-form.png>)

W przypadku poprawnego uzupełnienia formularza awizacji okresowej, zapisywany transport zostanie powielony zgodnie z ustawionym interwałem. Możliwe interwały są następujące:

- `Codziennie` - powieli zapisywany transport każdego dnia w okresie zdefiniowanym datami `od` i `do`
- `Co tydzień` - powieli zapisywany transport w okresie zdefiniowanym datami `od` i `do` w wybranych dniach tygodnia
- `Co miesiąc` - powieli zapisywany transport w okresie zdefiniowanym datami `od` i `do` w miesięcznych odstępach

## Walidacje

- pierwsze okno czasowe musi być w terminie wybranym jako pierwszy dzień awizacji okresowej (data `od`),
- dodatkowo:

  - `codziennie`

    - maksymalny możliwy zakres czasu to 31 dni (31 awizacji okresowych)
  - `co tydzień`

    - maksymalny możliwy zakres czasu to 61 dni (61 awizacji - w przypadku wybrania wszystkich dni tygodnia)
    - wśród dni tygodnia musi być wybrany dzień, w który przypada początek awizacji okresowej (data `od`)
  - `co miesiąc`

    - maksymalny możliwy zakres czasu to 13 miesięcy (13 awizacji)

## Oznaczenie awizacji okresowych w tabeli transportów

Po włączeniu dla typu transportu i roli kolumny `PERIODIC_TRANSPORT_INTERNAL_INDEX` w tabeli transportów widoczna jest kolumna wyświetlająca numer awizacji okresowej:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/periodic-transport-column.png>)

## Edycja awizacji okresowej

Po zapisaniu transportu z awizacją okresową formularz awizacji okresowej nie jest możliwy do edycji:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/periodic-transport-form-disabled.png>)

Nie da się zatem edytować raz zapisanych interwałów, w których zlecenie jest powielane.

W przypadku edycji danych zlecenia, które jest awizacją okresową:

- w formularzu zlecenia,
- poprzez przeciągnięcie okna w harmonogramie,
- poprzez edycję awizacji za pomocą ołówka

i pod warunkiem, że użytkownik posiada uprawnienie `ROLE_EDIT_MULTIPLE_PERIODIC_TRANSPORTS` pytamy użytkownika, czy wprowadzone zmiany mają zostać zapisane we wszystkich **przyszłych** awizacjach okresowych:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/update-all-periodic-transports.png>)

W przypadku wyboru "OK" - wprowadzone zmiany powinny zostać zapisane we wszystkich przyszłych awizacjach okresowych.

W przypadku wyboru "Anuluj" - zmiany zapisujemy tylko w aktualnie edytowanym zleceniu.

Jeśli użytkownik nie posiada uprawnienia `ROLE_EDIT_MULTIPLE_PERIODIC_TRANSPORTS` zmiany zapisywane są tylko w aktualnie edytowanym zleceniu.

## Wysyłanie mejli o edycji zlecenia

W przypadku edycji zlecenia będącego awizacją okresową mejle o edycji danych wysyłamy tylko dla aktualnie edytowanego transportu i kilku kolejnych. O tym, dla których zleceń wyjdzie informacja o edycji decyduje ustawienie `SEND_FUTURE_PERIODIC_TRANSPORTS_EDIT_MAIL_INTERVAL_IN_DAYS` - informacja mejlowa zostanie wysłana dla zleceń z oknami czasowymi w odstępie mniejszym niż określona tam liczba dni od okna czasowego aktualnie edytowanego zlecenia.

## Usuwanie awizacji okresowej

W przypadku, gdy użytkownik posiada uprawnienie `ROLE_DELETE_MULTIPLE_PERIODIC_TRANSPORTS` i próbuje usunąć zlecenie będące awizacją okresową pytamy go, czy usunąć również wszystkie **przyszłe** awizacje okresowe:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/delete-all-periodic-transports.png>)

W przypadku wyboru "OK" - usuwamy wszystkie przyszłe awizacje okresowe.

W przypadku wyboru "Anuluj" - usuwamy tylko aktualne zlecenie.

Jeśli użytkownik nie posiada uprawnienia `ROLE_DELETE_MULTIPLE_PERIODIC_TRANSPORTS` usuwamy tylko aktualne zlecenie.

### Edycja firm w zleceniu / usuwanie stepów

Nie powinniśmy pozwolić zedytować zlecenia z awizacją okresową w taki sposób, że nie pozostanie w nim żadna firma z włączoną funkcjonalnością awizacji okresowych. W takiej sytuacji powinniśmy wyświetlić użytkownikowi komunikat:

![](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/periodic-transports/cannot-change-company.png>)

i cofnąć wprowadzone zmiany.

> UWAGA - przypadek, kiedy da się "wprowadzić zlecenie w niepoprawny stan":
>
> - mamy zlecenie, w którym jedna firma ma włączoną flagę `allowsPeriodicTransport`
> - w szczegółach firmy wyłączamy flagę
> - w zleceniu nagle nie będzie żadnej firmy z włączoną flagą
