NAV
Release Notes 2024
V1.27.3 August 2024
- BD-773: Fix add a missing validation on vortex object maps.
- BD-775: Fix jobs going slightly above session's
MaxDailyJobsNumber
.
- BD-777: Add missing start/end times validation for /slots api.
V1.27.1 July 2024
- BD-771: Add support for updating job payload using original slot.
- BD-765: Add
AdditionalDoorstepTime
in driver and vehicle defaults to zero.
- BD-763: Add extend async patch jobs attributes.
V1.26.4 July 2024
- BD-762: fix OS-24-114287: Weak Access Control.
V1.26.3 July 2024
- BD-749: Add triggered vortex state logging on penalties spikes.
- BD-757: Enhance DB migration error handling logic.
V1.26.2 June 2024
- BD-744: Add special flag to control order picking logic.
- BD-740: Add vehicle attributes:
VehicleCheckDuration
and SetOffDelay
defaults to zeros.
- BD-750: Add support for
AvoidRoads
in the minimap.
- BD-751: Fix an edge case related to redundant slot booking reloading.
V1.25.12 May 2024
- BD-735: Speedup mini-map routing by up to 20%.
- BD-738: Fix an edge case where a snapping node is not in the map.
- BD-741: Fix to handle unexpected snap node with no node ID.
V1.25.10 April 2024
- BD-725: Fix related to mapping update locking mechanism.
- BD-730: Fix related to mini-map parsing.
V1.25.8 March 2024
- BD-698: Add more accurate way to estimate snap time/distance for a better match with ERS.
- BD-698: Fix issues related to caching.
- BD-717: Fix related to an edge case of limited slot offering on plans with penalties.
- BD-721: Fix auto mapping update mechanism to schedule only one POD at a time.
- BD-723: Add support for Vehicle's
CompromisedDays
.
V1.25.4 February 2024
- BD-713: Add enhanced get available slots performance for multi-sessions requests.
- BD-698: Add EOS multi-day map edits support.
- BD-697: Add upgrade HTTP services framework to v5 [latest].
- BD-684: Add new stat to report no slots events count.
- BD-455: Add more documentation.
V1.25.2 January 2024
- BD-694: Enhance Redis streams consume strategy for better handling of spikes.
- BD-682: Migrate to a Redis cluster stage 2 (cluster read).
- BD-695: Add trim for AtoBs Redis cache.
- BD-694: Add redis streams for enhanced slot offering performance.
- BD-679: Add enhanced map edits performance with more caching.
- BD-692: Fix EOS phantom slots offering on wrapping slot locking.
- General performance improvement.
Release Notes 2023
V1.24.7 November 2023
- BD-679: Enhance map edits performance stage 1.
- BD-682: Migrate to a Redis cluster stage 1 (dual write).
- BD-674: Fix weak access control; add create session optional ContextID validation.
- BD-675: Fix weak access control; add async request IDs validation.
V1.24.5 October 2023
- BD-676: Add a configurable state sync process.
- BD-677: Allow EOS to use more than one core.
- BD-673: Deprecate the hourly states check for active sessions.
V1.24.1 September 2023
- BD-664: Set redis connection pool size to current default value.
- BD-668: Add support for linked shifts slot booking.
- BD-670: Enhance slot booking estimations when reload is required.
- General performance improvement.
- BD-666: Fix to handle unexpected invalid cached session/date state.
- BD-662: Add
MaximumDaysPlanningInTheFuture
at the session level and MaximumJobTransferDaysInTheFuture
at the context level.
V1.23.5 July 2023
- BD-661: Add more optimisation delay stats.
- BD-660: Fix a map snapping edge case.
- BD-659: Add config for more control over slot booking map.
- BD-644: Add enhanced map edits support in slot booking mode.
- BD-652: Add invalidate matrices cache after 24h of map building.
- BD-651: Fix a slot booking race condition edge case.
V1.23.1 June 2023
- BD-645: Enhance
/api_v1/slots/available
performance.
V1.23.0 May 2023
- BD-643: Add
SlotBookingCautionLevel
to session parameters, defaults to null
.
- BD-516: Add gzip compression support to Webhook API.
- BD-641: Add
PATCH
operations support for resources: Depots,Vehicles,Drivers,VehicleProfiles
.
V1.21.9 April 2023
- BD-624: Enhance slots availability in certain geographies.
V1.21.8 March 2023
- BD-636: Fix for an extremely rare delayed optimisation scenario.
- BD-633: Add support for stats aggregation.
- BD-635: Potential fix for delete resources misleading HTTP code.
- BD-624: Enhance slots availability in certain geographies.
V1.21.2 February 2023
- BD-627: Add support for an edge case when a slot end at midnight.
- BD-628: Add support for optional time window in job update API
PUT /resource
.
V1.21.0 January 2023
- BD-625: Add session not found custom error
E102
.
- BD-624: Enhance slots availability in certain geographies.
- BD-579: Add redesign cleanup process.
- BD-616: Fix stop reading slot jobs from legacy table.
- BD-618: Fix an edge case with missing wrapper slot when a nested slot is offered.
- BD-623: Enhance slots availability in certain geographies.
- General performance improvement.
Release Notes 2022
V1.20.6 December 2022
- BD-610: Add self healing and stats to monitor stale plans.
- BD-612, BD-615: Fix async PATCH updates not triggering re-optimisation.
- BD-603: Fix EOS to recover from an unexpected Vortex request state.
- BD-604: Add support for Redis cluster.
V1.20.2.3 November 2022
- BD-605: Fix stat for GET async/status api.
- BD-606: Add config change to manage default behaviour.
- BD-607: Fix job force transfer after async PATCH updates.
- BD-608: Fix job
LoadTime
attribute overrule legacy value.
V1.20.2 October 2022
- BD-564: Fix low availability slots issue in certain geographies.
- BD-599: Add a config to control startup states loading.
- BD-603: Fix EOS to recover from an unexpected Vortex request state.
- General performance improvement.
V1.19.18 September 2022
- BD-577: Add quantities and capacities stats.
- BD-586: Adjust how optimisation capacity is allocated.
- BD-589: Add overtime contribution reduction to improve slot availability.
- BD-590: Fix an edge case related to offering last slot.
- BD-553: Add stop offering slots before job
CutOffDateTime
.
- BD-587: Add move jobs writes to a new table.
- Add more stats.
- BD-584: Add reduce overtime on weight updates.
- BD-585: Add config to control merge problems as a percentage.
- BD-583: Add
OrderNo
to simulator for testing purposes.
- BD-580: Add configurable limits to resources batch API calls.
- BD-582: Add allow external updates during finalise duration.
- BD-581: Enhance slot availability in relation to 1hr slots not offered.
- General performance improvement.
- BD-572: Fix
LoadTime
in job object is not updating.
- General performance improvement.
v1.19.9 August 2022
- BD-568: Order transfer affected by optional additional output reducing slot availability.
- BD-571: Add more stats.
- General performance improvement.
- BD-564: Fix low availability slots issue in certain geographies.
- BD-553: Add support for
CutOffDateTime
in job object.
- BD-565: Reduce risk factor for longer journeys.
- General performance improvement.
v1.19.3 July 2022
- BD-556: Fix kafka reconnecting issue after blackout.
- BD-555: Fix resource delete not trigger re-planning.
- BD-549: Fix get resources ignoring jobs on end date.
- BD-523: Add implement PATCH for job updates.
- General performance improvement.
- BD-561: Add ignore state calculation for future days after MaximumDaysPlanningInTheFuture.
- BD-560: Fix to handle invalid Vortex wait state requests.
- BD-563: Add skip expired state calculation requests.
v1.18.8 June 2022
- BD-544: Add disable on disk caching config.
- BD-541: Add webhook support for internal services.
- BD-533: Fix background clean up too aggressive.
- BD-540: Fix
AvoidRoad
validation in VehicleProfile
.
v1.18.3 May 2022
- BD-526: Add kafka queue for better performance.
- BD-528: Add config for functionality control.
- BD-529: Add reduce overtime / late with high capacity slots.
- General performance improvement.
- BD-524: Fix websocket not sending updates.
- BD-510: Add
First
for BestConstraint
in POST /slots/available
.
- BD-513: Add multiple session support for both get available slots and book slot.
- BD-512: Add async internal slot request for faster get available slots on multiple days.
- General performance improvement.
v1.17.9 April 2022
- BD-507: Add more plan stats.
- BD-499: Add support for webhooks on plan updates.
- BD-482: Add check to ensure jobs are unique across all context sessions.
- BD-503: Add allow partial updates on resources.
- BD-500: Add optimise DB queries.
- BD-498: Add seeding from merged plans for better stability.
- BD-496: Fix EOS add more caching.
- BD-494: Fix EOS transfers generating lates and overtime.
- General performance improvement.
V1.17.0 March 2022
- BD-486: Add enhanced job transfer.
V1.16.5 March 2022
- BD-483: Fix StartDate field is missing from output plan.
- BD-481: Fix incorrectly returning 200s and jobs in the wrong slot.
- BD-475: Add memory cache enhancement.
- BD-478: Fix available driver time calculation on an edge case.
- BD-462: Fix 500 errors on resources delete/update.
- BD-474: Fix an edge case preventing EOS for picking up a change.
- BD-465: Add transfer jobs to best depot immediately after booking.
- BD-461: Encourage jobs to be transferred from a session with penalties.
- BD-461: Disable rapid planning.
V1.16.1 January 2022
- BD-447: Fix related to invalid http error code when delete didn't find the object.
- BD-448: Fix related to job transfer for a more balanced plans.
- BD-446: Fix related to re-adding slots is not triggering internal state re-calculation.
- BD-404: Add
LockStatus
support at the vehicle level.
- BD-419: Add support for new Vortex feature
RapidPlan
.
- BD-445: Fix wrong slot capacities when driver shift is shorter than slot.
Release Notes 2021
V1.14.3 December 2021
- BD-424: Fix related to
MaxDailyJobsNumber
is ignored on custom plan dates.
- General performance improvement.
- BD-391: Enhance slot response sensitivity to resource changes. Final release.
- BD-421: Fix websocket memory leak related to large scale websocket usage.
V1.14.1 November 2021
- BD-415: Fix related to EOS state doesn't update after upgrade on a special scenario.
- BD-413: Fix related to race condition on job update.
- BD-359: Add
ContextID
in http header for POST session API.
- BD-396: Add optional
ContextID
parameter to Get Resources API and add SessionID
to resources objects result.
- BD-396: Add
ContextID
to PUT
, DELETE
resources API and Add Context wide unique IDs checks before POST
- BD-396: Update the assigned stores on a job using depot characteristics.
- BD-378: Account for action
TRAVEL_PART
in EOS for some edge cases.
V1.13.0 October 2021
- BD-391: Enhance slot response sensitivity to resource changes. Initial release.
- BD-400: Add support for map edits.
- General performance improvement.
- BD-365: Add support for multi-day plan in dynamic scheduling mode only.
- BD-392: Add
JobTransferSlotUtilisationThreshold
to the context parameters. Default: 0.5
.
V1.11.3 September 2021
- BD-385: Fix slot issue with speed factors and distance stratified speed vector.
- Fix BD-384, related to ensuring backward compatibility on internal EOS state.
- Fix BD-383, related to
CapacityIndex
validation when capacities are missing.
- BD-369: Add (total & available) driver time, as well as (total & available) vehicle delivery capacity to "/slots" and "/slots/available" responses. An optional "BestConstraint" argument in "/slots/available" determines how to calculate the most suitable vehicle; values can be "Time", "Distance", or "DeliveryCapacity. The default is "Time" which was the pre-existing behaviour. Note: Ignoring these new parameters / attributes retains the original behaviour. This provides more detailed information regarding slot availability.
- BD-371: Add "error" attribute into HTTP 404 "/slots/book" responses. For example {"code": 404, "message": "slot is not available ", "error": "E100"}. EOS now responds with HTTP 404 when "MaxDailyJobsNumber" is reached, rather than HTTP 400 which is more suitable for client errors.
- Fix BD-380 related to missing extra checks when shifts are empty.
V1.10.3 August 2021
- Fix BD-368 related to reporting false 404 errors.
- Fix BD-367 related to respecting
MaxDailyJobsNumber
constraint in get free slots.
- BD-359: Add support for session and context IDs in HTTP headers.
V1.9.0 July 2021
- BD-351: Add WebSocket support.
- BD-340: Fix related to error reporting.
V1.8.0 June 2021
- BD-335: Add customized session parameters on a specific date.
- BD-336: Add get resources by their IDs.
- Fix BD-337.
- Fix BD-338.
- Fix BD-340.
V1.7.0 April 2021
- BD-313: Add vehicle capacity check support.
- BD-318: Add update/delete flexi-jobs using their original session IDs
- Add
UpdatedSinceSeed
attribute at job level for pending Vortex updates.
- Performance enhancements.
- Fix an issue related to update slot booking, occurs when jobID is not unique in the context.
- Fix finalise when duration is small.
V1.6.0 March 2021
- BD-299: Add
DeleteExpiredSecond
to session parameters to cleanup expired objects.
V1.5.0 February 2021
- BD-293: Add
getall
argument to get unavailable slots to the GET Slots Available API /api_v1/slots/available?getall=true
json
// Example response
[
{
"DistanceToJobMetre": 4530,
"EndTime": "2019-12-24T12:00",
"StartTime": "2019-12-24T10:00",
"Status": "Open",
"TimeToJobSecond": 300,
"Utilisation": 0.8
},
{
"EndTime": "2019-12-24T12:00",
"StartTime": "2019-12-24T10:00",
"Status": "notAvailable",
"Utilisation": 1
}
]
- BD-297: EOS can limit the max total jobs bookable or transferable, except for when force mode used. If an attempt is made to add a job when this limit is reached, the job will be rejected.
"Session":{"MaxDailyJobsNumber": null }
Default: Null = no limit. If the session has more than one depot this limit applies to all depots in that session. This limit only applies to a single day.
- Add
TransferJobsBetweenSessions
attribute to the context parameters, defaults to true
. While the jobs' IncludeDepotCharacteristics
includes the depots StringId
from different sessions then transferring jobs between sessions can occur. To avoid ambiguity ensure the depot's StringId
is unique within the context.
- BD-281, Add finalise end-point
/api_v1/plan/finalise
to inform EOS to prepare a finished plan. Session transfers are suspended. Typically, no more changes/additions should be made by the user.
- Add more validation for
/api_v1/resources
end-points.
- Fix the
content-type
response header for end-point /api_v1/slots/available
.
V1.4.1 January 2021
- Add Validation to individual slots when adding and deleting.
- Enhance optimisation response time under load.
- BD-268, add PUT method to
/api_v1/slots/book
to allow changes to both job and slot objects.
- BD-289, fix re-calculating slots' state (fix utilisation 100% after deleting jobs).
- Add support for Vortex sparse matrices and cycle optimisation for better performance.
- GetAvailableSlots returns calculating slots when there are no alternatives.
- Fix an issue which was preventing sessions cleanup.
- Fix an issue related to offering less slots in some edge cases.
Release Notes 2020
V1.3.0 November 2020
- Add job transfer scheduler between sessions in the same context.
- Enhance performance on large problems, and add better caching technique.
- Add
Force
boolean parameter to BookSlot API.
- Increase Maximum plan days in future to 30.
V1.2.0 October 2020
- Populate PriorRequestID to enable matrices caching in Vortex
- Enhanced slot booking strategy, Add more tests, and support original job creation time for test simulator.
- Change Service name to EOS.
- Introduce Context for larger organisations with multiple sessions.
- Enable matrices caching by default.
V1.1.0 July 2020
- Add swagger docs
- Add Availability && Availability exceptions to Depot, Driver, and Vehicle objects
- Cleanup in-progress Vortex request when session is deleted
- Fix an issue with SlotAvailable Distance and Time to job
- Add Extra Time and Distance needed to do a job to available slot object
V1.0.0 March 2020
- Consolidated releases.
- Renamed to Elastic Optimisation Service (EOS).
Release Notes 2019
V0.1.0 September 2019
- Initial deployment of VortexOnline replacing RM slot booking system.