Attribute Name

Type

Field Size

Description

Required

ActivityWindowID

int

4

Unique internal DB Identifier of the Activity window record.

Required

ActivityID

int

4

Unique internal DB Identifier of the Activity record.

Required

Type

nvarchar

50

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

For example: we can have pickup, drop-off, or pickup/drop-off orders, which may require different FWActivity records created.

Valid Values:

·     DROPOFF – (default value) a drop-off type is create when the order type is drop-off or pickup/drop-off

·     PICKUP - a pickup type is create when the order type is pickup or pickup/drop-off

·     SERVICE – (currently not supported) a service type is create when the order type is service

·     RECHARGE – (currently no supported) a recharge type is create when the order type is recharge

·     BREAK – (currently not supported) a break type is create when the order type is break

Note―  If changed it will not automatically update the associated stops but the activity status attribute is changed to Modified.

Required

EarliestTime

datetime

8

Beginning time for time window

LatestTime

datetime

8

Ending time for time window

EarliestDate

datetime

8

Beginning date for time window X. Values of "ScheduleDate + X and 'Today + X' can be used to create relative dates.

LatestDate

datetime

8

Ending date for time window X. Values of 'ScheduleDate + X' and 'Today + X' can be used to create relative dates.

Frequency

nvarchar

255

Designates which weekdays or dates the item is available to be scheduled. For weekdays, you can use the standard abbreviations, full names, or numbers 1 through 7 corresponding to days Monday through Sunday. Dates may be written as M/D/Y, M-D-Y, MMDDYY, or MMDDYYYY. For example, a setting of ”r;135” schedules the item for Monday, Wednesday and Friday. A setting of ”r;Mon Wed Fri 6/30/1999 7/1/1999” schedules the item for Monday, Wednesday, and Friday and for 6/30/1999 and 7/1/1999.

ProfitFactor

float

8

Portion of the job or task's profit gained by serving it within the time window.

VariationDuration

int

4

A "fudge factor" for time windows. Extends every time window's open and close times by the specified duration.

VariationProfit

float

8

Portion of the task’s profit gained when it is served outside the defined time window, but within the allowed variation. Encourages Optimizer to assign jobs inside the variation if the time window cannot be achieved. For example, a value of 0.75 gives a job served within the variation 75% of its normal profit.

Comment

nvarchar

500

See Comment.

Measure1-9

float

8

The measure amount x to be delivered using this time window.

OpenDateTime

datetime

8

Opening Date/Time of the Time Window

FreeTextFrequency

If the Frequency filed is empty, the FreeTextFrequency field is sent instead to RMPI.

SelectedWindow

boolean

Determines whether the Time Window selected after an optimization was performed.

CloseDateTime

datetime

8

Closing Date/Time of the time window