xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Route Sequence — entity reference
REFERENCE · Last reviewed

Route Sequence — entity reference

A versioned, named ordering of a Visit Route's stops - the source of record behind the per-visit sequence snapshots (Visit plannedSequence/optimizedSequence/mostlyFollowedSequence). Every optimization run or history refresh appends a new header plus RouteSequenceEntry lines and flips isCurrent within its (route, type, resource) family, so runs stay comparable and auditable. resourceId scopes a salesperson-specific variant (their personally followed order on the beat); null means route-generic. The planner copies the current sequences onto a plan's visits at creation, and a background maintenance job keeps them fresh as visit history accrues.

Fields

FieldLabelTypeRequiredWhat it does
AlgorithmAlgorithmMultiLineTextProducer of the run - for example NearestNeighbour for the free geo pass, a routing-provider name for paid road-network runs, History for mostly-followed refreshes, Manual for hand-built orders.
ComputedDateTimeComputed OnDate
CreatedByIdCreated ByLookup → UserAccountYes
EstDurationMinsEst. Duration (min)Number
IdIdGuidYes
IsCurrentIs CurrentBooleanMarks the active run within its (route, type, resource) family. Runs are append-only: a new run or the Activate action flips this flag rather than editing old rows, so the full history stays auditable.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
RecordTypeIdRecord TypeGuid, hidden
ResourceIdSalespersonLookup → ResourceScopes a salesperson-specific run (their personal mostly-followed order on the beat); null = route-generic. When the planner stamps visits, a current run matching the plan's assignee wins over the route-generic one.
SequenceTypeSequence TypePickListWhich ordering family the run belongs to: Planned, Optimized, MostlyFollowed or Custom. The planner copies the current Optimized and MostlyFollowed runs onto a plan's visits at creation. Values: Planned, Optimized, Mostly Followed, Custom.
StopsResequencedStops ResequencedNumberHow many stops this ordering moves off their authored (planned) position - a quick signal of how different the run is from the beat as drawn.
TotalDistanceKmTotal Distance (km)Number
VisitRouteIdVisit RouteLookup → VisitRoute

Actions

ActionLabelTypeWhat it does
ActivateRouteSequenceActivateServerAction (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.
ActivateRouteSequenceRowActivateServerAction (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.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteHeaderDeleteDeleteDeleteHeader
DeleteRowDeleteDeleteDeleteRow
EditInLineEditEditInlineEditInLine
EditRowEditEditEditRow
NewNewNewNew