NVD ModelModel

Overview

The model is the object which contains all the defined input data for a solve.

Applicable models

• NVD nvd-hap0j2y4zlm1

Model

An NVD model is, at minimum, a collection of configuration, visits and territories (or sales-reps). An optional visit sequence can be provided should the user wish to evaluate a particular allocation of visits to a territory over a period.

Schema definition

message Model {
  required Configuration configuration = 1;
  repeated Visit visits = 2;
  repeated Territory territories = 3;
  repeated VisitSequence visitSequence = 4;
}

Fields

configuration

A configuration object defining the units and cost coefficients to be used in the optimisation process.

visits

A list of visit objects defining the workload to be allocated by the optimiser.

territories

A list of territory objects which define the available resources to perform the visits.

visitSequence

An optional visit sequence which is used in conjunction with an Evaluate or ReOptimise solve request. A visit sequence is also used to retrieve the specific detail of a schedule from the Pareto frontier collection which will return multiple solutions which are all considered optimal.