Attribute Name

Type

Field Size

Description

Required

RouteTemplateID

int

4

Unique Identifier of the Route Template record.

Required

RouteTemplateKey

nvarchar

50

Business key to identify the activity this Route template refers to. Must exist in the Route Template table.

It is important that the same ScheduleID and ScheduleKey on the specified route are the same as the ScheduleID and ScheduleKey on this stop.

Required

InitialLocationKey

nvarchar

50

The initial location at which the route begins. ID of an entry in the FWLocation Table. The initial location attribute will determine the time zone for all the date saved on this record. If this value changes, all times will need to change to the new time zone.

FinalLocationKey

nvarchar

50

The final location (Station) at which the route ends. ID of an entry in the FWLocation Table.

ScheduleKey

nvarchar

50

If entered, it must exist on the FWSchedule table. A selection list should be provided. This field is used to link a resource to a specific schedule during creation by creating a link route entry that associates this schedule and resource combination. All Route templates should default to the DefaultSchedule.

ModifiedBy

int

4

See ModifiedBy.

ModifyDate

datetime

8

See ModifyDate.

CreatedBy

int

4

See CreatedBy.

CreatedDate

datetime

8

See CreatedDate.

Comment

nvarchar

500

See Comment.

Name

nvarchar

255

See Name under Generic Attributes.

Type

nvarchar

50

This field is used to identify different stop template types that may require different processes.

For example: we can have a standard default type that is typically used for default value where the incoming settings take precedence. We can also have a set where the template values are used regardless of the incoming values. Currently only the default type is supported.

The value must be validated against the FWCode table StopTemplateType.

Valid Values:

·     DEFAULT = This is the normal template type used for default values whenever a value is not provided with the resource creation process.

Required

Status

nvarchar

50

This field is used to identify different status’ of a given route template over time. The current implementation is configured to support one status value ”r;DEFAULT”. As the application gets built out, additional statuses will follow.

Required

Territory

nvarchar

50

Must be validated against the FWCode table for a value territory. Default is empty.

DriverKey

nvarchar

50

Must be validated against the FWCode table. As we build out the resource management system, this will represent a foreign key to a driver or user of type driver table. Default is empty.

TrailerKey

nvarchar

50

Must be validated against the FWCode table. As we build out the resource management system, this will represent a foreign key to a Trailer or equipment of type trailer table. Default is empty.

TractorKey

nvarchar

50

Must be validated against the FWCode table. As we build out the resource management system, this will represent a foreign key to a tractor or equipment of type tractor table. Default is empty.

Measure1-9

float

8

These values are applicable to the corresponding stop occurrence values used to manage capacity. Default is zero (0).

For example: If the stop is a Drop-off type stop then this amount is reduced by the corresponding stop amounts (plus factor) to reflect additional capacity on this resource and save it in the ProjectedMesureCapacity on the route record. If the stop is a pickup then the corresponding amount is added to reduce this capacity.

Measure1-9Factor

float

8

When entered, the Measures1-9 occurrence must also be entered. This value provides the ability to reduce or increase the Measure values by this factor. This attribute is a percentage value used to adjust the measure value. Default is one (1).

For example: If the factor is less than one then the measure is reduced. If it is equal to one, then the measure will stay the same; and if the factor is more than one, then the measure is more. A negative value is not allowed.

Measure1-9RechargeRate

float

8

When entered, the Measures1-9 occurrence must match the location supplied measure values; otherwise, recharge is ignored. The recharge rate is measured in units per second and is associated with the MeasureRechargeRate and Measure values of the location. Default is zero (0).

MaxStops

smallint

2

This value is used to set the absolute threshold of the total number of stops that can be associated with this route. The stop types must be PICKUP (1), DROPOFF(0) or RECHARGE(4). Default is zero (0).

FullThreshold

float

8

Used as a percentage of the capacity (measure amount) to apply the CompleteFullBonus and PartialFullPenalty values. Please see complete full bonus and partial full penalty for details. A value of 1.0 will require all measures to be at capacity before the Complete Full Bonus is applied and to avoid incurring the Partial Full Penalty. A value of 0.5 will require at least 50% capacity utilization on all measure to receive the Complete Full Bonus. If one of the measures is less than 50%, then the Partial Full Penalty is applied. A value of 0.0 (default) indicates that the bonus and penalty values is ignored. Default is zero (0).

CompletedFullBonus

float

8

This attribute works in conjunction with the FullThreshold value. The CompleteFullBonus is added to the overall route profit when all measures are equal to or greater than the FullThreshold values. If not, then this value is ignored. Default is zero (0).

PartialFullPenalty

float

8

This attribute works in conjunction with the FullThreshold value. The PartialFullPenalty is subtracted from the overall route profit when one or more measures are less than the FullThreshold values. If not, then this value is ignored. Default is zero (0).

Requirements

nvarchar

255

Each specified code must exist on the FWCode table for the Requirement type. Multiple entries are possible and delimited by a comma or space. These values are accumulated with the requirements supplied with the input request to create a resource. They are used to match the requirement values on the stop records, and each specified stop requirement must be defined on the route requirements field or the stop will not be serviced by that resource. Additional requirements can be specified at the resource and route level and are ignored, but additional requirements cannot be specified at the stop level. All stop requirements must be specified by the route record to be considered for possible service on that route. Default is empty.

Profit

float

8

This attribute is set to a base profit value. It is cumulative where the template value is added to the incoming resource creation call and saved on the Resource record. Default is zero (0).

SameStopBonus

float

8

This value is added to the overall profit of the route for every additional stop at a specific location.

For example: If we have two stops at the same location, then the second stop will have the bonus applied once. If a third stop was also served at the same stop, then the bonus is applied twice, once for the second stop and again for the third stop. If we have two different locations with two serviceable stops at each location (type pickup or drop-off), then the bonus is applied twice, once for the second stop of the first pair and again for the second stop of the second pair. And so on.

DiscountInitialLeg

float

8

This value is used to discount the penalty of the initial leg of the route. It is a percent value used to reduce the cost of that leg.

For example: a value of 1.0 will discount the full penalty of this leg and no penalty is incurred, a value of .6 will discount 60% of the penalty and apply 40% of the penalty. A value of .15 will discount 15% and apply 85% of the penalty.

DiscountFinalLeg

float

8

This value is used to discount the penalty of the final leg of the route. See the discount initial leg for details.

PenaltyPerOrder

float

8

This value is used to apply a penalty for every order (type Pickup or Drop-off) serviced. Total penalty is multiplied by this value and the number of orders serviced. It is deducted from the overall route profit. If less than the MinPaidOrders have been assigned to this route, then the MinPaidOrders is used as the multiplier. See the MinPaidOrders for details. Default is zero (0).

PenaltyPerMeter

float

8

Only used when the Schedule is set to StraightLine distances. This value is used to apply a penalty for every meter driven. Previous setting was in miles, so care should be taken when updating or using this value. This amount is multiplied by the distance and deducted from the overall route profit. Default is zero (0).

MinPaidOrders

smallint

2

This value is used to set a minimum threshold of the number of orders that the PenaltyPerOrder is applied against. Default is zero (0).

Minimum number of orders the driver will be paid for. Multiplied by the DriverPayPerOrder value.

For example: if the number of orders serviced is three, and this value is set to 5, then the PenaltyPerOrder is applied against the minimum setting. If seven orders were serviced, then the penalty is applied against the actual value serviced and this setting is ignored.

ServicePenalty

float

8

This attribute is used to set a base penalty value that is issued to deploy this resource. It is deducted from the overall route profit. Default is zero (0).

MissedWindowPenalty

float

8

Per second penalty for a missed time window. With values greater than zero, the Optimizer tends to keep unserved jobs close to their time windows instead of placing them geographically.

LatestEndPenalty

float

8

This value is used to penalize a route that missed its LatestEndDate time. Regardless of how much the time window was missed, the same flat value is used. Default is 1000.

WaitTimePenalty

float

8

This value is applied for every second that the resource waits to service the order. It is applied against every second of the route. WaitTime values are used.

Work1-7Penalty

float

8

This attribute is based on using occurrence one first, then two, three, and so on. It is not possible to skip any occurrences. Occurrences two through seven must be empty if one is empty. Occurrences three through seven must be empty if two is empty and so on.

This value is used in conjunction with the WorkDuration attribute. If one is entered, the other is required. These values are used to either increase or decrease the penalty as the route executes over time at different rates. This value is applied for every second of duration.

For example: If only Work1Penalty is set then that will apply for the whole elapsed time of the route. If Work1duration is set as well then Work1Penalty will apply until the Elapsed time of the route equals Work1Duration at which point Work2Penalty will be applied. The Work Duration fields are cumulative. If Work1Duration is 36000 secs and Work2Duration is 54000 seconds then Work1Penalty will be applied until the elapsed time is 36000 seconds and Work2Penalty will be applied when the elapsed time is >36000 and <= 54000. Work3Penalty will be applied when the elapsed time is >54000.

Please note that the duration must be in seconds.

Work1-7Duration

int

4

This attribute is directly related to the Work1-7Penalty attribute. These values are used to either increase or decrease the penalty as the route executes over time at different rates. See Work penalty for more details.

BreakDuration

int

4

This attribute specifies the length of the break to be taken. If this attribute is empty the following must also be empty:

·     MaxElapsedTimeBeforeBreak

·     MaxDriviyTimeBeforeBreak

·     MaxNumberOfBreaks

MaxElapsedTimeBeforeBreak

int

4

If entered, the BreakDuration must also be greater than 0. This attribute indicates how much time must pass before a break can be scheduled. Time is measured in seconds. Default is zero (0).

MaxDrivingTimeBeforeBreak

int

4

If entered, the BreakDuration must also be greater than 0. This attribute indicates how much driving time must pass before a break can be scheduled. Time is measured in seconds.

MaxNumberOfBreaks

tinyint

1

If BreakDuration was entered, then this attribute must be greater than 0. This attribute indicates the maximum number of breaks allowed for a given work unit. A work unit is dependent on whether rests are being used. If rests are not being used, then the number of breaks is allowed for the duration of the route. If rests are specified, then this number of breaks is allowed between every rest.

For example:When a rest occurs, the number of breaks taken is reset and the count starts again.

The default value is zero, which represents an unlimited number of breaks.

BreakTimeOnDutyInd

bit

1

Determines if time spent on break is counted as elapsed time between rests.

RestDuration

int

4

This attribute specifies the length of the rest to be taken. If this attribute is empty the following must also be empty:

·     MaxElapsedTimeBeforeRest

·     MaxDrivingTimeBeforeRest

·     FirstStopTimeThreshold

MaxElapsedTimeBeforeRest

int

4

If entered, then RestDuration must be greater than 0. This attribute indicates how much time must pass before a break can be scheduled. Time is measured in seconds. Default is zero (0).

MaxDrivingTimeBeforeRest

int

4

If entered, then RestDuration must be greater than 0. This attribute indicates how much driving time must pass before a break can be scheduled. Time is measured in seconds. Default is zero (0).

FirstStopTimeThreshold

float

8

If entered, then RestDuration must be greater than 0. This attribute is very similar to the Early Rest Time Threshold attribute in that its value is applied against the maximum elapsed or driving time settings with the exception that it is only considered for the first stop on the route. This attribute allows users to have the first stop treated differently from other stops (e.g., only allow early rests to be scheduled for the first stop). The First Stop Time Threshold attribute is only evaluated if the Allow Early Rests setting is true. It is also represented as a percentage of the maximum elapsed or drive time. Default is zero (0).

Note―  Both the First Stop Time Threshold and the Early Rest Wait Threshold must be met for an early rest to be taken.

UseFullWaitAsRestInd

bit

1

This attribute determines how the recuperation time is considered. If enabled, the entire recuperation time is considered to be off the clock and the clock is reset when work begins again. If disabled, then the clock will restart as soon as the recuperation time has elapsed. This is only significant if the idle time before a stop is larger than the Recuperation Time attribute. Default is true.

For example: If Use Full Wait As Rest were false, the idle time before a particular stop were eight (8) hours, and the Recuperation Time for the resource were six (6) hours, then the clock would restart two (2) hours before the idle time were completed (when work at the stop begins).

AllowEarlyRest

bit

1

If set to true the following must also be greater than 0:

·     EarlyRestTimeThreshold

·     EarlyRestWaitThreshold

This attribute indicates whether early rests are allowed. If yes, then rests can be scheduled before the maximum elapsed or drive time threshold values have been reached. If no, then the maximum elapsed or drive threshold values must be reached before a rest can be scheduled.

EarlyRestTimeThreshold

float

8

If greater than 0, then the AllowEarlyRests must be set to true. This attribute indicates how much of the maximum elapsed or drive time threshold must be used before an early rest can be scheduled. The early rest time threshold is only evaluated when the Allow Early Rest indicator is enabled. The Early Rest Time Threshold value is represented as a percentage of the maximum elapsed or drive time.

For example: if the Maximum Elapsed Time Before Rest attribute is set to four (4) hours and the Early Rest Time Threshold is set to .50 (50%), then the earliest that the rest can be scheduled would be two (2) hours into the route. 

Note―  Both the Early Rest Time Threshold and the Early Rest Wait Threshold must be met for an early rest to be taken.

EarlyRestWaitThreshold

float

8

If greater than 0, then the AllowEarlyRests must be set to True. This attribute indicates how much of the recuperation time must be available to schedule an early rest. It is represented as a percentage of the total recuperation time. In other words, the Early Rest Wait Threshold attribute works in conjunction with the Recuperation Time attribute.

For example: if the Recuperation Time is eight (8) hours and the Early Rest Wait Threshold is set to .75 (75%) then an early rest can be taken only if there is a period of idle time that is greater than six (6) hours, 75% of the total recuperation time.

The early rest wait threshold is only evaluated when the Allow Early Rest indicator is enabled.

Note―  Depending on the stop in question, both the Early Rest Time Threshold or First Stop Time Threshold and the Early Rest Wait Threshold must be met for an early rest to be taken.

OpertunisticEarlyRest

bit

1

Specifies whether or not an early rest should be taken whenever the wait time to serve a job is larger than the Resource's RecuperationTime. Default is 1 (true).

If false, early rests are entirely controlled by FirstStopTimeThreshold, EarlyRestTimeThreshold, and EarlyRestWaitThreshold.

RechargeDuration

int

4

This attribute is used to set a consistent recharge duration in seconds for this resource. Default is zero (0).

MaxDwellDuration

int

4

Restricts the "dwell" time for a route, which is the total elapsed time from the beginning of service for the first job (initial drive and parking time are ignored) through the final return to depot. A value of 00:00 places no restriction on the dwell time. Default is zero (0).

MaxElapsedDuration

int

4

Maximum elapsed time for the entire route. Elapsed time is measured from start of route through the return to final depot.

Note—  Routes that violate this attribute incur the LatestEndingTimePenalty. Stops (including the final return to depot) that cause violations are marked with the letter code ”r;T” and colored red.

InitialServiceDuration

int

4

This attribute is used to set an initial service duration for the first job for the same customer at the same location. It is added to the standard service duration once for each grouping of same stop orders. Default is zero (0).

ServiceDuration

int

4

This attribute is used to set a consistent service duration for this resource.

PreServiceDuration

int

4

This attribute is used mostly to model parking time at each stop, but users can include other activity times here like item unloading time which is not reflected in ServiceDuration. When it’s used to model parking time, it differentiates between resources that are easy to park and those that are difficult to park. For example, parking a large truck usually takes longer than parking a van. The main difference between PreServiceDuration and ServiceDuration is that PreServiceDuration can be scheduled before a time window starts whereas ServiceDuration must be served within the time window.

ServiceSpeedFactor

float

8

This attribute can be used to adjust and control how quickly a resource serves stops. It is used to calculate how long it takes a resource to service a stop by dividing the stop's total service duration (including pre and post values) by the resource's ServiceSpeedFactor value. A value less than 1.0 increases the time the resource requires to service stops, and a value greater than 1.0 decreases the time.

For example: If stop X has a total service duration of 100 seconds.

·     A resource with a ServiceSpeedFactor of 1.0 needs 100 seconds to serve it (100/1.0 = 100).

·     A resource with a ServiceSpeedFactor of .50 needs 200 seconds to serve it (100/0.5 = 200).

·     A resource with a ServiceSpeedFactor of 1.5 needs 67 seconds to serve it (100/1.5 = 67).

SpeedFactor

float

8

Used to offset the RoutingParameter speeds. Changes travel times without reconfiguring the Routing Parameter attributes or the speed attributes. Numbers greater than one create faster travel times; numbers less than one create slower travel times. The calculation is: adjusted time = calculated time divided by speed factor.

For example: calculated time = 100, Speed factor = .75, resulting in an adjusted time of 133.34 (100 ÷ .75 = 133.34).

MaxDistance

float

8

This attribute restricts the distance that this resource can travel in meters, not miles.

MinTravelDistance

float

8

This attribute is used to determine the distance at which two stops are considered separate stops. If the distance between two sequential stops is less than this value, it is assumed that the vehicle parks once to service both stops. Please note that the unit is meters not feet.

Speed1-7

float

8

This is used when the Schedule setting UseRoadDistance =0 meaning straight line rather than along road routing. This attribute is based on using occurrence one first. Once one is used, two is available for use. Occurrences two through seven must be empty if one is empty. Occurrences three through seven must be empty if two is empty, and so on.

This attribute is used in conjunction with the SpeedThreshold attribute. It is used to control the speed the resource travels between different SpeedThreshold distances.

Speed1-7Threshold

float

8

This is used when the Schedule setting UseRoadDistance =0 meaning straight line rather than along road routing. This attribute is directly related to the Speed1-7 attribute and each Speed occurrence must have a corresponding Speed1-7Threashold value

This attribute works in conjunction with the Speed Attribute where the speed is used for the corresponding speed threshold distance. Once the distance is reached, the second occurrence speed and distance is used.

DynamicZoningDistance

float

8

Distance in Meters: Allows Optimizer to make appropriate geographic decisions based on the current set of orders in the system. Unlike "static" zones (which must be pre-determined in the data set using the "Zone" attributes), Dynamic Zoning allows the set of Resources/Jobs allowed for any given optimization to change over time based on the current assignment of jobs and Distance value.

RoutingParameterKey

nvarchar

50

Routing parameter key to use during optimization

DriverID

int

4

Unique Identifier of the Driver record. Must exist in the Driver table.

EarliestEndDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the EarliestEndDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the EarliestEndDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

EarliestServiceDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the EarliestServiceDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the EarliestServiceDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

EarliestStartDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the EarliestStartDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the EarliestStartDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

EarliestEndTime

datetime

8

EarliestEndTime to set to the generated resources using this template

EarliestServiceTime

datetime

8

EarliestServiceTime to set to the generated resources using this template

EarliestStartTime

datetime

8

EarliestStartTime to set to the generated resources using this template

Frequency

int

4

Bitmask used by FW to generate resources from this template. This field specifies what days of the week should be used to generate resources given an input date range.

LatestEndTime

datetime

8

LatestEndTime to set to the generated resources using this template

LatestEndDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the LatestEndDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the LatestEndDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

LatestServiceDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the LatestServiceDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the LatestServiceDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

LatestStartDay

int

4

Used for generation of resources using this template. A value greater than 0, will indicate that the LatestStartDate for the generated resource will be the date that falls within the date range and matches its frequency value plus this field value. For example, if resources are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the LatestStartDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

LatestServiceTime

datetime

8

LatestServiceTime to set to the generated resources using this template

LatestStartTime

datetime

8

LatestStartTime to set to the generated resources using this template

ScheduleID

int

4

Unique Identifier of the Schedule record. Must exist on the FWSchedule table.

Prefix

nvarchar

50

Prefix utilized to in the Resource Key of the records generated using this template

Suffix

nvarchar

50

Sufix utilized to in the Resource Key of the records generated using this template

MaxDrivingTime

int

4

Maximum Driving Time before a break

LastDateWorked

datetime

8

Date of the final day supplied in WorkWeekHistory.

WorkWeekLength

int

4

Number of days in a work week (e.g. 6 or 7).

WorkWeekLimit

int

4

Number of hours that can be worked (e.g., 70:00).

WeeklyRestLength

int

4

Idle time required to reset the work week (e.g, 34:00).

WorkWeekResetTime

int

4

Time of day marking the end of one ’r;day’ and the beginning of the next (e.g., midnight, entered as 00:00).

WorkWeekHistory1-14

int

4

Hours worked per day for each day from 1-WorkWeekLength. For any day without a history supplied zero (0) will be assumed.

DaysFromToday

int

4

The number of days to add to today to compute the first date on which to generate resources based on this route template.

NoDays

int

4

The number of days from the first date for which to generate resources based on this route template.

NoResources

int

4

Number of Resources to generate when using this route template.

AdapiDrivingTimeFactor

float

8

Multiplier that the advise will use to calculate nominal driving time.

MaxRedispatches

int

4

Maximum number of recharges

MaxRedispatchTime

int

4

Maximum recharge time

TruckKey

nvarchar

50

Business key to identify the activity this Route template refers to. Must exist exist in the FWTruck table.

TruckID

int

4

Unique Identifier of the Truck record. Must exist in the FWTruck table.

FWResourceTemplateSetID

int

4

Internal unique database record ID.

FWResourceTemplateSetKey

nvarchar

4

Business Key identifier for this Resource Template Set Key. This key is used for the optimizer.

Reload/Threshold

int

4

Allows the optimizer to consider a recharge for this resource whenever its capacity is less than or equal to this number.

UnloadThreshold

int

4

Allows the optimizer to consider a recharge for this resource whenever its capacity is greater than or equal to this number.

RechargeToCapacity

bit

1

Tells the optimizer if the recharge should be done to capacity or not. If this value is set to zero, then the recharge amount will only be required to fulfill the planned stops in the route. 1=Recharge to Capacity, 0=Recharge

EndVehicleFullEmpty

bit

1

Allows Route Planner to schedule a recharge or unload at the end of the route when the vehicle returns to its final location. If active, then Route Planner will calculate the time required to execute this task based on the Recharge rates defined for this

Published

int

This field indicates if a Stop has been published either caused by Publishing a Route or the stop.

Possible Values:

Null or 0: Unpublished

1: Published

2: Changed After Published

UDFDateTime1-3

nvarchar

User-defined date/time fields

RequirementSetID

int

4

Unique internal DB Identifier for the Requirement set record.

UDFString1-9

nvarchar

500

User Defined Fields for strings 1...9

UDFInteger1-3

int

4

User Defined Fields for integers 1...9

UDFNumber1-3

float

8

User Defined Fields for numbers 1...9

CompleteFullBonus

float

8

This attribute works in conjunction with the FullThreshold value. The CompleteFullBonus is added to the overall route profit when all measures are equal to or greater than the FullThreshold values. If not, then this value is ignored. Default is zero (0).

ResourceKeyWizardID

int

4

ResourceKey wizard record ID used for generating Resourcekey

WorkUnits

float

8

The maximum workload a resource can handle during the entire route duration, no matter how many recharge occurs in it.

StartUpTime

int

Allows RMPI to add a startup time at the beginning of a route. This time can be specified by resource and/or by location. If both exist, RMPI adds them together.

WindUpTime

int

Allows RMPI to add a shut down time at the end of a route. This time can be specified by resource and/or by location. If both exist, RMPI adds them together.

ReloadThreshold

float

8

Used to determine when to perform reloads

RechargeToCapacity

bit

1

Tells the optimizer if the recharge should be done to capacity or not. If this value is set to zero, then the recharge amount will only be required to fulfill the planned stops in the route. 1=Recharge to Capacity, 0=Recharge

EndVehicleFullEmpty

bit

1

Allows Route Planner to schedule a recharge or unload at the end of the route when the vehicle returns to its final location. If active, then Route Planner will calculate the time required to execute this task based on the Recharge rates defined for this resource.

HazmatType

int

4

Indicate the resource can handle hazardous material

Weight

float

8

Asset weight

Height

float

8

Asset height

Length

float

8

Asset length

Width

float

8

Asset width

SpeedCatID

int

Speed category record ID

AllowEmptyStart

bit

1

Enables Resources to start empty and allows them to load at their home or remote location. To activate this functionality on a schedule, the AllowEmptyStart property must be set to “1”.

EndVehicleMeasuresRequired

int

4

Integer that encodes indices of measures that a resource needs to fill up before closing out the route in preparation for next day's route. MeasureN is encoded into 2N-1. For example, the requirement to fill up Measure1, Measure3, and Measure6 are represented by EndVehicleMeasuresRequired=37

AllowRecharges

bit

1

If the resource is allowed to recharge

CommodityTransitionFactor

float

8

Used to calculate the time required to change commodities in a reload.

FreezeInd

bit

1

This fields indicates if the route is frozen. IF this field has a value of 1, then the route cannot be changed at all. It can only take status messages.

MaxDistanceFromDepot

float

8

Maximum as-the-crow-flies distance away from initial depot of resource

RedispatchRest

int

4

The rest time for redispatch (reserved for future development)

TrailerID

int

4

Unique Identifier of the Trailer record. Must exist in the FWTrailer table.