# Opis dodatkowych założeń procesu Delivery dla klienta Euroglas

## Mapowanie pól z XML na SapToLpFileDTO i Delivery

| Plik XML | SapToLpFileDTO | Delivery |
| --- | --- | --- |
|  | task | \- |
|  | shipmentNumber | deliveryNumber |
|  | incoterms | incoterms |
|  | netWeight | weight |
|  | loadProposedDate | loadStep.arrivalDate |
|  | loadPlaceOfDeparture | loadStep.warehouse |
|  | unloadAddressName | unloadStep.address.recipient |
|  | unloadAddressName2 | unloadStep.address.recipient |
|  | unloadAddressStreet | unloadStep.address.street |
|  | unloadAddressStreet2 | unloadStep.address.street |
|  | unloadAddressZipCode | unloadStep.address.postal |
|  | unloadAddressCity | unloadStep.address.city |
|  | unloadAddressCountry | unloadStep.address.country |
|  | plannedDeliveryDates | unloadStep.arrivalDate |
|  | consolidatedShipmentNumber | parentDeliveryNumber |
|  | description | description |
|  | modeOfTransport | modeOfTransport |
|  | freightCost | freightCost |
|  | freightCostCurrency | freightCostCurrency |
|  | state | \- |

## Utworzenie transportu

W euroglas każde nowe Delivery powinno utworzyć transport. Za nowe Delivery uznajemy takie, które posiada w kluczu `task` wartość: `NEW` lub nie znajdziemy w systemie aktywnej wysyłki, której `deliveryNumber` jest taki sam jak `shipmentNumber` oraz w kluczu `state` wartość: `Preliminary`. Delivery musi posiadać unikalny numer w `shipmentNumber` w obrębie `consolidatedShipmentNumber`. W utworzonym z Delivery transporcie w stepie załadunkowym powinniśmy mieć magazyn wybrany na podstawie wartości z `loadPlaceOfDeparture`. W stepie rozładunkowym powinniśmy mieć adres z danych z Delivery oraz `arrivalDate` który jest najpóźniejszą datą z klucza `plannedDeliveryDates`.

Nowo utworzony transport w polu `erpIdentifier` powinien mieć wartość z `Delivery#parentDeliveryNumber`, a w `altIdentifier` z `Delivery#deliveryNumber`.

## Dołączenie kolejnego Delivery do Transportu

Jeśli nowe Delivery będzie miało taki sam `consolidatedShipmentNumber` jak istniejące już w systemie inne Delivery, zostanie dołączone do Transportu powiązanego z tamtym Delivery. W takiej sytuacji, jeśli stepy są zgodne, zostaną powiązane. Jeśli jednak nowe Delivery ma inne dane adresowe lub daty `plannedDeliveryDates` w Transporcie zostanie utworzony nowy step rozładunkowy, do `altIdentifier` dopiszemy kolejny `shipmentNumber`,  
a następnie wszystkie stepy zostaną posortowane wg `arrivalDate`.

## Edycja Delivery i Transportu

Jeśli Delivery w kluczu `task` posiada jakąkolwiek inną wartość niż `NEW` zostaje uznane za edycję Delivery. W takim przypadku spróbujemy znaleźć Delivery posiadające takie samo `shipmentNumber` i `consolidatedShipmentNumber` i zaktualizujemy w nim pola zgodnie z nowymi wartoścami przysłanymi z msp. Następnie zmiany te zostaną przeniesione na stepy w transporcie i stepy zostaną posortowane wg `arrivalDate`.

Co więcej, jeśli podczas edycji zmianie uległa data stepu rozładunkowego lub `modeOfTransport`, a Transport posiada już okno czasowe, należy usunąć okno, awizację oraz zresetować statusy do stanu sprzed awizacji

## Anulowanie Delivery

Specjalnym przypadkiem edycji Delivery jest anulowanie (usunięcie) Delivery. Jeśli w polu `state` otrzymamy wartość `Cancelled` to musimy:

- odpiąć delivery od transportu -\> co pociąga za sobą edycję transportu — przegenerowanie na nowo stepów,
- w delivery ustawiamy flagę związaną z usunięciem,
- dodajemy wpis w historii transportu o usunięciu delivery,
- jeżeli delivery było ostatnim delivery w transport, to w transport musimy ustawić status "Usunięty", nie usuwamy również ostatniego stepu rozładunkowego.

## Odpowiedz do mikroserwisu po wykonaniu procesu

Po każdorazowym otrzymaniu wiadomości, apollo zawsze wysyła odpowiedź `SapToLpFileConfirmationDTO`. W przypadku sukcesu:

```
{
  "fileId": <id_pliku_z_msp>,
  "principalAlias": <alias_pryncypala>,
  "status": "OK",
  "type": "com.logintegra.microserviceparser.dto.messages.SapToLpFileConfirmationDTO",
  "errorMsg": null
} 
```

W przypadku jakiekolwiek błedu:

```
{
  "fileId": <id_pliku_z_msp>,
  "principalAlias": <alias_pryncypala>,
  "status": "KO",
  "type": "com.logintegra.microserviceparser.dto.messages.SapToLpFileConfirmationDTO",
  "errorMsg": <błąd>
} 
```

## Delivery Workflow, Taski i powiązane ze sobą statusy

Dla euroglas został utworzony nowy Workflow dla Delivery:

```
-[ RECORD 1 ]-------+------------------------
name                | DELIVERY_Wysyłki
transport_type_id   | 338158240
delivery_workflow   | t
```

Do tego workflow zostały przypisane 3 taski

```
-[ RECORD 1 ]-----------------------------+----------------------
checkpoint_name                           | Utworzony
checkpoint_name_en                        | Created
alias                                     | Preliminary
should_confirm_related_checkpoint         | 
should_be_confirmed_by_related_checkpoint | 
-[ RECORD 2 ]-----------------------------+----------------------
checkpoint_name                           | Dostarczenie towaru
checkpoint_name_en                        | Delivery of the goods
alias                                     | DELIVERED
should_confirm_related_checkpoint         | 
should_be_confirmed_by_related_checkpoint | t
-[ RECORD 3 ]-----------------------------+----------------------
checkpoint_name                           | Zamknięty
checkpoint_name_en                        | Closed
alias                                     | Closed
should_confirm_related_checkpoint         | t
should_be_confirmed_by_related_checkpoint |
```

Nowe Delivery posiadaja `state: Preliminary`, powoduje to, że powiązany z nim aliasem status `Utworzony` jest zamykany od razu po utworzeniu transportu. Delivery które zostaną załadowane otrzymują `state: Preliminary` powoduje to, że powiązany z nim aliasem status `Zamknięty` jest zamykany, oprócz tego zamykane są wszystkie etapy transportu powiązane stepem posiadające flagę `should_be_confirmed_by_related_checkpoint` (czyli w tym przypadku status transportu `Załadowany`). Status `Dostarczenie towaru` posiada flagę `should_be_confirmed_by_related_checkpoint` więc zostaje zatwierdzony, kiedy powiązany z nim status w Transporcie zostanie zamknięty (w tym przypadku `Dostarczono`).

## Delivery Role Group

Do procesu Delivery dla Euroglas wymagana jest `RoleGroup` która posiada flagę `usedForDeliveries` oraz użytkownik dodany do tej roli. Użytkownik ten będzie twórcą transportu utworzonego z Delivery oraz bedzie przypisywany do wszystkich operacji w procesie, które wymagają podania użytkownika.

## Kod magazynu

W wiadomości `SapToLpFileDTO` mamy informacje o magazynie załadunkowym w kluczu `loadPlaceOfDeparture`. Dla euroglas jest to wartość z klucza `PLACE_OF_DEPARTURE` z pliku xml parsowanego przez mikroserwis:

![LoadPlaceOfDeparture](<https://docs.logintegra.com/apollo-backend/static/Delivery/euroglas/xml-place-of-departure.png>)

W Apollo chociaż jeden magazyn musi posiadać w ustawieniach odpowiadający klucz (`Warehouse#integrationCode`), aby utworzyć transport i ustawić ten magazyn jako załadunkowy

![IntegrationCode](<https://docs.logintegra.com/apollo-backend/static/Delivery/euroglas/warehouse-integration-code.png>)

## Strefy Magazynowe

W wiadomości `SapToLpFileDTO` mamy informacje o środku transportu w kluczu `modeOfTransport`. Dla euroglas jest to wartość z klucza `C_LKW_TYP_DESC` z pliku xml parsowanego przez mikroserwis:

![XmlModeOfTarnsport](<https://docs.logintegra.com/apollo-backend/static/Delivery/euroglas/xml-mode-of-transport.png>)

W ustawieniach strefy magazynowej możemy po średniku podać wartości (`WarehouseZone#deliveryModeOfTransport`). Transport utworzony z Delivery posiadającej taką samą wartość w `modeOfTransport`, będzie miał step załadunkowy przypisany do tej strefy.

![ModeOfTransport](<https://docs.logintegra.com/apollo-backend/static/Delivery/euroglas/delivery-mode-of-transport.png>)

Możliwe jest również ustawienie strefy domyślnej `WarehouseZone#deliveryDefaultZone`:

![DefaultZone](<https://docs.logintegra.com/apollo-backend/static/Delivery/euroglas/delivery-default-zone.png>)

## Przykładowa wiadomość XML

```
<SEND_SHIPMENT
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SHIPMENT
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <TASK>NEW</TASK>
        <SHIPMRNT_ID>XXX</SHIPMRNT_ID>
        <PARENT_CONSOL_SHIPMENT_ID>XXX</PARENT_CONSOL_SHIPMENT_ID>
        <CONTRACT>0057</CONTRACT>
        <CONTRACT_DESC>EGS Ujazd</CONTRACT_DESC>
        <FORWARD_AGENT_ID>02</FORWARD_AGENT_ID>
        <FORWARD_AGENT_NAME>Van Huet Trucking GmbH</FORWARD_AGENT_NAME>
        <SHIP_VIA_CODE>ILS</SHIP_VIA_CODE>
        <SHIP_VIA_CODE_DESC>Innenlader Standard</SHIP_VIA_CODE_DESC>
        <C_LKW_TYP>ILS</C_LKW_TYP>
        <C_LKW_TYP_DESC>Innenlader Standard</C_LKW_TYP_DESC>
        <SHIP_DATE>2024-01-23T00:00:00</SHIP_DATE>
        <C_DELIVERY_DATE xsi:nil="1"/>
        <C_NET_WEIGHT_GLASS>5090.8032</C_NET_WEIGHT_GLASS>
        <C_GROSS_WEIGHT>5090.8032</C_GROSS_WEIGHT>
        <C_LOAD_DEPTH>14.2</C_LOAD_DEPTH>
        <C_NOTE_DISPO xsi:nil="1"/>
        <C_NOTE_FORWARDER xsi:nil="1"/>
        <C_OPTIMIZATION_ID xsi:nil="1"/>
        <C_RACK_CATEGORY>30</C_RACK_CATEGORY>
        <C_FREIGHT_COST xsi:nil="1"/>
        <C_DELIVERY_INFO xsi:nil="1"/>
        <SHIP_ADDR_NO>IGP BIAŁYSTOK</SHIP_ADDR_NO>
        <CUSTOMER_ADDRESS_NAME>PILKINGTON IGP Sp. z o.o.</CUSTOMER_ADDRESS_NAME>
        <CUSTOMER_ADDRESS1>IGP oddział Białystok</CUSTOMER_ADDRESS1>
        <CUSTOMER_ADDRESS2>Welurowa 126</CUSTOMER_ADDRESS2>
        <CUSTOMER_ZIP_CODE>15-680</CUSTOMER_ZIP_CODE>
        <CUSTOMER_CITY>Białystok</CUSTOMER_CITY>
        <CUSTOMER_COUNTRY>PL - POLSKA</CUSTOMER_COUNTRY>
        <C_REAL_SHIP_DATE_FORWARDER xsi:nil="1"/>
        <C_ORDER_NO xsi:nil="1"/>
        <SHIPMENT_FREIGHT_PAYER_ID xsi:nil="1"/>
        <PLACE_OF_DEPARTURE>UJD</PLACE_OF_DEPARTURE>
        <DELIVERY_TERMS>DAP</DELIVERY_TERMS>
        <STATE>Closed</STATE>
        <ORDER_LINES
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ORDER_LINE
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ORDER_NO>715302</ORDER_NO>
                <LINE>1</LINE>
                <REL_NO>1</REL_NO>
                <LINE_ITEM_NO>0</LINE_ITEM_NO>
                <SALES_PART_NO>F4C01</SALES_PART_NO>
                <SALES_PART_DESC>*EUROFLOAT 4MM</SALES_PART_DESC>
                <C_WIDTH>3210</C_WIDTH>
                <C_LENGTH>6000</C_LENGTH>
                <C_PACKAGING>0</C_PACKAGING>
                <C_POSITION>L</C_POSITION>
                <PLANNED_DELIVERY_DATE>2024-02-24T12:00:00</PLANNED_DELIVERY_DATE>
                <PLANNED_SHIP_DATE>2024-02-24T00:00:00</PLANNED_SHIP_DATE>
                <DOCK_CODE xsi:nil="1"/>
                <C_NOTE_FORWARDER_SALES xsi:nil="1"/>
            </ORDER_LINE>
            <ORDER_LINE
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ORDER_NO>715302</ORDER_NO>
                <LINE>1</LINE>
                <REL_NO>2</REL_NO>
                <LINE_ITEM_NO>0</LINE_ITEM_NO>
                <SALES_PART_NO>F4C01</SALES_PART_NO>
                <SALES_PART_DESC>*EUROFLOAT 4MM</SALES_PART_DESC>
                <C_WIDTH>3210</C_WIDTH>
                <C_LENGTH>6000</C_LENGTH>
                <C_PACKAGING>0</C_PACKAGING>
                <C_POSITION>L</C_POSITION>
                <PLANNED_DELIVERY_DATE>2024-01-23T00:00:00</PLANNED_DELIVERY_DATE>
                <PLANNED_SHIP_DATE>2024-01-23T00:00:00</PLANNED_SHIP_DATE>
                <DOCK_CODE xsi:nil="1"/>
                <C_NOTE_FORWARDER_SALES xsi:nil="1"/>
            </ORDER_LINE>
        </ORDER_LINES>
    </SHIPMENT>
</SEND_SHIPMENT>
```

## Przykładowa wiadomość SapToLpFileDTO

```
{
  "principalAlias": "EUROGLAS",
  "fileId": 1,
  "task": "NEW",
  "shipmentNumber": "XXX",
  "incoterms": "DAP",
  "nettoWeight": "5090.8032",
  "loadProposedDate": "2024-01-23T00:00:00",
  "loadPlaceOfDeparture": "UJD",
  "unloadAddressName": "IGP BIAŁYSTOK",
  "unloadAddressName2": "PILKINGTON IGP Sp. z o.o.",
  "unloadAddressStreet": "IGP oddział Białystok",
  "unloadAddressStreet2": "Welurowa 126",
  "unloadAddressZipCode": "15-680",
  "unloadAddressCity": "Białystok",
  "unloadAddressCountry": "PL - POLSKA",
  "plannedDeliveryDates": "2024-02-24T12:00:00::2024-01-23T00:00:00",
  "modeOfTransport": "Innenlader Standard",
  "consolidatedShipmentNumber": "XXX",
  "description": null,
  "freightCost": null,
  "freightCostCurrency": null,
  "state": "Closed",
  "customFields": [
    {
      "alias": "TRANSPORT_CODE",
      "value": "ILS"
    },
    {
      "alias": "TRANSPORT_CODE_DESCRIPTION",
      "value": "Innenlader Standard"
    },
    {
      "alias": "TRANSPORT_TYPE",
      "value": "ILS"
    },
    {
      "alias": "TRANSPORT_TYPE_DESCRIPTION",
      "value": "Innenlader Standard"
    },
    {
      "alias": "AGGREGATED_SIZE",
      "value": "3210x6000::3210x6000"
    }
  ]
}
```

## Przykładowe wiadomości SapToLpFileConfirmationDTO

OK:

```
{
  "errorMsg": null,
  "fileId": "6",
  "principalAlias": "EUROGLAS",
  "status": "OK",
  "type": "com.logintegra.microserviceparser.dto.messages.SapToLpFileConfirmationDTO"
}
```

KO:

```
{
  "errorMsg": "Delivery o numerze :: XXXa :: już istnieje. !",
  "fileId": "5",
  "principalAlias": "EUROGLAS",
  "status": "KO",
  "type": "com.logintegra.microserviceparser.dto.messages.SapToLpFileConfirmationDTO"
}
```
