Visit Route — entity reference

A beat: a named, reusable field journey owned by one executive (Resource) or by a seat (Position), whose outlets are its Visit Route Stops and whose weekly schedule decides when visit plans are generated. When automatic generation is on, a background job creates one plan per route per scheduled day for an active route inside its effective dates that has at least one approved stop, unless any plan already exists for that route and date. Each plan copies the route's Visit Route Group, Partner Account, Visit Purpose and Visit Task Template and is assigned to the Resource, or to the seat's holder on that date. The route also holds its stored stop orders (route sequences) used by optimization and the agenda.

Fields

Field	Label	Type	Required	What it does
`AccountGroupId`	Account Group	Lookup → AccountGroup		Stored on the route only. Not copied to plans and not used by plan generation or optimization.
`CoverageMidpointDistance`	Coverage Midpoint Distance (KM)	Number		Not used by plan generation, optimization or territory planning; defaults to 0.
`CoverageMidpointLocation`	Coverage Midpoint Location	GeoLocation		The centre point of the route's outlets, written by territory planning. Optimization starts its order from here when it is set.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DayNumbers`	Day Numbers	Text		Comma-separated weekdays the route runs, 1 = Monday to 7 = Sunday, without spaces. Kept in step with the seven day switches: saving Day Numbers resets the switches to match, and changing a switch rewrites Day Numbers.
`EffectiveFrom`	Effective From	DateAndTime		The first date the route may generate plans; empty means no start limit. With the rolling four-week numbering mode it also anchors week 1.
`EffectiveTo`	Effective To	DateAndTime		The last date the route may generate plans; empty means no end date.
`FridayAvailable`	Friday Available	Boolean		Whether the route runs on Fridays. Kept in step with Day Numbers.
`Id`	Id	Guid	Yes
`IsActive`	Active	Boolean		Whether the route can generate visit plans. On by default. Switching it off stops generation from the next run and leaves past and already-generated plans untouched.
`ItemGroupId`	Item Group	Lookup → ItemGroup		Stored on the route only. Not copied to plans and not used by plan generation or optimization.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`MondayAvailable`	Monday Available	Boolean		Whether the route runs on Mondays. The day switches decide plan generation and are kept in step with Day Numbers.
`Name`	Name	Text		The beat's name, required on the form and shown in lists and on the Route Optimization page.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountGroupId`	Partner Account Group	Lookup → AccountGroup		Stored on the route only. Not copied to plans and not used by plan generation or optimization.
`PartnerAccountId`	Partner Account	Lookup → Account		The distributor or channel partner the beat serves. Only active partner accounts can be picked. Copied onto every generated plan; Outlet Transfer moves outlets only between beats with the same partner.
`PositionId`	Position	Lookup → Position		The seat that owns the route. When set, generated plans go to whoever holds the seat on the plan date (an unassigned plan when the seat is vacant), and Resource is kept in step with the holder.
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text		Free-text notes about the route. Not on the delivered forms.
`ResourceId`	Resource	Lookup → Resource		The executive who owns the route; generated plans are assigned to them. Only active resources can be picked. On a seat-owned route (Position set) it is restamped automatically to the seat's current holder, so a manual edit there does not last.
`RouteName`	Route Name	LongMultiLineText		An alternative name used as the name of generated visit plans when set. Not on the delivered forms.
`RoutingPriority`	Routing Priority	PickList		Shortest Time or Shortest Distance. Recorded only; route optimization does not read it. Values: Shortest Distance, Shortest Time.
`SaturdayAvailable`	Saturday Available	Boolean		Whether the route runs on Saturdays. Kept in step with Day Numbers.
`StartTime`	Start Time	TimeOnly		The time of day generated plans start. Without it a generated plan starts at midnight. Not on the delivered forms.
`SundayAvailable`	Sunday Available	Boolean		Whether the route runs on Sundays. Kept in step with Day Numbers.
`ThursdayAvailable`	Thursday Available	Boolean		Whether the route runs on Thursdays. Kept in step with Day Numbers.
`TuesdayAvailable`	Tuesday Available	Boolean		Whether the route runs on Tuesdays. Kept in step with Day Numbers.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`VisitPurpose`	Visit Purpose	PickList		Why the beat is run. Copied onto every generated plan; each visit takes its purpose from its stop. Values: Service Touch, Order Capture, Order Delivery, Field Service, Product Demo, Courtesy Visit, Payment Collection.
`VisitRouteGroupId`	Visit Route Group	Lookup → VisitRouteGroup		The group of beats this route belongs to. Copied onto every generated plan; territory planning creates and retires routes per group.
`VisitTaskTemplateId`	Visit Task Template	Lookup → VisitTaskTemplate		The work expected at each outlet. Copied onto every generated plan and from there onto every visit. A template recorded on an individual stop is not used.
`WednesdayAvailable`	Wednesday Available	Boolean		Whether the route runs on Wednesdays. Kept in step with Day Numbers.
`WeekNumbers`	Week Numbers	Text		Comma-separated weeks of the month the route runs, for example 1,3. Empty means every week. How a date's week is counted follows the organization's Visit Route week numbering setting (day of month by default).

Actions

Action	Label	Type	What it does
`AssignPositionsFromOwners`	Assign Positions from Owners	ServerAction (`AssignPositionsFromOwners`)	Moves the selected routes to seat ownership: reuses each route executive's open seat or creates one with a Resource Position record, then sets Position. Routes already on a seat or with no Resource are skipped. Not placed on the delivered screens.
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Copies the route's own fields into a new route. Stops are not copied, and the copy keeps the original's Active setting.
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit
`EditInList`	Edit	EditInline	Edit In List Header
`EditPopup`	Edit	Edit	Edit
`New`	New	New	New
`OptimizeRouteSequence`	Optimize Route Sequence	ServerAction (`OptimizeRouteSequence`)	Sends the route's approved stops that have their own Account Location to the road-network routing service (one paid request) and stores the returned order as the route's current Optimized sequence. Stops without coordinates trail in authored order. Refused without sending a request when optimization is not configured or no approved stop has coordinates. Existing plans are not changed.
`RecomputeRouteSequences`	Recompute Sequences	ServerAction (`RecomputeRouteSequences`)	Stores a new straight-line nearest-neighbour Optimized sequence and new Mostly Followed sequences from visit history, for the route and per executive, at no cost. The new Optimized run replaces a road-optimized one as current; re-activate that run to keep it.

Validations

Validation	Applies to	Error message	Notes
Effective From Field Validation	`EffectiveFrom`, Error, inactive	Effective From date cannot be in the past.	Effective From date cannot be in the past.

Lookup filters

Filter	Lookup field	Notes
Partner Account	`PartnerAccountId`
ActiveResource	`ResourceId`

VisitTaskTemplate — looks up via VisitTaskTemplateId
Position — looks up via PositionId
UserAccount — looks up via CreatedById
Resource — looks up via ResourceId
AccountGroup — looks up via PartnerAccountGroupId
UserAccount — looks up via OwnerId
UserAccount — looks up via ModifiedById
ItemGroup — looks up via ItemGroupId
Account — looks up via PartnerAccountId
AccountGroup — looks up via AccountGroupId
VisitRouteGroup — looks up via VisitRouteGroupId
VisitPlan — referenced by via VisitRouteId
Invoice — referenced by via VisitRouteId
Order — referenced by via VisitRouteId
ProspectPlace — referenced by via VisitRouteId
Visit — referenced by via VisitRouteId
RouteSequence — referenced by via VisitRouteId
VisitRouteStop — referenced by via VisitRouteId

Visit Route — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics