Skip to content

Commit

Permalink
DT-744: Add DG scenario for eBL
Browse files Browse the repository at this point in the history 
Signed-off-by: Niels Thykier <[email protected]>
  • Loading branch information
@nt-gt
nt-gt committed Dec 18, 2023
1 parent 049e550 commit 6c86516
Show file tree
Hide file tree
Showing 7 changed files with 219 additions and 82 deletions.
3 changes: 2 additions & 1 deletion ebl/src/main/java/org/dcsa/conformance/standards/ebl/EblScenarioListBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ public static EblScenarioListBuilder buildTree(
threadLocalShipperPartyName.set(shipperPartyName);
return noAction().thenEither(
carrier_SupplyScenarioParameters(ScenarioType.REGULAR).thenAllPathsFrom(SI_START),
carrier_SupplyScenarioParameters(ScenarioType.REEFER).thenHappyPathFrom(SI_START)
carrier_SupplyScenarioParameters(ScenarioType.REEFER).thenHappyPathFrom(SI_START),
carrier_SupplyScenarioParameters(ScenarioType.DG).thenHappyPathFrom(SI_START)
);
}

Expand Down
22 changes: 15 additions & 7 deletions ...ava/org/dcsa/conformance/standards/ebl/action/Carrier_SupplyScenarioParametersAction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@
import com.fasterxml.jackson.databind.node.ObjectNode;
import java.util.function.Consumer;
import java.util.function.Supplier;

import lombok.NonNull;
import org.dcsa.conformance.standards.ebl.checks.ScenarioType;
import org.dcsa.conformance.standards.ebl.party.CarrierScenarioParameters;
import org.dcsa.conformance.standards.ebl.party.DynamicScenarioParameters;

public class Carrier_SupplyScenarioParametersAction extends EblAction {
private CarrierScenarioParameters carrierScenarioParameters = null;
Expand All @@ -23,6 +21,7 @@ public Carrier_SupplyScenarioParametersAction(String carrierPartyName, @NonNull
switch (scenarioType) {
case REGULAR -> "SupplyCSP";
case REEFER -> "SupplyCSP-AR";
case DG -> "SupplyCSP-DG";
},
-1);
this.scenarioType = scenarioType;
Expand Down Expand Up @@ -73,19 +72,28 @@ public JsonNode getJsonForHumanReadablePrompt() {
"Commodity subreference for regular (non-DG, non-reefer) cargo",
// Any valid regular equipment reference will do as an example.
"NARU3472484",
"DKCPH",
"851712",
"300 boxes of blue shoes size 47"
"DKAAR",
"640510",
"Shoes - black, 400 boxes"
);
case REEFER -> new CarrierScenarioParameters(
"Booking Reference",
"Commodity subreference for cargo requiring an *active* reefer",
// Any valid reefer equipment reference will do as an example.
"BBCU5200220",
"DKCPH",
"KKFU6671914",
"DKAAR",
"04052090",
"Dairy products"
);
case DG -> new CarrierScenarioParameters(
"Booking Reference",
"Commodity subreference for dangerous goods cargo",
// Any valid regular equipment reference will do as an example.
"NARU3472484",
"DKAAR",
"293499",
"Environmentally hazardous substance, liquid, N.O.S (Propiconazole)"
);
};
return csp.toJson();
}
Expand Down
1 change: 1 addition & 0 deletions ebl/src/main/java/org/dcsa/conformance/standards/ebl/checks/ScenarioType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
public enum ScenarioType {
REGULAR,
REEFER,
DG,
;
}
121 changes: 109 additions & 12 deletions ebl/src/main/java/org/dcsa/conformance/standards/ebl/models/CarrierShippingInstructions.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,26 @@ public class CarrierShippingInstructions {
"isShippedOnBoardType",
};

private static final Map<String, VesselDetails> CARRIER_SMDG_2_VESSEL = Map.ofEntries(
Map.entry("CMA", new VesselDetails("9839179", "CMA CGM Jacques Saadé")),
Map.entry("EMC", new VesselDetails("9893890", "Ever Ace")),
Map.entry("HLC", new VesselDetails("9540118", "Berlin Express")),
Map.entry("HMM", new VesselDetails("9863297", "HMM Algeciras")),
Map.entry("MSK", new VesselDetails("9778791", "Madrid Maersk")),
Map.entry("MSC", new VesselDetails("9839430", "MSC Gülsün")),
Map.entry("ONE", new VesselDetails("9865879", "CONFIDENCE")),
Map.entry("YML", new VesselDetails("9757228", "YM WARRANTY")),
Map.entry("ZIM", new VesselDetails("9699115", "ZIM WILMINGTON"))

);

private static JsonNode issuingCarrier(String name, String smdgCode) {
var issuingCarrier = OBJECT_MAPPER.createObjectNode()
.put("partyName", name);
issuingCarrier
.putArray("identifyingCodes")
.addObject()
.put("DCSAResponsibleAgencyCode", "SMDG")
.put("codeListProvider", "SMDG")
.put("codeListName", "LCL")
.put("partyCode", smdgCode);
return issuingCarrier;
Expand Down Expand Up @@ -184,9 +197,33 @@ public void provideField(JsonNode source, ObjectNode dest) {
// change some other detail (like the requested change or the issuance date). But in the
// conformance tests every thing happens in the same day and when the conformance toolkit is
// the carrier, booking amendments are "zero-change" amendments.
field("charges", (o, a) -> addCharge(o.putArray(a)), (o, a) -> addCharge(o.path(a)))
field("charges", (o, a) -> addCharge(o.putArray(a)), (o, a) -> addCharge(o.path(a))),
initialFieldValue("transports", (o, a) -> initializeTransports(o, o.putObject(a)))
};

private static void initializeTransports(ObjectNode td, ObjectNode transportsNode) {
var carrierCode = td.required("carrierCode").asText("<MISSING>");
var vessel = CARRIER_SMDG_2_VESSEL.get(carrierCode);
if (vessel == null) {
throw new AssertionError("Cannot find a vessel for carrier with code: " + carrierCode);
}
var today = LocalDate.now();
// The voyage is/was based on scheduled voyage of "MARSEILLE MAERSK" ("402E") as it looked on
// December 15th, 2023. The schedule has been rebased onto "today"
transportsNode.put("plannedDepartureDate", today.toString())
.put("plannedArrivalDate", today.plusDays(2).toString());
transportsNode.set("portOfLoading", td.required("invoicePayableAt").deepCopy());
unLocation(transportsNode.putObject("portOfDischarge"), "DEBRV");
transportsNode
.put("vesselName", vessel.vesselName())
.put("carrierExportVoyageNumber", "402E");
}

private static void unLocation(ObjectNode locationNode, String unlocationCode) {
locationNode.put("locationType", "UNLO")
.put("UNLocationCode", unlocationCode);
}

private static void addCharge(JsonNode chargesArray) {
if (!chargesArray.isArray()) {
return;
Expand All @@ -199,7 +236,7 @@ private static void addCharge(JsonNode chargesArray) {
.put("currencyAmount", 1f)
.put("currencyCode", "EUR")
.put("paymentTermCode", "COL")
.put("calculationBasis", "For the concrete transport document")
.put("calculationBasis", "Per transport document")
.put("unitPrice", 1f)
.put("quantity", 1);
} else {
Expand All @@ -209,7 +246,7 @@ private static void addCharge(JsonNode chargesArray) {
.put("currencyAmount", 1f)
.put("currencyCode", "EUR")
.put("paymentTermCode", "PRE")
.put("calculationBasis", "For the entire amendment")
.put("calculationBasis", "Per amendment")
.put("unitPrice", 1f)
.put("quantity", 1);
}
Expand Down Expand Up @@ -412,7 +449,41 @@ private void preserveOrGenerateCarrierFields(JsonNode source, ObjectNode dest) {
}
}

private void fixupConsignmentItems(ObjectNode transportDocument) {
private void computeWeightForUTE(ObjectNode ute, String equipmentReference, JsonNode consignmentItems) {
double weightInKGM = 0;
double weightInLBR = 0;

for (var consignmentItemNode : consignmentItems) {
for (var cargoItemNode : consignmentItemNode.path("cargoItems")) {
if (!cargoItemNode.path("equipmentReference").asText("").equals(equipmentReference)) {
continue;
}
var weight = Math.max(cargoItemNode.path("weight").asDouble(0.0), 0.0);
var weightUnit = cargoItemNode.path("weightUnit").asText("KGM");
if (weightUnit.equals("LBR")) {
weightInLBR += weight;
} else {
weightInKGM += weight;
}
}
}
if (weightInLBR > 0 && weightInKGM > 0) {
// Convert to KGM for simplicity. A real carrier had probably called a pending update requesting the
// shipper to use only one weight unit.
weightInKGM += weightInLBR * 0.45359237;
weightInLBR = -1;
}

if (weightInLBR > 0) {
ute.put("cargoGrossWeight", weightInLBR)
.put("cargoGrossWeightUnit", "LBR");
} else {
ute.put("cargoGrossWeight", weightInKGM)
.put("cargoGrossWeightUnit", "KGM");
}
}

private void fixupConsignmentItems(ObjectNode transportDocument, ScenarioType scenarioType) {
for (var consignmentItemNode : transportDocument.path("consignmentItems")) {
for (var cargoItemNode : consignmentItemNode.path("cargoItems")) {
var outerPackagingNode = cargoItemNode.path("outerPackaging");
Expand All @@ -426,27 +497,48 @@ private void fixupConsignmentItems(ObjectNode transportDocument) {
//
// The alternative is having a look-up table of all known packageCode's and their relevant
// description.
outerPackaging.put("packageCode", "1A")
.put("description", "Drum, Steel");

switch (scenarioType) {
case REGULAR ->
outerPackaging.put("packageCode", "4G")
.put("description", "Fibreboard boxes");
case REEFER ->
outerPackaging.put("packageCode", "BQ")
.put("description", "Bottles");
case DG -> {
outerPackaging.put("description", "Jerrican, steel")
.put("imoPackagingCode", "3A1");
var dg = outerPackaging.putArray("dangerousGoods").addObject();
dg.put("unNumber", "3082")
.put("properShippingName", "Environmentally hazardous substance, liquid, N.O.S")
.put("imoClass", "9")
.put("packingGroup", 3)
.put("EMSNumber", "F-A S-F")
;
}
default -> throw new AssertionError("Missing case for " + scenarioType.name());
}
}
}
}

private void fixupUtilizedTransportEquipments(ObjectNode transportDocument, ScenarioType scenarioType) {
// These code must be aligned with the equipment references.
var containerISOEquipmentCode = switch (scenarioType) {
case REEFER -> "22RB";
case REEFER -> "45R1";
case REGULAR -> "22G1";
case DG -> "22GP";
};
var consignmentItemsNode = transportDocument.path("consignmentItems");
for (JsonNode node : transportDocument.path("utilizedTransportEquipments")) {
if (!node.isObject()) {
continue;
}
ObjectNode ute = (ObjectNode)node;
var ref = ute.path("equipmentReference");
var ref = ute.path("equipmentReference").asText("");
computeWeightForUTE(ute, ref, consignmentItemsNode);
ute.putObject("equipment")
.put("ISOEquipmentCode", containerISOEquipmentCode)
.set("equipmentReference", ref);
.put("equipmentReference", ref);
ute.remove("equipmentReference");
if (scenarioType == ScenarioType.REEFER) {
ute.put("isNonOperatingReefer", false)
Expand All @@ -464,7 +556,7 @@ private void generateDraftTD(ScenarioType scenarioType) {
copyFieldsWherePresent(siData, td, COPY_SI_INTO_TD_FIELDS);
preserveOrGenerateCarrierFields(existingTd, td);
fixupUtilizedTransportEquipments(td, scenarioType);
fixupConsignmentItems(td);
fixupConsignmentItems(td, scenarioType);
state.set(TD_DATA_FIELD, td);
}

Expand Down Expand Up @@ -615,4 +707,9 @@ or out of the use or inability to use the provided JSON data (including but not
possibility of such damages.
""";
}

private record VesselDetails(
String vesselIMONumber,
String vesselName
) {}
}
21 changes: 15 additions & 6 deletions ebl/src/main/java/org/dcsa/conformance/standards/ebl/party/EblCarrier.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,19 +95,28 @@ private void supplyScenarioParameters(JsonNode actionPrompt) {
"Some Commodity Subreference 123",
// A "22G1" container - keep aligned with the fixupUtilizedTransportEquipments()
"NARU3472484",
"DKCPH",
"851712",
"300 boxes of blue shoes size 47"
"DKAAR",
"640510",
"Shoes - black, 400 boxes"
);
case REEFER -> new CarrierScenarioParameters(
"CBR_123_REEFER",
"Some reefer Commodity Subreference 123",
// A "22RB" container - keep aligned with the fixupUtilizedTransportEquipments()
"BBCU5200220",
"DKCPH",
// A "45R1" container - keep aligned with the fixupUtilizedTransportEquipments()
"KKFU6671914",
"DKAAR",
"04052090",
"Dairy products"
);
case DG -> new CarrierScenarioParameters(
"RTM1234567",
"Some DG Commodity Subreference 123",
// A "22GP" container - keep aligned with the fixupUtilizedTransportEquipments()
"HLXU1234567",
"DKAAR",
"293499",
"Environmentally hazardous substance, liquid, N.O.S (Propiconazole)"
);
};
asyncOrchestratorPostPartyInput(
OBJECT_MAPPER
Expand Down
6 changes: 3 additions & 3 deletions ebl/src/main/resources/standards/ebl/messages/ebl-api-v30-request.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"consignmentItems": [
{
"carrierBookingReference": "CARRIER_BOOKING_REFERENCE_PLACEHOLDER",
"weight": 320.12,
"weight": 12000,
"weightUnit": "KGM",
"descriptionOfGoods": "DESCRIPTION_OF_GOODS_PLACEHOLDER",
"HSCodes": [
Expand All @@ -28,10 +28,10 @@
"cargoItems": [
{
"equipmentReference": "EQUIPMENT_REFERENCE_PLACEHOLDER",
"weight": 320.12,
"weight": 12000,
"weightUnit": "KGM",
"outerPackaging": {
"numberOfPackages": 5
"numberOfPackages": 400
}
}
]
Expand Down
Loading

0 comments on commit 6c86516

Please sign in to comment.