Attribute Name

Type

Field Size

Description

Required

OrderID

int

4

Unique internal DB Identifier of the Order record.

Required

OrderTaskID

int

4

Unique internal DB Identifier of the Order Task record.

OrderKey

nvarchar

50

Business key to identify the activity this Order refers to.

Required

StopTemplateKey

nvarchar

50

Business key to identify the Stop template this Order refers to. Must exist on the FWStop table.

ScheduleKey

nvarchar

50

Business key to identify the Schedule this Order refers to.

If a value is specified, it must exist on the FWSchedule table. An order with a bad schedule key is rejected.

Default is DefaultSchedule.

CustomerOrder

nvarchar

50

This is a string value representing an external customer order number. The reason it is optional is because most implementations will use the OrderKey value as the unique external customer order number. The reason for another customer order attribute is to support temporary orders or order splitting in the future. This field will provides flexibility and a point of reference back to the original customer order. It can also be used if for some reason the original customer order is not unique and we need to track it as reference.

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.

Company

nvarchar

50

This field is used to specify a specific company name in a multi-company environment.

Name

nvarchar

255

Used for the customer name. It is required because the UI application references this attribute throughout. Typically it is the same as the Location Name, but it can be different if the order was placed by one company and shipped to another.

Type

nvarchar

50

This field is used to identify a different order type that may require a different process.

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

Valid Values:

·     DROPOFF &endash; no origin FWActivity record needs to be created

·     PICKUP &endash; no destination activity needs to be created

·     PICKUP/DROPOFF &endash; both a pickup and destination FWActivity records will need to be created

·     RECHARGE &endash; Reload type job

·     COMPLEX &endash; multi-leg order

Required

PreferredResourceKey

nvarchar

50

This value is used to specify that a specific resource be used whenever possible. This attribute is used in conjunction with the PreferredResourceInd attribute, which is used to force this job on the specific resource.

PreferredResourceInd

bit

1

This value is used to specify when the optimizer must consider the Preferred Resource during the assignment process.

Profit

float

8

This attribute holds the additional profit at the order level that is accumulated with the FWOrderLines, Stop Template and Location table profits whenever the FWActivity record gets created.

Requirements

nvarchar

255

This attribute holds the additional requirements at the order level that is linked with the FWOrdeLines requirements, Stop Template, and Location tables whenever the FWActivity record gets created.

Commodities

nvarchar

255

This attribute holds the additional requirements at the order line level that is linked with the commodities from the Order lines, Stop Template, and Location tables whenever an activity is created.

ServiceDuration

int

4

Rate used to calculate the service duration to service Measure x units. Specified in units/second.

PreServiceDuration

int

4

This attribute is used mostly to model parking time at each stop, but users can include other activity times spent before performing customer’s jobs or using a depot. When it’s used to model parking time, it differentiates between situations with easy parking and difficult parking. For example, parking at a downtown office building usually takes longer than parking in an office park.

PUServiceDuration

int

4

Used in Double ended orders. This field indicates the ServiceDuration at the Pickup location. This number will be added to the total ServiceDuration of the FWActivity ServiceDuration field.

PUPreServiceDuration

int

4

Used in Double ended orders. This field indicates the PreServiceDuration at the Pickup location. This number will be added to the total PreServiceDuration of the FWActivity PreServiceDuration field.

DeliveryServiceDuration

float

8

Used in Double ended orders. This field indicates the ServiceDuration at the Delivery location. This number will be added to the total ServiceDuration of the FWActivity ServiceDuration field.

DeliveryPreServiceDuration

float

8

Used in Double ended orders. This field indicates the PreServiceDuration at the Delivery location. This number will be added to the total PreServiceDuration of the FWActivity PreServiceDuration field.

DeliveryPostServiceDuration

float

8

Used in Double ended orders. This field indicates the PostServiceDuration at the Delivery location. This number will be added to the total PostServiceDuration of the FWActivity PostServiceDuration field.

Status

nvarchar

255

Execution Status

RestrictPreferredResource

bit

1

Designates whether or not this order should be restricted to a PreferredResource Key value when optimizing or planning.

MasterRoute

bit

1

Designates if this Order is a Master Route Order or not.

OrginalOrderKey

nvarchar

50

Designates the original order key that was used to generate this Order record (when splitting or creating itineraries or rescheduling this order)

ScheduleID

int

4

Designates the Schedule ID to which this order belongs to.

RequirementSetID

int

4

The Requirement Set ID from FWRequirementSet table.

UDFString1-9

nvarchar

500

User Defined Fields for Strings 1...9

UDFInteger1-3

int

4

User Defined Fields for integers 1..3

UDFNumber1-3

float

8

User Defined fields for numbers 1&ldots;3

ItineraryOrderType

int

4

Designates if this order is an itinerary Order type

UnplannedInd

bit

4

Index to identify Unplanned Orders.

UDFDateTime

nvarchar

User-defined date/time fields

UDFURL1-3

nvarchar

500

User-defined URL fields

ExtDocControlID

nvarchar

50

User’s business document ID

OrderState

int

4

1 for order from order split

2 for order from cloned

3 for order from rescheduled

OrigPreferredResourceKey

nvarchar

50

Stores the original value of preferredResourceKey.  in an unlocking of a route event, this value is used to reset PreferredResourceKey

OrigPreferredResourceInd

bit

1

Stores the original value of PreferredResourceInd.  in an unlocking of a route event, this value will be used to reset PreferredResourceInd

OrigRestrictPreferredResource

bit

1

Stores the original value of RestrictPreferredResource. In the unlocking of a route event, this value is used to reset RestrictPreferredResource

Version

nvarchar

64

Order version number.  Route Planner will not update an order if the version is the same or older by string comparison

BOLNumber

nvarchar

128

BOL number

TMLoadNumber

nvarchar

64

Load number from Descartes Transpotarion management Module.  It is used as indicator that the order is tendered from TM

TMBestContractName

nvarchar

128

The contract name of best rate

TMBestCarrierCode

nvarchar

16

The carrier code of best rate

TMBestTotalCost

float

8

The total cost of best contract

TMSelContractName

nvarchar

128

The contract name of selected rate

TMSelCarrierCode

nvarchar

16

The carrier code of selected rate

TMSelTotalCost

float

8

The total cost of selected contract

FreightAllowance

Represents the least expensive value between carrier and vendor costs.

RescheduledInd

bit

1

Designates if this order has been rescheduled