One stored stop order (a run) for a visit route. Optimize Route Sequence, Recompute Sequences and the optional background refresh each add new runs; existing runs are never edited, so earlier runs stay available for comparison. Within each family of route, Sequence Type and Salesperson, one run is current, and Activate makes a different run current. When a visit plan is generated, the current Optimized and Mostly Followed runs give each visit its Optimized and Mostly Followed positions; a run for the plan's salesperson is preferred over the route-wide one, and a route with no current run with entries has both orders computed at that moment. Planned and Custom runs are not produced by xMatix and are not read by the planner. Runs are listed on the route's Route Sequences tab and appear in no app menu. The run's own page offers only Activate, and New fails with "Name is required" because the form has no Name field, so runs cannot be built by hand from the standard screens.
Fields
| Field | Label | Type | Required | What it does |
|---|
Algorithm | Algorithm | MultiLineText | | What produced the run: NearestNeighbour for the straight-line run, History-AllTime for Mostly Followed runs, or the routing service's own name for a road-network run from Optimize Route Sequence. |
ComputedDateTime | Computed On | Date | | When the run was computed. The background refresh compares this date on the route's current route-wide Optimized run with later stop changes and started visits to decide whether the route is due again. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
EstDurationMins | Est. Duration (min) | Number | | Estimated driving time. Road-network runs carry the routing service's estimate; other runs assume an average of 24 km per hour over Total Distance. |
Id | Id | Guid | Yes | |
IsCurrent | Is Current | Boolean | | Marks the run used for new plans within its family (route, Sequence Type and Salesperson). A new run of the same family clears it on the previous one, and Activate moves it to the selected run. Ticking it by hand on an edit form does not clear it on the other runs, so use Activate instead. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | Set when the run is created: the route name, the sequence type, "rep" for a salesperson-specific run, and the creation date and time in UTC, separated by middle dots. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
RecordTypeId | Record Type | Guid, hidden | | |
ResourceId | Salesperson | Lookup → Resource | | Filled only on Mostly Followed runs built from one salesperson's visit history (the salesperson assigned to the plans). Empty means the run covers the whole route. Optimized runs are always route-wide. When a plan is generated, a current run for the plan's salesperson wins over the route-wide run. |
SequenceType | Sequence Type | PickList | | The kind of order. Optimized comes from Optimize Route Sequence (road distances) or from Recompute Sequences and the background refresh (straight-line nearest neighbour). Mostly Followed comes from the order in which visits were actually started. Planned and Custom are never produced by xMatix and are not read when plans are generated, because the planned order always comes from the stops' Sequence Numbers. Values: Planned, Optimized, Mostly Followed, Custom. |
StopsResequenced | Stops Resequenced | Number | | How many positions in this order hold a different stop from the authored order (stops by Sequence Number). Zero means the run matches the authored order. |
TotalDistanceKm | Total Distance (km) | Number | | The length of the order. Road-network runs carry the routing service's driving distance; straight-line runs carry the sum of straight-line legs, including the leg from the route's coverage midpoint when one is set; Mostly Followed runs carry the straight-line distance between consecutive stops. Stops without an Account Location are not counted. |
VisitRouteId | Visit Route | Lookup → VisitRoute | | The beat whose stops this run orders. |
Actions
| Action | Label | Type | What it does |
|---|
ActivateRouteSequence | Activate | ServerAction (ActivateRouteSequence) | Makes this run the current one within its (route, type, resource) family by flipping isCurrent flags only - runs are append-only and no ordering data changes. Future plans of the route are cut with this ordering; existing plans keep theirs unless ApplySequenceToPlan is used. |
ActivateRouteSequenceRow | Activate | ServerAction (ActivateRouteSequence) | List-row variant of the activate flow: same behavior as ActivateRouteSequence (flips isCurrent within the run's family; append-only history is preserved), exposed on each row of the sequence list. |
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
DeleteHeader | Delete | Delete | DeleteHeader |
DeleteRow | Delete | Delete | DeleteRow |
EditInLine | Edit | EditInline | EditInLine |
EditRow | Edit | Edit | EditRow |
New | New | New | New |
