# Zlecenie transportowe

Zlecenie transportowe jest dokumentem PDF, który generowany jest po utworzeniu lub aktualizacja transportu. Dokument zawiera wszystkie podstawowe informacje dotyczące transportu: - Numer transportu (domyślnie internal\_index, ale może być też erp\_identifier lub alt\_identifier – patrz sekcja Ustawienia) - Termin załadunku - Miejsca załadunku - Termin rozładunku - Miejsca rozładunku - Fracht (z sufixem pobieranym z ustawień) - Ilość towaru - Waga - Wybrane custom fieldy (pobierane z ustawień) - Uwagi z transportu - Dodatkowe uwagi z transportu

# Mapowanie danych

Informacje wyświetlane na dokumencie mapowane są na podstawie poniższej grafiki:

![transport\_order\_mapping.png](<https://docs.logintegra.com/apollo-backend/1. Transports/documents/generic-transport-order-document/..%2F..%2F..%2Fstatic%2FTransports%2Fdocuments%2Fgeneric-transport-order%2Ftransport_order_mapping.png>)

# Ustawienia

Ustawienia dotyczące dokumentu zlecenia transportowego znajdują się w zakładce `Ustawienia` -\> `Ustawienia typu transportu` -\> `Ustawienia zlecenia transportowego`

![transport\_order\_settings.png](<https://docs.logintegra.com/apollo-backend/1. Transports/documents/generic-transport-order-document/..%2F..%2F..%2Fstatic%2FTransports%2Fdocuments%2Fgeneric-transport-order%2Ftransport_order_settings.png>)

1. `Stały tekst dopisywany przy frachcie` - określa sufix dodawany do pola `Fracht` na dokumencie.
2. `W przypadku zakresu czasu w stepie wyświetlaj tylko datę i godzinę początku zakresu` - Określa, czy data załadunku/rozładunku powinna wyświetlać zakres "od-do" czy tylko datę "od".
3. `Określa, czy dla transportów w typie transportu powinien zostać wygenerowany dokument zlecenia transportowego` - Określa, czy dokument zlecenia transportowego powinien być generowany dla typu transportu, którego dotyczą ustawienia.
4. `Wybrane custom-fieldy będą wyświetlane w dokumencie zlecenia transportowego (Wpisz nazwy cfów po przecinku)` - Określa, jakie custom fieldy powinny być generowane na dokumencie, nazwy cfów powinny być wpisywane po przecinku bez spacji.
5. `Identyfikator do numerowania dokumentu` - pozwala wybrać, po którym identyfikatorze dokument Zlecenie transportowe będzie numerowany. Dostępne opcje:

   - `internalIndex zlecenia` **domyślna opcja**
   - `erpIdentifier`
   - `altIdentifier`

# Generowanie dokumentu

Za generowanie dokumentu odpowiedzialna jest metoda `TransportOrderDocumentService#generateGenericTransportOrderDocument`, jest ona wywoływana podczas zapisu transportu w `TransportService#saveTransport` oraz podczas aktualizacji transportu w `TransportService#updateTransport`.

Podczas aktualizacji transportu sprawdzamy, czy plik o tej samej nazwie już istnieje, jeśli tak to go usuwamy i zastępujemy nowo wygenerowanym dokumentem:

```
        IPdfDocument doc = new GenericTransportOrderDocument(gtom)
        File oldFile = File.findByNameAndTransport(doc.fileName, transport)
        if (oldFile) {
            transportFileService.deleteFile(oldFile, transport.principalCompany)
        }
```

Dane potrzebne do wygenerowania dokumentu gromadzone są w klasie `GenericTransportOrderModel`, mapowanie danych odbywa się w klasie `GenericTransportOrderModelBuilder`. Po utworzeniu model przekazywany jest do klasy `GenericTransportOrderDocument`, w której dane mapowane są do odpowiednich tabeli dokumentu PDF.

Wartość używana do numeracji dokumentu jest wybierana zgodnie z ustawieniem documentIdentifier:

```
private String getSelectedIdentifier() {
   String identifierTypeString = transportOrderSettings?.documentIdentifier ?: TransportOrderSettings.DocumentIdentifierType.INTERNAL_INDEX.name()
   ...
    switch (identifierType) {
        case ERP_IDENTIFIER:
            selectedIdentifier = transport?.erpIdentifier
            break
        case ALT_IDENTIFIER:
            selectedIdentifier = transport?.altIdentifier
            break
        case INTERNAL_INDEX:
        default:
            selectedIdentifier = transport?.internalIndex
            break
        }
        return selectedIdentifier ?: ""
   }
```

Plik zapisuje się pod nazwą zgodną z wybranym identyfikatorem:

```
private void setFileName() {
    genericTransportOrderModel.fileName = fileNamePrefix + getSelectedIdentifier()
}

private void setDocumentTitle() {
    this.genericTransportOrderModel.documentTitle = documentTitle + getSelectedIdentifier()
}
```

Logo pryncypała pobierane jest z dysku google, w klasie `GenericTransportOrderModelBuilder` podawana jest stała wartość ścieżki logo pryncypała np.: `private final static String logoPath = "resources/images/pelletenergy/pelletenergyLogo.png"`.

Po pomyślnym wygenerowaniu dokumentu zlecenia transportowego plik zapisywany jest na dysku google (lub serwerze ftp, w zależności od pryncypała) w folderze, którego nazwa to id transportu. Nazwa pliku określana jest w klasie `GenericTransportOrderModelBuilder`, prefix nazwy dokumentu ustalany jest w stałej `fileNamePrefix`: `private final static String fileNamePrefix = "Zlecenie_transportowe_"`, następnie prefix dodawany jest do `internal_index` transportu w metodzie `setFileName`:

```
    private void setFileName() {
        this.genericTransportOrderModel.fileName = fileNamePrefix + transport?.internalIndex
    }
```

# Pobieranie dokumentu

Wygenerowany dokument zlecenia transportowego można pobrać w sekcji dokumenty w szczegółach transportu:

![transport\_detalis\_document\_section.png](<https://docs.logintegra.com/apollo-backend/1. Transports/documents/generic-transport-order-document/..%2F..%2F..%2Fstatic%2FTransports%2Fdocuments%2Fgeneric-transport-order%2Ftransport_detalis_document_section.png>)

lub w kolumnie dokumentu z tabeli transportu: ![document\_section.png](<https://docs.logintegra.com/apollo-backend/1. Transports/documents/generic-transport-order-document/..%2F..%2F..%2Fstatic%2FTransports%2Fdocuments%2Fgeneric-transport-order%2Fdocument_section.png>)
