NVD VisitVisit

Overview

The visit defines the activity that needs to be performed through the period. The profile associated with the visit will govern how many times a visit is required to be performed in the period. One can consider a visit as analogous to a job in the IVR model, and each instance of a visit equivalent to a task.

Applicable models

• NVD nvd-hap0j2y4zlm1

Visit

Defines a set of work to be performed in the schedule over the period.

Schema definition

message Visit {
  required string id = 1;
  required Geocode location = 2;
  required float visitTime = 3 [default = 0.0];
  required Profile profile = 4;
  optional TerritoryRelation territoryRelations = 5;
}

Fields

id

A unique identifier for the collection of customer visits (for a profile with multiple visits). Visits are not permitted to have duplicate id’s in the same model.

location

The geocode specifying the geographic location at which the visit should occur.

visitTime

The time consumed by this visit, measured in the same units specified by the configuration

profile

The profile that should be applied to this particular visit. The profile assigned will determine the number of times this visit is performed in the period.

territoryRelations

Determines to which territories this visit may be assigned. If omitted, all territories are assumed allowable (default).

Examples

The following describes a visit which should be performed once a week at the Oval Bar in Dublin. The visit time is 74 minutes (consistent with the units specified in the configuration).

id: "The Oval Bar Dublin"
location {
  longitude: -6.26029587
  latitude: 53.348465
}
visitTimeMinutes: 74
profile {
  frequencyType: ONCE_A_WEEK
}

TerritoryRelation

A territory relation defines either an inclusive or exclusive relation between a visit and territories.

Schema definition

message TerritoryRelation {
  enum Type {
    INCLUSIVE = 0;
    EXCLUSIVE = 1;
  }
  required Type type = 1;
  repeated string territoryIds = 2;
}

Fields

type

Defines the type of relation as either inclusive or exclusive.

territoryIds

A list of territory ids which are either allowable in the assignment of a visit, or excluded.

Examples

This territory relation defines an allowable assignment between the visit and the territory My Sales Rep (@Guiness).

territoryRelations {
  type: INCLUSIVE
  territoryIds: "My Sales Rep (@Guiness)"
}