# Action authorities - uprawnienia do wykonywania operacji na transporcie

## Filozofia

Uprawnienia są przechowywane w tabeli `authority`. To, czy dana rola (`role_group`) posiada uprawnienia do wykonania jakiejś akcji, określa wpis wiążący rolę z uprawnieniem (wpis w tabeli `role_group_authority`).

Istnieją jednak uprawnienia, które mogą posiadać dodatkowe ograniczenia - np. dotyczyć wybranego obiektu (typu transportu, custom fielda), być ograniczone czasowo, czy też być zależne od pakietu posiadanego przez firmę, do której należy użytkownik wykonujący akcję. Te dodatkowe ograniczenia przechowywane są w tabeli `authority_restriction`.

Wpisy w tabeli `authority_restriction` określają:

- jakiej akcji dotyczy dane uprawnienie (`authority_id`) - [więcej o akcjach tutaj](<#action-types---obsugiwane-akcje>),
- jakiej roli dotyczy wybrane ograniczenie (`role_group_id`),
- jakiego pakietu dotyczy wybrane ograniczenie (`pricing_plan`),
- jakiego obiektu dotyczy dane uprawnienie (`asset_id`) - jest to pole numeryczne bez referencji, przechowujące jedynie id wybranego obiektu (np. typu transportu czy custom fielda); to, jaki typ obiektu powinniśmy uzupełnić określone jest w tabeli `authority` w kolumnie `asset_type`,
- warunki, pod jakimi operacja może być wykonana (`class`)
- [więcej o zakresie uprawnienia tutaj](<#authority-ranges---zakresy-uprawnie>).

Podczas wykonywania operacji na transporcie sprawdzane są uprawnienia do jej wykonania. Przykładowo:

- użytkownik z rolą X próbuje wykonać akcję Y na transporcie typu Z,
- patrzymy czy użytkownik w ogóle posiada to uprawnienie (wpis w `role_group_authority` dla danego `authority` i `role_group`),
- wyszukujemy zatem wszystkie `authority_restriction` dla tej roli, akcji i obiektu, którego dotyczy akcja:

  - jeśli żadne nie istnieje - użytkownik może wykonać operację,
  - jeśli istnieją jakieś wpisy - sprawdzamy, czy warunki w każdym z nich nie zostały złamane.

## Action types - obsługiwane akcje

Obsługiwane akcje, których wykonanie można ograniczyć przy pomocy wpisu w `authority_restriction` (sprawdzić je można, wyszukując w bazie `authority` z uzupełnionym polem `asset_type`):

| Nazwa | Opis |
| --- | --- |
| `ACCESS_TRANSPORT` | Umożliwia dostęp do transportów w tabeli transportów. |
| `CREATE_TRANSPORT` | Umożliwia utworzenie nowego transportu |
| `ROLE_CREATE_SIMILAR` | Tworzenie zleceń poprzez "utwórz podobne" |
| `UPDATE_MAIN_DATA_SECTION` | Umożliwia edycję transportu. Jako edycję transportu rozumiemy edycję pól w formularzu zlecenia, które nie podlegają innym ograniczeniom. Pola obsługiwane inaczej, np. awizacja, pole 'Uwagi', customFieldy |
| `DELETE_TRANSPORT` | Umożliwia usunięcie transportu |
| `UPDATE_ADVICE` | Umożliwia edycję danych awizacji, tzn. dane kierowcy, ciągnika itp. Nie dotyczy okna czasowego! |
| `ADD_ADVICE` | Umożliwia dodanie awizacji w typach transportu z awizacją dwuetapową (`TransportType#adviceSavedWithTransport = false`) |
| `ADD_TIME_WINDOW` | Umożliwia dodanie okna czasowego w typach transportu z awizacją dwuetapową (`TransportType#adviceSavedWithTransport = false`) |
| `MOVE_ADVICE_WINDOW` | Umożliwia przesuwanie okna czasowego |
| `RESIZE_ADVICE_WINDOW` | Umożliwia zmianę rozmiaru okna czasowego |
| `SWAP_ADVICE_WINDOWS` | Umożliwia zamianę miejscami dwóch okien czasowych |
| `PASS_TRANSPORT` | Umożliwia przekazanie przewożnikowi zlecenia przy pomocy guzika "Przekaż" w tabeli transportów |
| `EDIT_TRANSACTION_FREIGHT` | Umożliwia edycję stawki w przekazanym zleceniu |
| `ACCEPT_AND_REJECT_TRANSPORT` | Umożliwia przejęcie lub odrzucenie zlecenia przy pomocy guzików "Odrzuć"/"Przyjmij" w tabeli transportów |
| `CREATE_AUCTION` | Umożliwia wystawienie zlecenia na aukcję |
| `BID_AUCTION` | Umożliwia licytowanie zlecenia na aukcji |
| `ACCESS_INDEX` | Umożliwia dostęp do sekcji "Indeksy" |
| `EDIT_INDEX` | Umożliwia edycję indeksów w zleceniu |
| `DELETE_INDEX` | Umożliwia usunięcie indeksu ze zlecenia |
| `ADD_DOCUMENTS` | Umożliwia dodanie dokumentu do zlecenia |
| `DELETE_DOCUMENTS` | Umożliwia usunięcie dokumentu dodanego do zlecenia |
| `ADD_NOTES` | Umożliwia dodanie notatki do zlecenia w tabeli transportów |
| `ACCESS_CUSTOM_FIELD` | Ustawia widoczność pola typu customField |
| `UPDATE_CUSTOM_FIELD` | Umożliwia edycję pola typu customField |
| `DISABLE_DATA_FIELDS` | Powoduje ukrycie niektórych pól w formularzu (wyszarzone i puste) |
| `EDIT_DESCRIPTION_FIELD` | Określa, czy użytkownik może dodawać uwagi do transportu |
| `ACCESS_DESCRIPTION_FIELD` | Określa, czy użytkownik ma dostęp do pola uwagi |
| `ACCESS_CARRIER_COMPANY_FIELD` | Określa, czy użytkownik ma dostęp do pola "carrierCompany" (przewoźnik) |
| `UPDATE_CARRIER_COMPANY_FIELD` | Umożliwia edycję pola "carrierCompany" (przewoźnik) |
| `ACCESS_SUPPLIER_COMPANY_FIELD` | Określa, czy użytkownik ma dostęp do pola "company" (firma kontrahenta w stepie) |
| `DELETE_LOAD_STEPS` | Umożliwia usuwanie etapów załadunkowych |
| `DELETE_UNLOAD_STEPS` | Umożliwia usuwanie etapów rozładunkowych |
| `ADD_LOAD_STEP_FROM_LOAD` | Umożliwia dodawanie etapów załadunkowych za etapem załadunku |
| `ADD_LOAD_STEP_FROM_UNLOAD` | Umożliwia dodawanie etapów załadunkowych za etapem rozładunku |
| `ADD_UNLOAD_STEP_FROM_LOAD` | Umożliwia dodawanie etapów rozładunkowych za etapem załadunku |
| `ADD_UNLOAD_STEP_FROM_UNLOAD` | Umożliwia dodawanie etapów rozładunkowych za etapem rozładunku |
| `MOVE_LOAD_STEPS` | Umożliwia przesuwanie etapów załadunkowych |
| `MOVE_UNLOAD_STEPS` | Umożliwia przesuwanie etapów rozładunkowych |
| `ROLE_CAN_CONFIRM_CHECKPOINT_CUSTOM_ORDER` | Umożliwia potwierdzanie tych samych statusów w dowolnej kolejności |
| `ROLE_CAN_MANAGE_STEPS_FROM_ROUTE` | Umożliwia edycję danych etapów w transporcie utworzonym z trasy |

## Authority ranges - zakresy uprawnień

### Zakresy uprawnień

Zakresy uprawnień można znaleźć w poniższej tabeli:

| Nazwa | Klasa w bazie | Opis |
| --- | --- | --- |
| `UNLIMITED` | `logintegra.user.authorities.restrictions.UnlimitedRestriction` | Operacja może być wykonana w dowolnym momencie |
| `ACTIVE` | `logintegra.user.authorities.restrictions.ActiveRestriction` | Operacja może być wykonana jedynie do czasu przejścia transportu do archiwum |
| `BEFORE_CHECKPOINT_BASED` | `logintegra.user.authorities.restrictions.BeforeCheckpointBasedRestriction` | Operacja może być wykonana jedynie do momentu zatwierdzenia statusu określonego przez `authority_restriction#task_id` |
| `AFTER_CHECKPOINT_BASED` | `logintegra.user.authorities.restrictions.AfterCheckpointBasedRestriction` | Operacja może być wykonana dopiero po zatwierdzeniu statusu określonego przez `authority_restriction#task_id` |
| `TIME_BASED` | `logintegra.user.authorities.restrictions.TimeBasedRestriction` | Możliwość wykonania operacji jest ograniczona czasowo - [więcej o ograniczeniach czasowych](<#time-based---czasowe-ograniczenie-moliwoci-wykonania-operacji>)) |
| `ADVICE_RESTRICTION_BASED` | `logintegra.user.authorities.restrictions.AdviceDatesRestriction` | Możliwość wykonania operacji jest ograniczona czasowo - może być wykonana w zakresie czasu wyznaczonym przez minimalny i maksymalny zakres czasu na awizację w zleceniu (`step#min_advice_date` i `step#max_advice_date`) |
| `ACTIVE_AUCTION_BASED` | `logintegra.user.authorities.restrictions.ActiveAuctionRestriction` | Operacja może być wykonana jedynie, gdy nie istnieje aktywna aukcja powiązana z transportem |
| `OWN_COMPANY_BASED` | `logintegra.user.authorities.restrictions.OwnCompanyRestriction` | Operacja może być wykonana jedynie przez użytkowników należących do tej samej firmy co twórca zlecenia |
| `BLOCKED` | `logintegra.user.authorities.restrictions.BlockedRestriction` | Operacja nie może być wykonana wcale |
| `NO_ROUTE_OFFER` | `logintegra.user.authorities.restrictions.NoRouteOfferRestriction` | Operacja może być wykonana jeśli transport nie posiada żadnych aktywnych ofert (`RouteOffer`), lub jeśli po automatycznym przekazaniu żaden z przewoźników nie przyjmie oferty (`Transport#lastTransactionAutoPassNotAccepted`) |
| Wszystkie obsługiwane akcje można znaleźć w kodzie - `AuthorityRestriction#AUTHORITY_RANGES` albo patrząc na klasy dziedziczące po `AuthorityRestriction`. |  |  |

### Time based - czasowe ograniczenie możliwości wykonania operacji

W przypadku, gdy operacja jest ograniczona czasowo (`TIME_BASED`), musimy wyliczyć dozwolony czas na wykonanie akcji. Wykorzystujemy do tego pola z `authority_restriction`:

- `time_reference` - określający moment z "życia" zlecenia, który będzie punktem odniesienia ([więcej o punktach odniesienia](<#time-reference---dozwolone-punkty-odniesienia>)),
- `time_interval` - określający interwał, który musimy odjąć lub dodać do punktu odniesienia z `time_reference` ([więcej o interwałach](<#time-interval---poprawne-interway>))

Przykładowo: jeśli punktem odniesienia (`time_reference`) będzie koniec najpoźniejszego okna czasowego w transporcie, a interwał (`time_interval`) będzie wynosił `-12h`, operacja będzie możliwa przez 12h przed końcem ostatniego okna czasowego w transporcie.

#### Time reference - dozwolone punkty odniesienia

Wspierane wartości `time_reference`:

| Nazwa | Opis |
| --- | --- |
| `TRANSPORT_DATE_CREATED` | Moment utworzenia transportu |
| `EARLIEST_TIME_WINDOW_START_BEFORE_CHANGE` | Początek najwcześniejszego okna czasowego związanego z transportem - przed dokonaniem zmiany |
| `EARLIEST_TIME_WINDOW_START_AFTER_CHANGE` | Początek najwcześniejszego okna czasowego związanego z transportem - po dokonaniu zmiany |
| `LATEST_TIME_WINDOW_STOP` | Koniec najpóźniejszego okna czasowego związanego z transportem |
| `EARLIEST_TIME_WINDOW_CURRENT_DATE` | Początek najwcześniejszego okna czasowego związanego z transportem w odniesieniu do bieżącej daty |

Wszystkie wartości można znaleźć w kodzie = `enum TimeReference`.

#### Time interval - poprawne interwały

Obsługiwane jednostki:

- `d` - dni,
- `h` - godziny,
- `m` - minuty,
- `s` - sekundy.

Interwały mogą być dodatnie (wówczas będą dodawane do daty referencyjnej) lub ujemne (wówczas będą od niego odejmowane). Przykładowe poprawne interwały: `12h`, `3s`, `-4m`.

## Zarządzanie uprawnieniami w interfejsie aplikacji

Aby mieć dostęp do panelu zarządzania uprawnieniami `acion_authority` należy zalogować się na użytkownika z rolą umożliwiającą zarządzanie uprawnieniami: `ROLE_MANAGE_AUTHORITIES`.

W zakładce `Ustawienia` należy wybrać rolę, dla której chcemy uprawnienia edytować:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/roleGroup.png>)

W następnym kroku należy wybrać typ transportu, który nas interesuje:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/transportType.png>)

W tabeli poniżej wyboru typu transportu pojawią się istniejące wpisy dotyczące uprawnień dla wybranej roli i typu transportu. Przykładowe wpisy:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/customFieldsAuthority.png>)

### Tworzenie nowego uprawnienia

Aby stworzyć nowe uprawnienie `authority_restriction` należy wejść do tabeli uprawnień wybranej roli oraz typu transportu (kroki opisane wyżej) a następnie kliknąć klawisz `Dodaj uprawnienie`

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/addAuthority.png>)

W widoku tworzenia nowego uprawnienia należy wybrać w polu `Uprawnienie` akcję, np. `Edycja pola niestandardowego` (w tym momencie powinno pojawić się nowe pole wyboru o nazwie `Pole niestandardowe`, określające, o które pole niestandardowe chodzi).

W następnym kroku należy wybrać pole, dla którego uprawnienia chcemy nadać oraz wybrać `Zakres` jakim chcemy ograniczyć możliwość edycji pola, np.:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/exampleAddAuthority.png>)

Po odpowiednim ustawieniu zakresu oraz dodatkowych opcji (w zależności od wybranej opcji w polu `Zakres`) należy kliknąć `Zapisz`.

## Edycja wybranego uprawnienia

Aby edytować istniejące uprawnienie `authority_restriction` należy wejść do tabeli uprawnień wybranej roli oraz typu transportu (kroki opisane wyżej) a następnie kliknąć klawisz edycji przy wybranym polu:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/authorities/action-authorities/editAuthority.png>)

Po zakończonej edycji należy kliknąć `Zapisz`.

## Zależność od pakietu firmy

Ograniczania względem danego uprawnienia dla wybranego uprawnienia wyszukujemy znajdując w bazie wpisy:

- które odnoszą się do roli, którą ma dany użytkownik (referencja do `role_group`),
- które dotyczą tego samego pakietu, który ma firma użytkownika (`pricing_plan`).
