As done in OTM5.3 I want to create an overview again of all the changes that are projected to make it in OTM5.4. Though there are quite a few improvements, most are very straightforward and do not need much discussion. The most important and extensive addition is the use of contextEvents on entities. This is added to accommodate the new EmissionEvent and FuelConsumptionEvents, so these events can be attached to the entities they belong to.
Add a TransportEquipmentConstraint: https://github.com/opentripmodel/otm5-change-requests/issues/46status accepted.
why currently it is impossible to create a constraint on what equipment is expect for a trip or consignment.
how add a new constraint that can refer to the possible equipment types.
example
Add averageFuelConsumption to vehicle: https://github.com/opentripmodel/otm5-change-requests/issues/48status accepted.
why the average fuel consumption is often used to calculate tarifs, as well as serve as input to project the emission and consumption on a certain route.
how add an optional field to vehicle.The required format is <liter> l/100km.
example
{
"entityType": "vehicle",
"licensePlate": "11-AA-22",
"fuel": "petrol",
"averageFuelConsumption": "9l/100km"
// other fields left out for brevity
}
Add consumption and fuel events, and allow them on entities.
a. Add emissionEvent and fuelConsumed events: https://github.com/opentripmodel/otm5-change-requests/issues/49status accepted.
why consuming fuel is an integral part of logistics, however it is not possible to communicate either planned/projected and realized consumed fuel. In similar fashion, calculating and tracking emissions is also not possible without adding these events.
how Create two new event types. One for consumption and one for emissions. Both will get a value-with-unit and description for additional information.
example
b. Add a optional field contextEvents to all entities.
status accepted
why These fields allow you to provide events that belong to an entity in a single message, which is otherwise impossible. The original request comes forth out of 5a, to be able to attach the emission and consumption events to the trips/consignments they belong to. However there are many other use cases, such as providing the traffic and location events of a vehicle to indicate how an ETA came to be, or possibly the driven (projected or realized) amount of KMs a vehicle made on a trip used for invoice information.
Add cancelled on action results and receiverAbsent as 'reason' type: https://github.com/opentripmodel/otm5-change-requests/issues/53status accepted.
why currently you can either succeed, fail or partly succeed an actio. However, quite often, an action is cancelled before it even starts. We cannot model this without changing the specification.
example
{
"actionType": "stop",
"entity": {
"associationType": "inline",
"result": {
"status": "cancelled",
"reason": "receiverAbsent"
},
// other fields left out for brevity
}
}
Add actors to events: https://github.com/opentripmodel/otm5-change-requests/issues/55status accepted.
why all entities can refer to actors that are involved, however events do not have that possibility. Parties using OTM events that serve multiple customs cannot indicate whom the event belongs to.
how add an optional actors field that can contain associated actors.
example
Add a description to the different constraint values: https://github.com/opentripmodel/otm5-change-requests/issues/56status accepted, no open discussion points.
why constraints can become quite complex and consist of multiple parts. To indicate what a sub-constraint is used for a description is necessary.
example
As done in OTM5.3 I want to create an overview again of all the changes that are projected to make it in OTM5.4. Though there are quite a few improvements, most are very straightforward and do not need much discussion. The most important and extensive addition is the use of
contextEvents
on entities. This is added to accommodate the newEmissionEvent
andFuelConsumptionEvent
s, so these events can be attached to the entities they belong to.Improve OTM5 documentation on actors and constraints: https://github.com/opentripmodel/otm5-change-requests/issues/34 status accepted. why the documentation is unclear on how to use them.
Improve documentation on actor roles: https://github.com/opentripmodel/otm5-change-requests/issues/38 status accepted. why the documentation is unclear on what roles are expected and how roles can occur.
Add a
TransportEquipmentConstraint
: https://github.com/opentripmodel/otm5-change-requests/issues/46 status accepted. why currently it is impossible to create a constraint on what equipment is expect for a trip or consignment. how add a new constraint that can refer to the possible equipment types. exampleAdd
averageFuelConsumption
to vehicle: https://github.com/opentripmodel/otm5-change-requests/issues/48 status accepted. why the average fuel consumption is often used to calculate tarifs, as well as serve as input to project the emission and consumption on a certain route. how add an optional field to vehicle.The required format is<liter> l/100km
. exampleAdd consumption and fuel events, and allow them on entities.
a. Add
emissionEvent
andfuelConsumed
events: https://github.com/opentripmodel/otm5-change-requests/issues/49 status accepted. why consuming fuel is an integral part of logistics, however it is not possible to communicate either planned/projected and realized consumed fuel. In similar fashion, calculating and tracking emissions is also not possible without adding these events. how Create two new event types. One for consumption and one for emissions. Both will get a value-with-unit and description for additional information. exampleb. Add a optional field
contextEvents
to all entities. status accepted why These fields allow you to provide events that belong to an entity in a single message, which is otherwise impossible. The original request comes forth out of 5a, to be able to attach the emission and consumption events to the trips/consignments they belong to. However there are many other use cases, such as providing the traffic and location events of a vehicle to indicate how an ETA came to be, or possibly the driven (projected or realized) amount of KMs a vehicle made on a trip used for invoice information.Add
sequenceNr
to all action types: https://github.com/opentripmodel/otm5-change-requests/issues/50 status accepted. whysequenceNr
is already a field onstop
, but not other type of actions. This is inconsistent. exampleAdd
cancelled
on action results andreceiverAbsent
as 'reason' type: https://github.com/opentripmodel/otm5-change-requests/issues/53 status accepted. why currently you can either succeed, fail or partly succeed an actio. However, quite often, an action is cancelled before it even starts. We cannot model this without changing the specification. exampleFix the documentation regarding entity types for
AssociationCreatedEvent
: https://github.com/opentripmodel/otm5-change-requests/issues/54 status accepted. why it is not as intended and inconsistent with the rest of the specification.Add actors to events: https://github.com/opentripmodel/otm5-change-requests/issues/55 status accepted. why all entities can refer to actors that are involved, however events do not have that possibility. Parties using OTM events that serve multiple customs cannot indicate whom the event belongs to. how add an optional actors field that can contain associated actors. example
Add a
description
to the different constraint values: https://github.com/opentripmodel/otm5-change-requests/issues/56 status accepted, no open discussion points. why constraints can become quite complex and consist of multiple parts. To indicate what a sub-constraint is used for a description is necessary. example