V2 Release Notes 2024

V2.33.3 August 2024

• BD-766: estimate time and distance properly for zero-distance cases.

V2.33.2 August 2024

• BD-783: fixed early picking period issue.
• BD-756: Fix shift-locking being ignored for locked shifts with no jobs.
• BD-791: Add recalculate cached unreachable A to Bs.

V2.33.0 July 2024

• BD-764: Add AdditionalDoorstepTime in Driver and Vehicle, defaults to zero.
• Fix overload penalties reporting in NEWFASTMODE.
• BD-330: General maintainability improvement.

V2.32.7 July 2024

• BD-739: Add picking period logic.
• BD-739: Add support for overlapping slots exception (rule2).

V2.32.5 May 2024

• BD-742: Add fastmode_threeopt operator which might be useful.
• BD-739: Fix to allow PickingPeriod:null.
• BD-739: Add picked attribute and some associated space saving.
• BD-742: Add a switch for NEWFASTMODE "NewFastmode":true.

V2.32.3 April 2024

• BD-724: fix edge case for compromised shifts.
• BD-680: Add Compromised attribute defaults to false at Vehicle level.
• BD-680: Add basic input of depot level penalty factors.
• BD-680: Fix a problem with default for RechargeRangeKm.
• BD-728: fix issue with merge involving store with one shift.
• BD-330: Improved memory usage (internal) change MAXCOMPARTMENTS to 7.

V2 Release Notes 2023

V2.31.1 October 2023

• BD-669: Add changed LoadPriority functionality.

V2.31.0 September 2023

• BD-657: Add link shifts to co-ordinate timing and range for shifts of same physical vehicle.
• BD-329, BD-330: General maintainability improvement.

V2.30.8 August 2023

• BD-648: Fix remove some debug logs.

V2.30.6 June 2023

• BD-642: Fix a problem with ReformatBrokenTravel (stage1).
• BD-647: Prep for ERS.

V2.30.3 April 2023

• BD-639: Add message compression to enhance performance.
• BD-640: Add ERS routing support.
• BD-330: General maintainability improvement.

V2.30.2 February 2023

• BD-632: Add reconnect to redis more quickly after failing.
• BD-633: Add support for stats aggregation.

V2.30.0 January 2023

• BD-617: Add UnpenalizedOvertime default to 0s to control amount of allowed overtime.
• BD-603: Add redis retry connect for a period of time before failing.
• BD-619: Add AddJobRate:1 to place more (or less) emphasis on trying to stuff in additional jobs vs re-arranging existing jobs.
• BD-330: General maintainability improvement.

V2 Release Notes 2022

V2.29.0 November 2022

• BD-592: Add BlockLoadPriorityReduction default to false to keep jobs locked on the highest priority vehicle.
• BD-601: Add enhance InferMatrixEntriesFromSeed to pick up the appropriate matrix entries from the seed, even if the latlons are slightly different.

V2.28.5 October 2022

• BD-597: Add change to produce output when OutputEmptyShifts is true even if no jobs.

V2.28.4 July 2022

• BD-552: Fix AdditionalServiceActionOutput and OutputEmptyShifts for additional Json in the plan.
• BD-562: Fix missing A to Bs edge case after using the cache.
• BD-330: General maintainability improvement.

V2.28.1 June 2022

• BD-543: Fix Vortex returning empty state edge case.
• BD-535: Add OutputEmptyShifts default false to output empty shifts into the plan.
• BD-535: Add AdditionalDriverOutput, AdditionalServiceActionOutput, and AdditionalVehicleOutput default to [] for additional Json in the plan.
• BD-539: Add limit TotalRunTime cautiously for small inputs in fastmode.

V2.27.4 May 2022

• BD-505: Add enhancements to InferMatrixEntriesFromSeed feature.
• BD-511: Add vehicle level MaximumExcessPercentQ1 and MaximumExcessPercentQ2 with default 0.
• BD-521: Add avoid inadvertent use of shift locking in standard mode.
• BD-329: Add slight efficiency improvements in fastmode.
• BD-330: General maintainability improvement.

V2.27.3 April 2022

• BD-506: Add MaximumExcessPercentQ1 & MaximumExcessPercentQ2 at vehicle level and at depot level.
• BD-505: Add InferMatrixEntriesFromSeed default: false to infer matrix entries from seed solution.
• BD-504: Add LatestFirstOutputTime.
• BD-497: Add ImmediateSeedOutput default: false.
• BD-501: Fix Vortex handling of locking for all vehicles.
• BD-488: fix possible issue with trading overweight for overtime in fastmode.
• BD-330: General maintainability improvement.

v2.27.1 March 2022

• BD-485: Add MaxDailyJobsNumber at the depot level.
• BD-444: Add pass DepartureTime to routing services.
• BD-439: Add OutputExtraLockingInfo for debug purposes.
• BD-449: Fix for an overload issue in RapidPlanning mode.
• BD-466: Fix Vortex planning overtime when PlanAllJobs is false.
• BD-329: Performance improvements in fastmode to compensate for slight hit from locking code.
• BD-330: General maintainability improvement.
• BD-331: Documentation improvements.

v2.26.2 February 2022

• BD-459: Fix Vortex issue regarding allowing excess weight in fastmode.

v2.26.1 February 2022

• BD-457: Fix Vortex crash on edge case.

V2.26.0 January 2022

• BD-439: Add Vortex lock run functionality.
• BD-419: Add new feature RapidPlan to provide quick first solution.
• BD-440: Fix edge case where ActivatePriorityObjective is set but all Priority settings are null.
• BD-434: Fix the processing of SequenceOrder and SequenceGroupId.
• BD-441: Fix a routing validation issue.
• BD-330: General maintainability improvement.

V2 Release Notes 2021

V2.25.0 December 2021

• BD-391, BD-419, BD-394: Add support for EOS fast updates.
• BD-417: Fix an edge case with sparse locations.
• BD-329: General performance improvement.

V2.24.0 November 2021

• BD-378: Break times in fastmode violating rules in low volume cases.
• BD-405: Add Boolean attribute OutputPayloadQuantities default: false to show Vehicle Payload & Weight Info.
• BD-406: Fix VehicleDriverMap conflict following update.
• BD-333: Add a LoadPriority attribute into the vehicle object.
• BD-329: General performance improvement.
• BD-402: Add websocket command: Attach to get updates on an already running problem.
• BD-400: Add attribute MapLayerIDs into VehicleProfile to target one or more map layers in Geomap for mapedits.

V2.23.1 October 2021

• BD-347: Add Geomap routing service support.

V2.23.0 September 2021

• BD-379: Add debrief time to shift time by default in fastmode; WorkingTimeIncludesDebriefing:true.

V2.22.0 September 2021

• BD-330: General maintainability improvement.
• BD-372: Fix related to incorrectly planning multiple vehicles on same site.
• BD-373: Fix edge case related to fixed visit time.
• BD-223: Ensure correct treatment of a vehicle's maximum working time.
• BD-376: Fix an issue with slot start times in fastmode edge cases.
• BD-377: Add Boolean key ApplyMinimumTravelBetweenSameLocations default: false.

V2.21.2 August 2021

• BD-286: Add ContinuousWorkLimit default: 1440m and ContinuousWorkBreak default: 30m for drivers in single-driver scenarios.
• BD-322: Add SequenceOrder, and SequenceGroupId to enable users to specify the sequencing of jobs in the same vehicle.
• BD-329: Add Stochastic boolean attribute - default true (for research purposes).
• BD-329: Add AllowArchiveDuplicates boolean attribute - default false (for research purposes).
• Add OutputMultipleServiceDetails default: false to show full plan details of multiple services (collections/deliveries) at the same location.
• Add WaitsCountAsBreaks default: true to enable user control over the default.
• Add ReformatBrokenTravel default: false to show long travel actions in chronological form (e.g. Travel_part/Break/Travel_part/etc...) rather than list breaks at the end.
• Add OutputEndDay default: false to clarify timing by showing the end day in all output actions where the start-time and end-time straddle midnight.
• BD-315: Translate AdditionalTags using new Vortex features to control job sequence.
• BD-329: General performance improvement.
• Address various edge cases.
• BD-364: Fix sequence edge case.
• BD-331: Documentation improvements.
• BD-35: Fix.
• BD-46: Fix.

V2.20.0 April 2021

• Add UpdatedSinceSeed Boolean attribute to Job object for EOS.
• Add avoid road support, mainly TOLL_ROAD and BOAT_FERRY.
• BD-304: fix ProgressPercentageEstimate to ensure <= 100.

V2.19.2 March 2021

• Fix an issue arising from VehicleDriverMap edge cases.
• Fix BD-300, if seed contains an invalid driver, ignore that shift.

V2.19.1 February 2021

• Performance enhancements.
• Add additional precision to TravelTimeMinutes.
• Add Briefing and Debriefing actions.
• BD-292: removed processing of vehicle without driver.
• BD-295: fix.
• Fix a rare issue related to terminate.

V2.18.0 January 2021

• Algorithm performance enhancements.
• BD-279 - Add CycleRunTime attribute to run the problem as cycles
• Add State attribute to the response.
• Enhance Eos support.

V2 Release Notes 2020

V2.17.1 November 2020

• Fix an issue related to translation of AdditionalTag from V1 to V2.
• Add V1 to V2 pass through.

V2.17.0 November 2020

• Performance improvements.
• BD-252 initial shift wait counts as working time.
• BD-200 fix interaction of CWRT and CWIT.
• BD-264 add V1 to V2 Conversion.
• BD-266 fix edge case.

V2.16.0 October 2020

• Add attribute 'PriorRequestID' to simplify seeding and make use of matrices caching
• Add maximum runtime to 3 hours.
• Add 'SpeedFactor' to speed profiles BD-250.
• Add 'MaximumSpeedKPH' to vehicle profile object BD-250.
• Add code efficiency to speedup algorithm.
• Add boolean 'CacheMatrices' attribute to enable matrices caching, only useful when its combined with 'PriorRequestID'.

V2.15.0 September 2020

• Add AutoRestart Boolean key - if true, ContinueWithoutRefreshTime is set according to number of jobs.
• Add "PriorityPercentUnplanned" as an objective, activated by ActivatePriorityObjective: true.
• Add new PriorityMode: "Staged" - this means "Strict" until a target percentage of priority jobs are planned, or for a given amount of time; thereafter "Permissive".
• BD-224 enhanced job selection for excessive jobs backlog.
• BD-233 fix minor bug related to unloading collections outside depot window.
• BD-237 enhanced handling of collocated jobs.
• BD-215 correct infeasible times.

V2.14.1 August 2020

• Clean up analysis of input and reporting for jobs that can't be processed.
• Add support for no-depots problems.
• Further fix BD-206 to ensure driver shift time is correctly calculated in edge cases.
• Fix BD-212 related to timing of a group of customer collections with different windows.

V2.14.0 July 2020

• Add "PlanAllJobs" Boolean - for careful use.
• Add "OutputShiftDrivetime" with default false.
• Enable decomposition by default on >1000 job single-depot problems.
• Update documentation about "Vehicle" assignments.
• Update terminology and units used in statistics output.
• Fix a small issue in master scheduler stats, only show balance objective when it is populated.
• Fix to decomposition logic.
• Fix BD-199, an issue in reporting unplanned jobs.
• Fix BD-183 related to unnecessary sign bit set.
• Fix BD-192 related to travel breaks going beyond end of shift.
• Fix BD-201, an issue related to shift end time did not account for debriefing time.
• Fix BD-206 related to negative value of maximum shift time.
• Fix BD-209 related to more than expected reload actions.

V2.13.0 April 2020

• Added control of Output values via ShowBalance Boolean, whether or not Balance is active.
• Updated documentation.
• BD-177 fix for memory management and capturing null.
• Addition of optional CustomerIdString to Job objects, and including them in the output when provided.

V2.12.0 April 2020

• Add ActivateBalanceObjective to share the work across drivers so they have similar working time.
• Add BestBalance value for InterimOutputChoice and FinalOutputChoice.
• Add BalanceGrainTime for use with ActivateBalanceObjective to define algorithm granularity time of driver shifts.
• Add FinalOutputWeights allows specifying of a simple formula to identify which of the solutions is most desirable for final results.
• Add InterimOutputWeights allows specifying of a simple formula to identify which of the solutions is most desirable for interim results.
• Add ShowBalance, if set the Objectives object will include BalanceMinutes and BalanceSecond.

V2.11.0 March 2020

• Fix an issue related to travel time at end of shift and parameter tuning.
• Add InterimOutputChoice and FinalOutputChoice attributes; values "All" (default), "BestCost", "BestMileage".
• Add OutputInterval and StatisticsInterval attributes.
• Add job LoadTime validation.
• Add /validate end-point, to validate Vortex JSON request without executing the algorithm.
• Add /v1tov2 end-point, helper for migration of V1 to V2 (not for production purposes).
• Cleaning up processing of SpeedFactors.
• Seeding can now handle seeds with collection jobs and mixed collection/delivery jobs.
• Add TransportMode attribute in VehicleProfiles, possible values are: TRUCK, CAR (can only be used with HERE routing service).
• BD-168: Fix logic for choosing shifts when adding unscheduled jobs.
• Add ability to disable "Onboard" output via: "OutputOnboard": false.

V2.10.0 January 2020

• Introduced "BreaksMode" key with values "Default" or "Segmented" introduced "WorkingTimeIncludesBreaks" Boolean.
• Downgrade the priority of impossible jobs (TM43).
• Exit with error if a connected C and D both have the same location.
• Switched order of loading and unloading at sites, to avoid spurious overloads.
• Add SpeedProfile Optimiser for OSRM or HERE routing services.
• Fix a bug related to disable decompose on sub-requests.
• Hierarchical decomposition (i.e. decompose into one subproblem per depot, and then decompose the larger depots).
• Eliminated negetive ETA in stats.
• End gracefully with informative notes when there are no valid driver/vehicle pairs.
• Added "PlanProfile" key for multiday problems, with values None (default), Frontload, Backload, and Display (BD-139).
• Add support for rolling upgrades.

V2 Release Notes 2019

V2.9.2 November 2019

• Fixed an issue in validating timewindows.
• Added support for negative times and validate durations/times differently.
• Added shift start time, and no mixing rules automated testing checks.
• Added optional "ShiftDistanceKm" in output, turned on by "PARAMETER_OutputShiftDistance": true.
• Enabled the ability to ban mixing of same stocktype.
• Changed shift timing behaviour to ensure drivers do not work maxdrivinghours beyond their latest start time.
• Introduced fuller control over OptShunt operator, useful for sequence optimization when jobs are assigned to a vehicle.
• Job splitting now disallowed by default, enabled by "EnableJobSplit":true.
• Added Initial WAIT (immediately after earlier STARTSHIFT) when driver's shift has to start before vehicle is available.
• Added more internal documentation for Vortex. Version 1 of decomposition in place for multiple-depot cases.

V2.9.1 October 2019

• Fixed an issue where depots were sometimes being used on days they were unavailable.
• Fixed an error where uninitialised values were being used, in the matrix-checking code.
• Fixed a bug in a schedule-change operation which occurred when some jobs were involved in constraints.

V2.9.0 October 2019

• Add documentation of "PriorityMode" and "RoutingMode".
• Add functionality for "IncludeVehicleCharacteristics" and "ExcludeVehicleCharacteristics" in Depot objects.
• Add code to handle messages and job-priority implications for non-navigable locations.
• Add "LocationPrecisionMetre".
• Add "WalkToNearbyJobs", "MaximumWalkingRadiusMetres", "WalkingSpeedMetresPerSecond".

V2.8.1 October 2019

• Fixed a bug in the new priority functionality.
• Add "PriorityMode" key with default value "Strict"; an alternative value (e.g. "Permissive") leads to previous non-strict behaviour which may be better for problems where some of the high priority jobs turn out to be impossible to schedule.
• Changed functionality for job priority: higher priority jobs will now always be scheduled in favour of lower priority.

V2.8.0 September 2019

• Add state into "NOTE" response object "Waiting in the Queue" and "Running".
• Fix an issue with OSRM, on very rare situations negative distance is returned.
• Fix a V1 to v2 conversion issue related to Driver's breaks.
• Fix a v1 to v2 conversion issue related to DriverVehicleMap.
• Add "QuantitiesProcessed" to the "Objectives" object.
• Add optional "Company" keys to drivers and depots.
• Add "ShuntMove" operator for cases with many jobs per vehicle.
• Add accurate timing of short trips taking acceleration/deceleration into account.
• Add change "Priority" default to null (null is now the lowest priority).
• Add customer specific test cases.
• Updated License in documentation.
• Documented Vortex error codes.

V2.7.0 September 2019

• Fix updated logic for stock mixing and sequencing to cover some edge cases.
• Add customer specific test cases.
• Fix corrected a fault relating to Vehicle StartTime logic.
• Add boolean "PARAMETER_RepairMatrices" with default false; if true, Vortex will estimate drivedistances and drivetimes for cases where the matrix service could not find a route.
• Add intelligent treatment of first day start time, taking account of last shift end time.
• Add "CleanBetweenShifts" boolean at vehicle level and associated additional functionality for sequencing of stock types.
• Tuned ShuntSwap operator to improve (trevelling sales person) TSP like problem performance.
• Add "PARAMETER_OutputSeconds":false - if set to true, the timestamps in the schedule output will be at 1s precision.
• Add improved inversion operator which shall generally enhance performance across the board.
• Add refactored parsing code to prepare for problem breakdown.
• Add validation for "PlanDate" attribute.
• Add support for terminate on matrix calculation.
  
• Add better memory management.
• Fix Websocket compatibility issue with the Compression.
  
• Add support for compressed HTTP requests "Content-Encoding: gzip" and responses (zlip) "Accept-Encoding: gzip".
• Updated documentation.

V2.6.0 August 2019

• Performance improvements
• Added RangeKm for electric vehicles
• Fix bug involving long travel times
• Made OnBoard output optional ("PARAMETER_OutputOnboard":1)

V2.5.0 August 2019

• Fix bug with v2 algorithm schedules deliveries starting 1 minute before time windows open.
• Fix issue with v2 algorithm generates a shorter/faster route when truck restrictions are applied than without
• Fix issue with v2 crashing when provided a valid vehicle driver map which doesn’t match the availability of the drivers.
• Support terminate command for v1.
• Added v1 mid-way end-point (internal).
• Simplified internal queuing (internal).
• Add compressed bin file (internal).
• Improved time format validation and additional validation checks (internal).
• Merge v1 and v2 slate documentation (internal).
• Improved memory usage (internal).

V2.4.0 July 2019

• Corrected 'splitjobs' functionality to apply only to 1-compartment vehicles
• Improved handling of priorities
• Fixed an issue with depot days availability
• Fixed an issue in the interaction of mixing and sequence rules

V2.3.0 June 2019

• Add optional speed profiles
• More efficient distances and times matrix calclation
• New design for better load balancing
• BD-95 Consolidate Vortex traffic for slower polling process
• BD-93: Fix integration with HERE routing service
• Algorithm seeding is implemented
• Fix a glitch in compartment logic which was affecting the SuppressDepotReload=False
• Fix a glitch in mixing logic that occurred when one or more jobs had CanSplitOverCompartments set
• FirstDrop is documented

V2.2.0 May 2019

• Fix vehicle start location validation
• Fix issue that caused crash
• Stock costs can now be provided for different days in an array
• Implemented and documented Stock Sequence Rules
• Implemented and documented OrganizeAsLoads and its now integrated with runorder
  
• Stock Sequence Rules fully implemented and documented
• Add Road Category Distance Model
• Enhanced functionality for prioritising jobs
• BD-72: Enhance HERE map integration
• BD-74: Matrix calculation issue
• BD-67: Distance model over road categories

V2.1.1 April 2019

• Add lattitude, longitude in addition to geohash
• Routing services
• Road restrictions (additional charges apply)

V2.1.0 March 2019

• HGV Attributes (additional charges apply)
• Avoid Tolls (additional charges apply)
• Speed Profiles
• Multi Depot Stock Levels
• Supplier hours constraint
• Loading location
• Enhanced restrictions
• ProhibitedJobTypes
• DriverCharacteristics
• Allowed Seq
• Compartments
• Capacity Limits
• Stock Costs
• Relative stock levels
• Priority
• Tunnel Category (additional charges apply)
• PriorJobTypes
• Cancel Optimisation
• ScheduleId
• FirstDrop

V2 Release Notes 2018

V2.0.0 Sept 2018

• Initial experimental release