Generic Window Attributes

 

Attribute Name

Type

Field Size

Description

Required

Type

varchar

50

This attribute is assigned a specific string value by the user. Valid values must be validated against the FWCode table type that is equal to WindowType. This value should be selectable from a list of valid values (FWCode table).

Valid Values:

·        ARRIVE – Vehicle must arrive at this location within this time window

·        DEPART – Vehicle must complete servicing this stop within this time window.

Required – user assigned

EarliestDate

datetime

8

This attribute is assigned a specific date value by the user. It only holds the date format (yyyy:mm:dd). The time is not used in this attribute. The reason for this is that it represents the starting date range for when this time window will start.

If not set, it can start on any date.

Required – user assigned

EarliestTime

datetime

8

It only holds the time format (hh:mm:ss). The date is not used in this attribute. The reason for this is that it represents the starting time range for a specific date specified by the EarliestDate attribute.

Required – user assigned

LatestDate

datetime

8

This attribute is assigned a specific date value by the user. It only holds the date format (yyyy:mm:dd). Other date formats will also need to be supported and handled by the client applications. The time is not used in this attribute. The reason for this is that it represents the ending date range for when this time window will end.

Both LatestTime and LatestDate cannot be empty.

If the LatestDate is not specified, then the time windows will repeat indefinitely. When specified, it must be greater than or equal to the EarlietDate.

Required  - when the LatestTime Attribute is not empty

 

Required – when the frequency field is set to 0

LatestTime

datetime

8

This attribute is required if the LatestDate attribute was entered. It only holds the time format (hh:mm:ss). The date is not used in this attribute. The reason for this is that it represents the ending time range for a specific date.

This attribute must be greater than the EarliestTime and EarliestDate combination. It is possible to have the time be less than the EarliestTime, but it must be for a future date value.

Required – when the frequency field is set to 0

Frequency

varchar

50

This attribute is assigned a string value that represents different days of the week. This will allow the user to enter specific days of the week when this window is active. More then one day can be entered but they will need to be delimited by a comma or space.

Valid values:

·        ”r; ”r; or null = Everyday

·        1 = Monday

·        2 = Tuesday

·        3 = Wednesday

·        4 = Thursday

·        5 = Friday

·        6 = Saturday

·        7 = Sunday

 

·   A blank or null Frequency value means that all the days of the week are valid including Saturday and Sunday. It is the same as specifying ”r;1, 2, 3, 4, 5, 6, 7”.

·        Mixed multiple values represent different days of the week. They should be specified from lowest to highest. Duplicate values are not allowed.

Default value is ’r;empty’.

 

ProfitFactor

float

 

Portion of the order/activity’s profit that is gained by serving it within the time window. One or blank gains all the profit.

Default value is 0.

 

VariationDuration

int

 

This attribute works in conjunction with the VariationProfit attribute. It is assigned a specific number that represents a duration in seconds. It is used to offset the window ”r;open” and ”r;close” times by this amount without causing violations.

Default value is 0.

 

VariationProfit

float

 

Portion of the order/activity’s profit that is gained by serving it outside the time window but within the VariationDuration.

Range 0.0 to 1.