Skip to content
Honeywick Consulting

defineObject

The define instruction introduces blocks of reference data used within the optimisation. A single define can set up many objects of various types, and they should be submitted before the schedule objects that reference them.

{
  "stopParams":     ["stopParamsObject"],
  "customerParams": ["customerParamsObject"],
  "resourceParams": ["resourceParamsObject"],
  "contractParams": ["contractParamsObject"],
  "projectParams":  ["projectParamsObject"],
  "topography":     ["topographyObject"]
}
  • stopParams — stopParamsObject: properties of a stop type, referenced from a stop.
  • customerParams — customerParamsObject: properties of a customer, referenced from a stop.
  • resourceParams — resourceParamsObject: properties of a resource type, referenced from a resource.
  • contractParams — contractParamsObject: properties of a contract type, referenced from a resource.
  • projectParams — projectParamsObject: the lead stop type and lifecycle hooks of a project type, referenced from a project’s type.
  • topography — topographyObject: how resources move around the geography.
Section titled “Related”