# Ustawienia aukcji

W tabeli `auction_setting` możliwe jest ustawienie niektórych parametrów wykorzystywanych do obsługi aukcji w systemie. Parametry aukcji z `auction_setting` są ustawiane per typ transportu.

## Dostępne ustawienia

### Temat maila wysyłanego po utworzeniu aukcji - `auction_email_subject_pl`, `auction_email_subject_en`

Określa polski i angielski temat powiadomienia mejlowego wysyłanego po utworzeniu nowej aukcji do zlecenia. Więcej o powiadomieniu mejlowym można znaleźć [TUTAJ](<https://docs.logintegra.com/apollo-backend/1. Transports/notifications/emails/NEW_AUCTION/index.md>).

### Wersja maila wysyłanego po utworzeniu aukcji - `new_auction_email_file_name`

Określa nazwę pliku (wersję) szablonu powiadomienia mejlowego wysyłanego po utworzeniu nowej aukcji do zlecenia. Więcej o powiadomieniu mejlowym można znaleźć [TUTAJ](<https://docs.logintegra.com/apollo-backend/1. Transports/notifications/emails/NEW_AUCTION/index.md>).

### Wersja maila wysyłanego po zakończeniu aukcji bez ofert - `auction_ended_without_offers_email_file_name`

Określa nazwę pliku (wersję) szablonu powiadomienia mejlowego wysyłanego w przypadku zakończenia aukcji bez ofert. Więcej o powiadomieniu mejlowym można znaleźć [TUTAJ](<https://docs.logintegra.com/apollo-backend/1. Transports/notifications/emails/AUCTION_ENDED_WITHOUT_OFFERS/index.md>).

### Możliwość przyjęcia zlecenia z najniższą ceną - `can_accept_with_min_price`

Jeśli flaga `can_accept_with_min_price` przyjmuje wartość `false`:

- cena minimalna nie będzie widoczna w formularzu tworzenia aukcji,
- podczas dodawania oferty do aukcji przez przewoźnika będziemy sprawdzać, czy stawka nie jest niższa od ceny minimalnej (której nie widać w formularzu, więc ta walidacja zawsze przejdzie - chyba że ktoś wpisze ujemną stawkę).

Jeśli flaga `can_accept_with_min_price` przyjmuje wartość `true`:

- w formularzu tworzenia aukcji będzie widoczne pole z ceną minimalną,
- w formularzu dodawania oferty będzie widoczna dodatkowa sekcja, w której można przyjąć zlecenie za cenę minimalną od razu:

  ![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/can_accept_with_min_price_offer_form.png>) - jeśli przewoźnik kliknie w opcję przyjęcia zlecenia za cenę minimalną lub wpisze w polu "Twoja oferta" kwotę niższą od ceny minimalnej i będzie próbował ją zapisać pojawi się alert:

  ![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/can_accept_with_min_price_alert.png>) - w przypadku odpowiedzi twierdzącej, aukcja zostanie zakończona.

UWAGA! To czy zlecenie zostanie przekazane do przewoźnika, który wybrał opcję przyjął zlecenie za cenę minimalną zależy od [flagi `should_pass_to_carrier_after_auction`](<#przekazanie-zlecenia-do-przewonika-po-zakoczeniu-aukcji---should_pass_to_carrier_after_auction>).

### Domyślna waluta aukcji - `default_currency`

Określa domyślną walutę aukcji - podczas tworzenia aukcji w formularzu pole "waluta" jest uzupełniane walutą wskazywaną przez `default_currency`.

### Wyświetlanie zakresu cen - `show_price_range_fields`

Określa, czy w formularzu tworzenia aukcji powinny być widoczne pola określające zakres ofert - cenę minimalną (pod dodatkowymi warunkami - [patrz tu](<#obowizkowo-ceny-maksymalnejminimalnej---require_max_price-require_min_price>)) oraz cenę maksymalną.

### Obowiązkowość ceny maksymalnej/minimalnej - `require_max_price`, `require_min_price`

Jeśli w formularzu tworzenia aukcji jest [widoczny zakres cen](<#wywietlanie-zakresu-cen---show_price_range_fields>):

- pole `require_min_price` określa, czy pole z ceną minimalną jest obowiązkowe (jeśli [pole jest widoczne](<#moliwo-przyjcia-zlecenia-z-najnisz-cen---can_accept_with_min_price>)),
- pole `require_max_price` określa, czy pole z ceną maksymalną jest obowiązkowe.

### Przekazanie zlecenia do przewoźnika po zakończeniu aukcji - `should_pass_to_carrier_after_auction`

Określa, czy po zakończeniu aukcji zlecenie powinno zostać automatyczne przekazane do przewoźnika, które zaoferował najlepszą cenę. Możliwe są 3 sytuacje:

- `should_pass_to_carrier_after_auction = false`: po zakończeniu aukcji nie przekazujemy automatycznie zlecenia do firmy przewozowej,
- `should_pass_to_carrier_after_auction = true`:
- gdy aukcja posiada aktywne oferty (co najmniej jedną) - przekazujemy automatycznie zlecenie do firmy z najlepszą ofertą,
- aukcja nie posiada ofert - nie przekazujemy zlecenia (nie ma do kogo).

### Wyświetlanie sekcji z zablokowanymi firmami - `show_blocked_companies_section`

Jeśli flaga `show_blocked_companies_section` przyjmuje wartość `true`, wówczas w formularzu tworzenia aukcji pojawia się dodatkowa sekcja, w której wyświetlane są zablokowane firmy przewozowe:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_blocked_companies_section.png>)

### Wyświetlanie sekcji z grupami transportowymi - `show_company_groups_section`

Jeśli flaga `show_company_groups_section` przyjmuje wartość `true`, wówczas w formularzu aukcji widoczna jest dodatkowa sekcja, w której wyświetlane są grupy transportowe:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_company_groups_section.png>)

### Wyświetlanie pola z opisem oferty - `show_description_section`

Jeśli flaga `show_description_section` przyjmuje wartość `true`, wówczas w formularzu dodawania oferty widoczne jest dodatkowe pole, w którym można dodać uwagi do oferty:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_description_section_offer_form.png>)

Uwagi te widoczne na koncie twórcy aukcji w historii aukcji:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_description_section_history.png>)

### Wyświetlanie przycisku kończącego aukcję - `show_finish_auction_button`

Określa, czy w formularzu szczegółów aukcji (przycisk "Historia" podczas trwania aukcji) powinien wyświetlać się przycisk "Zakończ aukcję", który spowoduje natychmiastowe zakończenie aukcji:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_finish_auction_button.png>)

### Wyświetlanie przycisku przekazującego zlecenie do przewoźnika w trakcie trwania aukcji - `show_pass_to_carrier_button`

Określa, czy w formularzu szczegółów aukcji (przycisk "Historia" podczas trwania aukcji) przy ofertach przewoźników powinien wyświetlać się przycisk "Przekaż":

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_pass_to_carrier_button_history.png>)

Kliknięcie przycisku umożliwia przekazanie zlecenia do przewoźnika za oferowaną przez niego stawkę:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_pass_to_carrier_button_choose_carrier_form.png>)

UWAGA! Żeby przycisk się pojawił zlecenie nie może mieć przypisanego przewoźnika, a zalogowany użytkownik musi móc wykonywać akcję `PASS_TRANSPORT` zgodnie z nałożonymi ograniczeniami (patrz: [action authorities](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/authorities/action-authorities/index.md>)).

### Wyświetlanie przycisku umożliwiającego odrzucenie oferty - `show_revoke_offer_button`

Określa, czy w formularzu dodawania oferty będzie możliwość anulowania aktualnej oferty:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_revoke_offer_button.png>)

Kliknięcie w przycisk spowoduje anulowanie aktywnej oferty przewoźnika (przewoźnik może mieć tylko jedną aktywną ofertę, więc spowoduje to wycofanie oferty w ogóle).

### Klucz tłumaczeń - `translation_key`

Określa klucz tłumaczeń dla obiektów związanych z aukcjami wyświetlanych użytkownikowi. Poprawne klucze tłumaczeń:

- `AUCTION` (domyślny) - wówczas w interfejsie aplikacji aukcja nazywana jest **aukcją**,
- `INQUIRY` - wówczas w interfejsie aplikacji aukcja nazywana jest **zapytaniem ofertowym**,
- `VALUATION` - wówczas w interfejsie aplikacji aukcja nazywana jest **wyceną**.

### Wyświetlanie pól ilościowych - `show_quantity_field_in_offer_form`

Określa, czy w formularzu dodawania oferty będzie widoczne pole z ilością palet. Po przekazaniu zlecenia na aukcję w formularzu dodawania nowej oferty powinno pojawić się pole z ilością palet - osobne dla każdego stepu:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_quantity_field_in_offer_form.png>)

### Wyświetlanie danych etapów transportu w formularzu oferty - `show_step_data_in_offer_form`

Jeśli flaga `show_step_data_in_offer_form` przyjmie wartość `true`, wówczas w formularzu dodawania nowej oferty będą widoczne dane adresowe stepu oraz przypisana do stepu data:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/show_step_data_in_offer_form.png>)

### Domyślne wybieranie wszystkich przewoźników - `select_all_carriers_by_default`

Jeśli flaga `select_all_carriers_by_default` przyjmuje wartość `true`, wówczas w formularzu tworzenia aukcji domyślnie powinni być zaznaczeni wszyscy dostępni przewoźnicy.

### Eksportowanie danych aukcji do Excela - `export_auction_info_to_excel`

Określa, czy podczas generowania Excela z danymi transportów z archiwum, w dokumencie znajdą się kolumny dotyczące danych aukcji, takie jak:

- liczba utworzonych aukcji,
- data utworzenia ostatniej aukcji,
- planowana data zakończenia ostatniej aukcji,
- rzeczywista data zakończenia ostatniej aukcji,
- cena minimalna ostatniej aukcji,
- cena maksymalna ostatniej aukcji,
- liczba uzyskanych ofert ze wszystkich utworzonych aukcji,
- najniższa oferta ze wszystkich utworzonych aukcji,
- data i godzina odbioru (`arrival_date` ze wszystkich stepów załadunkowych),
- data i godzina dostawy (`arrival_date` ze wszystkich stepów rozładunkowych),
- ilość palet (ilość indeksów typu `PALLETS_COUNT`),
- waga palet (ilość indeksów typu `PALLETS_WEIGHT`).

### Wymaganie powodu wybrania oferty innej niż najlepsza - `require_reason_if_not_best_offer_is_chosen`

W przypadku gdy flaga `show_pass_to_carrier_button` przyjmuje wartość `true`, w formularzu ze szczegółami aukcji pojawiają się przyciski do przekazania zlecenia do przewoźnika podczas trwania aukcji (patrz [TUTAJ](<#wywietlanie-przycisku-przekazujcego-zlecenie-do-przewonika-w-trakcie-trwania-aukcji---show_pass_to_carrier_button>)):

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/require_reason_if_not_best_offer_is_chosen_pass_buttons.png>)

W przypadku gdy flaga `require_reason_if_not_best_offer_is_chosen` jest ustawiona na `true`, a użytkownik będzie próbował przekazać zlecenie do innej firmy niż ta oferująca najlepszą cenę, po kliknięciu w przycisk i wyświetleniu formularza do przekazania zlecenia pojawi się tam nowe, obowiązkowe pole na podanie powodu takiego działania:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/require_reason_if_not_best_offer_is_chosen_reason_field.png>)

Możliwe do wyboru powody są wyszukiwane w tabeli `special_field_option` spośród rzędów z kolumną `field` o nazwie `AUCTION_CHOOSING_REASON` i z referencją do typu transportu.

### Interwał przedłużający czas trwania aukcji - `auction_prolongation_offset_interval`

Ustawienie wskazuje:

- ile czasu przed końcem aukcji powinniśmy ją przedłużyć w przypadku zmiany lidera,
- o ile czasu powinniśmy ją przedłużyć w przypadku zmiany lidera.

Przykładowo: jeśli ustawienie to przyjmie wartość `2m`, wówczas jeśli mniej niż 2 minuty przed końcem aukcji zmieni się firma oferująca najlepszą stawkę, to aukcja powinna zostac przedłużona o 2 minuty.

### Redukcja kwoty w dodawanej do aukcji ofercie - `min_offer_reduction_size`, `require_min_offer_reduction_size_validation`

Ustawienie `min_offer_reduction_size` określa minimalną kwotę, o którą przewoźnik może obniżyć swoją poprzednią ofertę podczas licytacji. Podczas otwierania formularza dodawania nowej oferty do aukcji, jeśli przewoźnik ma już dodana do aukcji ofertę, kwota nowej oferty jest automatycznie obliczana jako poprzednia oferta obniżona o parametr `min_offer_reduction_size`.

Dodatkowo, jeśli flaga `require_min_offer_reduction_size_validation` jest ustawiona na `true`, podczas dodawania oferty patrzymy, czy jest ona niższa od poprzedniej o co najmniej `min_offer_reduction_size` - jesli nie, nie pozwalamy dodac takiej oferty do zlecenia:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/min-offer-reduction-size.png>)

### Dodawanie pliku do transportu po zakończeniu aukcji - `add_file_to_transport_after_offer_acceptation`, `add_file_to_transport_after_offer_acceptation_name`

Jeśli flaga `add_file_to_transport_after_offer_acceptation` przyjmuje wartość `true`, po wyłonieniu przewoźnika (na drodze aukcji lub przez przekazaniu zlecenia) zostanie dodany plik do zlecenia. Nazwę pliku wskazuje parametr `add_file_to_transport_after_offer_acceptation_name`.

Więcej o pliku dodawanym po przekazaniu zlecenia do przewoźnika można znaleźć [TUTAJ](<https://docs.logintegra.com/apollo-backend/1. Transports/special-features/add-file-to-transport-after-transaction/index.md>).

### Przypomnienie o końcu aukcji - `reminder_time_about_auction`

Określa, ile czasu przed końcem aukcji powinniśmy wysłać powiadomienie o jej zbliżającym się końcu. Więcej o powiadomieniu o końcu aukcji można znaleźć [TUTAJ](<https://docs.logintegra.com/apollo-backend/1. Transports/notifications/emails/AUCTION_REMINDER/index.md>).

### Domyślny czas trwania aukcji - `default_auction_finish_delay_interval`

Na podstawie tego ustawienia obliczany jest domyślny czas trwania aukcji. Termin zakończenia aukcji jest obliczany jako bieżąco data i godzina + interwał, jaki wskazuje to ustawienie.

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/default_auction_finish_delay_interval.png>)

## Edycja ustawień w interfejsie aplikacji

Dodawanie nowych obiektów `auction_setting` i edycja istniejących jest możliwa z poziomu aplikacji. Aby mieć dostęp do zarządzania `auction_setting` należy:

- mieć dostęp do zakładki "Ustawienia" (`ROLE_SETTINGS_TAB`),
- posiadać rolę `ROLE_MANAGE_AUCTION_SETTINGS`.

Aby doklikać do ustawień aukcji należy:

- przejść do zakładki "Ustawienia",
- odnaleźć sekcję "Ustawienia typów transportu" i kliknąć w nazwę typu, dla którego ustawienia chcemy edytować,
- na górze strony, po prawej stronie odnaleźć przycisk "Ustawienia aukcji".

Jeśli wybrany typ transportu nie będzie posiadał ustawień aukcji, widoczny będzie guzik umożliwiający ich dodanie:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/edit-panel-no-settings.png>)

Jeśli wybrany typ transportu będzie posiadał już ustawienia aukcji, widoczny będzie formularz umożliwiający podgląd i edycję istniejących wartości:

![](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/edit-panel-existing-settings.png>)

## Akceptacja wyboru oferty w aukcji

Opisywana funkcjonalność powstała w celu umożliwienia wskazania najlepszej oferty w aukcji przez użytkownika.

### Widoczność kolumny 'Preferowana' w historii aukcji

W celu włączenia widoczności w/w kolumny należy w sekcji `Ustawienia związane z przekazywaniem zlecenia do przewożnika` zaznaczyć checkbox `Wymagaj akceptacji oferty`. Należy pamiętać, że wspomniana kolumna będą widoczna tylko dla użytkowników pryncypała

![preferred-offer-checkbox.png](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/transport-types/..%2F..%2Fstatic%2FAuthorities %26 Settings%2Ftransport-types%2Ftransaction-settings%2Fpreferred-offer-checkbox.png>)

### Widoczność przycisku 'Oznacz' w kolumnie 'Preferowana'

Aby użytkownik zobaczył przycisk 'Oznacz', należy w ustawieniach dla wskazanej roli dodać uprawnienie zależne od typu transportu o nazwie 'Oznaczenie oferty z aukcji jako preferowana' ![preferred-offer-auction-column.png](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/transport-types/..%2F..%2Fstatic%2FAuthorities %26 Settings%2Ftransport-types%2Ftransaction-settings%2Fpreferred-offer-auction-column.png>)

### Oznaczenie oferty jako preferowana

Po ustaleniu ustawień zgodnie z poprzednimi punktami w historii aukcji powinna być widoczna kolumna 'Preferowana' oraz przycisk 'Oznacz' przy aktywnych ofertach danej aukcji. W celu oznaczenia oferty należy kliknąć przycisk 'Oznacz', w jego miejscu pojawi się 'Tak'. Po tej czynności przyciski do oznaczenia oferty preferowanej przy innych ofertach znikną. ![preferred-offer-marked-offer.png](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/transport-types/..%2F..%2Fstatic%2FAuthorities %26 Settings%2Ftransport-types%2Ftransaction-settings%2Fpreferred-offer-marked-offer.png>)

### Wyświetlanie "Wymaga akceptacji" jeżeli wymaga akceptacji

Po oznaczeniu w aukcji oferty jako preferowane w tabeli w kolumnie 'Przewoźnik' pojawi się 'Wymaga akceptacji'. ![preferred-offer-acceptance-info.png](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/transport-types/..%2F..%2Fstatic%2FAuthorities %26 Settings%2Ftransport-types%2Ftransaction-settings%2Fpreferred-offer-acceptance-info.png>)

### Wyświetlanie najlepszej oferty z aukcji w tabeli zleceń

Dla transportu z aukcją, w której została oznaczona oferta preferowana w kolumnie 'Fracht' zamiast najwyższej oferty pokażemy tę preferowaną. ![preferred-offer-highest-offer.png](<https://docs.logintegra.com/apollo-backend/6. Authorities %26 Settings/transport-types/..%2F..%2Fstatic%2FAuthorities %26 Settings%2Ftransport-types%2Ftransaction-settings%2Fpreferred-offer-highest-offer.png>)

## Przypisanie domyślnej grupy przewoźników do typu transportu

W ustawieniach aukcji dodaliśmy możliwość wskazania domyślnych grup przewoźnika w formularzu aukcji. Dodatkowo możliwe jest sterowanie widocznością sekcji grup przewoźników tym formularzu. ![default\_carriers\_groups\_sample.png](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/default_carriers_groups_sample.png>)

### Wskazanie domyślnych grup przewoźników

Dostępne grupy przewoźników widoczne są w sekcji 'Domyślne grupy przewoźników'. Oznaczone w tym miejscu grupy zostaną domyślnie wybrane podczas tworzenia nowej aukcji.

![default\_carriers\_groups.png](<https://docs.logintegra.com/apollo-backend/static/Authorities %26 Settings/transport-types/auction-settings/default_carriers_groups.png>)

Należy pamiętać, że widoczność sekcji grupowania w formularzu aukcji jest uzależniona od flagi 'Widoczność sekcji z grupowaniem przewoźników przy tworzeniu aukcji'

### Widoczność grup przewoźników

Widoczność listy przewoźników przy tworzeniu aukcji zależna jest od ustawienia 'Widoczność listy przewoźników przy tworzeniu aukcji'. Flaga dostępna jest w sekcji 'Ustawienia ogólne', domyślnie jest włączona po utworzeniu ustawień aukcji dla danego typu transportu. ![carriers\_groups\_visibility.png](<https://docs.logintegra.com/apollo-backend/static/Authorities &amp; Settings/transport-types/auction-settings/carriers_groups_visibility.png>)
