5.2 General Object
The general object contains settings for optimiser Global Parameters (see Section x12-110002.82.8). It has the following fields:
- Field: name
Required: No.
Type: String.
Description: A name for the scenario. - Field: iterations
Required: No.
Type: Number.
Default: 3000.
Description: The number of iterations that the optimiser runs for. - Field: iteration_scheme
Required: No.
Type: String.
Default: null.
Description: The identifier of the iteration scheme to be used by the optimiser.
Note: If an iteration scheme is specified, then it overrides the values of the iterations and
maximum_neighbourhood_size fields if they are also present. - Field: maximum_neighbourhood_size
Required: No.
Type: Number.
Default: 200.
Description: The maximum size of a neighbourhood for the optimiser. (See Maximum Neighbourhood Size in Section x12-110002.82.8.) - Field: unassigned_penalty_scheme
Required: No.
Type: String (one of the unassigned penalty scheme codes).
Default: FIXED.
Description: The unassigned penalty scheme to use. -
Field: fixed_unassigned_penalty
Required: No.
Type: Number (positive integer).
Default: 30000.
Description: The value of the penalty used with the FIXED unassigned penalty scheme.7.Field: geofence_north
Required: No.
Type: Number in [-90, 90].
Description: The latitude of the northern boundary for locations in the scenario. Acts to enforce accuracy of geocodes.8.Field: geofence_east
Required: No.
Type: Number in [-180, 180].
Description: The longitude of the eastern boundary for locations in the scenario. Acts to enforce accuracy of geocodes.9.Field: geofence_south
Required: No.
Type: Number in [-90, 90].
Description: The latitude of the southern boundary for locations in the scenario. Acts to enforce accuracy of geocodes.10.Field: geofence_west
Required: No.
Type: Number in [-180, 180].
Description: The longitude of the western boundary for locations in the scenario. Acts to enforce accuracy of geocodes. - Field: hard_geofence_errors
Required: No.
Type: Boolean.
Default: false.
Description: If true, then treat any errors produced by geofence violations as being hard. - Field: colocated_pickups
Required: No.
Type: Boolean.
Default: false.
Description: If true, then enforce the colocated pickups constraint. - Field: batched_loads
Required: No.
Type: Boolean.
Default: true.
Description: If true, then enforce the batched loads constraint. -
Field: use_miles
Required: No.
Type: Boolean.
Default: false.
Description: If true, then distance values in the solution will be in miles rather than kilometres.15.Field: preferred_vehicle_fixed_reward
Required: No.
Type: Number (positive).
Default: 0.
Description: If replanning, a fixed reward for assigning an order to its originally planned vehicle.16.Field: preferred_vehicle_weight_reward
Required: No.
Type: Number (positive).
Default: 0.
Description: If replanning, a weight scaled reward for assigning an order to its originally planned vehicle. - Field: preferred_vehicle_volume_reward
Required: No.
Type: Number (positive).
Default: 0.
Description: If replanning, a volume scaled reward for assigning an order to its originally planned vehicle. - Field: sticky_deliveries
Required: No.
Type: Boolean.
Default: false.
Description: If true, then enforce the Sticky Deliveries constraint. -
Field: cost_scale
Required: No.
Type: Number.
Default: 0 (Which means to not apply cost scaling.)
Description: Scale costs by this amount before solving. (See Scaling Factors in Section x12-110002.82.8).20.Field: weight_scale
Required: No.
Type: Number.
Default: 0 (Which means to not apply weight scaling.)
Description: Scale weights by this amount before solving. (See Scaling Factors in Section x12-110002.82.8). - Field: volume_scale
Required: No.
Type: Number.
Default: 0 (Which means to not apply volume scaling.)
Description: Scale volumes by this amount before solving. (See Scaling Factors in Section x12-110002.82.8). - Field: arrival_only_in_tw
Required: No.
Type: Boolean.
Default: false.
Description: Enables the Arrival Only in Time Window behaviour. - Field: order_splitting_strategy
Required: No.
Type: String (one of the order splitting strategy codes).
Default: NONE.
Description: The order splitting strategy to use. - Field: split_solve
Required: No.
Value Type: Boolean.
Default: FALSE.
Description: If TRUE, then the optimiser will attempt to split solve the scenario. - Field: split_solve_jobs
Required: No.
Value Type: Number (positive integer).
Default: 2.
Description: If split solve is TRUE, then the number of sub-scenarios to solve concurrently.
Note: This value is limited according to the installation and any value above this will be reduced to this limit.

