OTM 5.6 release candidates

Introduction

Like in previous releases here is an overview of everything that is planned for OTM5.6

Overview

These are the candiates for inclusion:

Candidates with no open discussion:

Candidates with some open concerns:

Add new location types.

Candidates without any open discussion:

Ticket: Add transportEquipment to load & unload actions. Reason: You can indicate that the goods of a consignment are loaded and unloaded in some vehicle, but you cannot indicate in which trailer the goods are loaded. Adding a transportEquipment makes this possible. Example:

{
  "id": "2a806c26-640c-4562-85d5-8ea4b9e7d80f",
  "actionType": "load",
  "lifecycle": "planned",
  "consignment": {
    "entity": {
      "id": "04a9870f-52c0-463a-80c1-7d1d81c8b38a",
      "goods": [
        {
          "entity": {
            "id": "1c3ea9b8-7de5-48ce-92fe-08a90ccdb86a",
            "description": "Ordered box of Bananas",
            "quantity": 2,
            "type": "items"
          },
          "associationType": "inline"
        }
      ]
    },
    "associationType": "inline"
  },
  "transportEquipment": {
    "entity": {
      "id": "182ce149-8912-4e92-a7ae-713a0e9f9c98",
      "description": "this is an attached trailer",
      "licensePlate": "AA-11-BB",
      "equipmentType": "trailer"
    },
    "associationType": "inline"
  }
}

Ticket: Indicate the degree of constraint enforce-ability Reason: You cannot indicate whether a constraint is mandatory or a suggestion. A new field can solve this easily. Example:
```
{
  "id": "89a7bb4d-8720-4db9-aef7-4c3309186c3e",
  "name": "Example hard constraint",
  "creationDate": "2023-03-28",
  "value": { ... },
  "enforceability": "enforced",
}
```

Ticket: Support recurring date times & durations Reason: Constraints can only have a single date time interval. However for many situations a constraint is recurring (e.g. the ability to visit a location). Example

// default behavior 
{
"id": "8f39dbbc-e77f-4707-af9f-6db8467caffd",
"location": { },
"startTime": "2021-08-11T10:00:00Z",
"endTime": "2021-08-11T13:00:00Z",
"timeFormat": "dateTime", // <-- if not provided this is inferred to be datetime
"actionType": "unload"
}

// New, only duration
{
"id": "8f39dbbc-e77f-4707-af9f-6db8467caffd",
"location": { },
"duration": "P23DT23H", // <-- ISO 8601 specification for durations
"timeFormat": "duration",
"actionType": "unload"
}

// New: recurring date time
{
"id": "8f39dbbc-e77f-4707-af9f-6db8467caffd",
"location": { },
"startTime": "2021-08-11T10:00:00Z",
"endTime": "2021-08-11T13:00:00Z",
"recurrence": "RRULE:FREQ=WEEKLY;COUNT=5;BYDAY=TU,FR", // <-- recurring specification
"timeFormat": "recurringDateTime", // <-- if not provided this is inferred to be datetime
"actionType": "unload"
}

Ticket: Support sub-locations of a location Reason: Larger locations often have multiple 'points of interest' on them. For example docks or electric charging stations on a large distribution center. You can create new locations for these 'points of interest', but you cannot link them to the parent location. Example

{
"id": "d90b4a73-0e45-46d1-ae86-f8142e031848",
"name": "parent location",
"geoReference": {
    "lat": 52.1938878,
    "lon": 5.4043508,
    "type": "latLonPointGeoReference"
},
"administrativeReference": {
    "street": "Valutaboulevard",
    "houseNumber": "16",
    "houseNumberAddition": "C",
    "postalCode": "3825 BT",
    "city": "Amersfoort",
    "country": "NLD"
},
"subLocations": [
    {
        "associationType": "inline",
        "entity": {
            "id": "3f39c1f6-2653-4f6a-a6bf-57c3fe8fa054",
            "name": "dock on parent location",
            "geoReference": {
                "lat": 52,
                "lon": 5,
                "type": "latLonPointGeoReference"
            }
        }
    },
    {
        "associationType": "inline",
        "entity": {
            "id": "b61acb70-64ef-40d1-8251-709d080b8153",
            "name": "postal address",
            "administrativeReference": {
                "street": "Some other value",
                "houseNumber": "16"
            }
        }
    }
]
}

Ticket: Support "owner" as an actor role. Reason: Currently it is not possible to indicate that the actor is the owner of a certain entity, such as the vehicle or the location. The current roles are not adequate since this actor can also be a shipper/carrier/consignor/consignee in different situations. Example
```
{
"entity": {
    "id": "8a082d90-99e5-472d-93f0-f9724fc1265b",
    "name": "SUTC"
},
"roles": [ "owner" ],
"associationType": "inline"
}
```

Ticket: Support proper route constraints. Reason: The current route constraint is not a proper route constraint, since it contains a geoReference instead of a route. We cannot change the current constraint as that would break backwards compatibility. We can however introduce a new constraint and deprecate the old one. Example

{
"entityType": "constraint",
"value": {
    "type": "routeEntityConstraint",
    "route": {
        "associationType": "inline",
        "entity": {
            "id": "<uuid>",
            "creationDate": "2023-08-15T10:00Z",
            "geoReference": {
                "points": [
                    { "lat": 3, "lon": 4},
                    { "lat": 4, "lon": 4},
                    { "lat": 5, "lon": 6}
                ],
                "type": "latLonArrayGeoReference"
            }
        }
    }
}
}

Candidates that have some open questions:

Ticket: Add new location types Reason: Currently there are types of locations that are common but not supported, such as terminal and fuelStation. Open discussion: which types do we need to add and do we want an escape hatch? Since we likely want a more elaborate list the plan is to postpone this until the next release.

opentripmodel / otm5-change-requests