Rate
Internal Table Name: Rate
Define the detailed rate information used to cost your vehicle routes. You must define at least one rate.
The distance based, time based, fixed and stop cost fields in the Rate table accept either a number or a step cost name. Enter a number for a constant cost. If the cost varies with the distance, stop or time incurred, use a step cost to define the relationship between the value incurred and cost. For example, create a Step Cost Definition such as the following:
Name |
Type |
PerDistance |
Per Distance Cost |
And create the associated Step Cost records:
Name |
Minimum Quantity |
Cost |
PerDistance |
0 |
1.8 |
PerDistance |
300 |
1.5 |
When this step cost is applied to the Per Distance Cost, the first 300 miles are charged at 1.8 per mile and the distance over 300 miles is charged at 1.5 per mile.
Rate ID
Technology: TO
Table: Rate
Internal Name: RateID
Type: Short Text (50)
The identifier of the rate.
Asset
Technology: TO
Table: Rate
Internal Name: TransportationAssetName
Type: Short Text (100)
Provide the asset type ID if the rate applies to a specific asset type.
Source
Technology: TO
Table: Rate
Internal Name: OriginLocationGroupID
Type: Short Text (100)
Used to define the source or group of source locations.
Destination
Technology: TO
Table: Rate
Internal Name: DestinationLocationGroupID
Type: Short Text (100)
Used to define the destination or group of destination locations.
Fixed Cost
Technology: TO
Table: Rate
Internal Name: FixedCost
Type: Short Text (255)
Specifies the fixed charge applied to the route. You can populate the column in one of these ways:
- Enter a numeric cost (such as 125) - In this case, the Fixed Cost is applied to each route that uses this rate.
- Enter a step cost in the format <x1|y1><x2|y2>... - Select the Fixed Cost Basis by which the cost is evaluated. The comma (,) and semi colon (;) are also supported for the value separator.
- Define a Step Cost Definition and Step Costs and select the Step Cost name - The Step Basis in the Step Cost Definition is used. If the Step Basis is Weight, Volume, or Distance, be sure to include the appropriate unit of measure with your Minimum Quantity values. For example, with a Step Basis of Weight, you enter values for Minimum Quantity such as 100 LB.
If you are defining a step cost for the Fixed Cost column in the Rate table and want to use "Stops" or "LongBreaks" as the Fixed Cost Basis, define the value directly in the Fixed Cost column using the format <quantity1|cost1><quanitity2|cost2>.
Default: 0
Fixed Cost Basis
Technology: TO
Table: Rate
Internal Name: FixedCostBasis
Type: Short Text (100)
One of Quantity, Weight, Volume, Distance, Stops or LongBreaks.
Select the basis by which the Fixed Cost is evaluated. The basis is applied in the following ways:
- When you enter a single number, such as 125, the Fixed Cost is applied to each route, regardless of the Fixed Cost Basis.
- When you enter a step cost such as <0|100><1|300><4|800>, the Fixed Cost Basis is applied. The comma (,) and semi colon (;) are also supported for the value separator.
- When you enter a Step Cost name (from Step Cost Definitions), the Step Basis from the Step Cost Definition is applied. In general, when using a Step Cost name, you should leave the Fixed Cost Basis null to avoid any conflict between units of measure.
If you are defining a step cost for the Fixed Cost column in the Rate table and want to use "Stops" or "LongBreaks" as the Fixed Cost Basis, define the value directly in the Fixed Cost column using the format <quantity|,cost1><quanitity2|cost2>.
For example:
Fixed Cost | Fixed Cost Basis | Step Cost Definition | Step Basis | Result |
---|---|---|---|---|
125 | any value | Not applicable | Not applicable | 125 per route |
<0|100><1|300><4,|800> | Stops | Not applicable | Not applicable | 100 for the first stop, 300 up to 4 stops, 800 for greater than 4 stops |
Step Cost Name | null |
0 LB 100 250 LB 300 500 LB 800 |
Weight | 100 for the first 250 lbs, 300 up to 500 lbs, 800 for greater than 500 lbs |
Step Cost Name | Quantity |
0 CFT 100 250 CFT 300 500 CFT 800 |
Volume | 100 for the first 250 cft, 300 up to 500 cft, 800 for greater than 500 cft |
When "Distance" is selected as the Fixed Cost Basis, the total route distance is always used to select the Fixed Cost to be applied from the Step Cost, regardless of the Rate Type defined for the asset.
Default: null
Per Distance Cost
Technology: TO
Table: Rate
Internal Name: PerDistanceCost
Type: Short Text (255)
Specifies the charge per travel distance unit with a loaded asset. Enter a number for a constant Per Distance Cost. If the Per Distance Cost varies with the distance traveled, create a Step Cost Definition such as the following:
Name |
Type |
PerDistance |
Per Distance Cost |
And create the associated Step Cost records:
Name |
Minimum Quantity |
Cost |
PerDistance |
0 |
1.8 |
PerDistance |
300 |
1.5 |
When this step cost is defined, the first 300 miles are charged at 1.8 per mile and the distance over 300 miles is charged at 1.5 per mile.
Default: 0
Per Reposition Distance Cost
Technology: TO
Table: Rate
Internal Name: PerRepositionDistanceCost
Type: Short Text (255)
Specifies the charge per travel distance unit with empty asset (often a repositioning movement). Enter a number for a constant Per Reposition Distance Cost. If the Per Reposition Distance Cost varies with the distance traveled, create a Step Cost Definition such as the following:
Name | Type |
PerReposition | Per Distance Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerReposition | 0 | 1.8 |
PerReposition | 300 | 1.5 |
When this step cost is defined, the first 300 miles are charged at 1.8 per mile and the distance over 300 miles is charged at 1.5 per mile.
Default: 0
Per Distance Out Of Route Cost
Technology: TO
Table: Rate
Internal Name: PerDistanceOutOfRouteCost
Type: Short Text (100)
Specifies the charge per out of route distance unit incurred on the route. Enter a number for a constant Per Distance Out Of Route Cost. If the Per Distance Out Of Route Cost varies with the distance traveled, create a Step Cost Definition such as the following:
Name | Type |
---|---|
OutOfRoute | Per Distance Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
OutOfRoute | 0 | 3.5 |
OutOfRoute | 50 | 3.8 |
When this step cost is defined, the first 50 miles are charged at 3.5 per mile and the distance over 300 miles is charged at 3.8 per mile.
The out of route distance is calculated as follows:
- Direct Distance - from route origin to furthest location on the route = DC -> B
- Total Route Distance = DC -> A -> B -> C -> D
- Out of Route Distance = Total Route Distance - Direct Distance = (DC -> A -> B -> C -> D) - (DC -> B)
- Out of Route Percentage = (Total Route Distance - Direct Distance) / Total Route Distance = ((DC -> A -> B -> C -> D) - (DC -> B)) / (DC -> A -> B -> C -> D)
Duty Time Cost
Technology: TO
Table: Rate
Internal Name: DutyTimeCost
Type: Short Text (255)
Specifies the charge per time unit of on-duty time (including driving, non-drive-working, waiting, and short breaks). Transportation Optimization will use this field to calculate the rate if it is specified. It must be a positive number. In that case, Drive Time Cost, Service Time Cost, Wait Time Cost, and Break Time Cost are ignored. Enter a number for a constant Duty Time Cost. If the Duty Time Cost varies with the number of duty time hours, create a Step Cost Definition such as the following:
Name | Type |
PerDutyTime | Duty Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerDutyTime | 0 HR | 60 |
PerDutyTime | 12 HR | 80 |
When this step cost is defined, this means that the first 12 hours are charged at 60 per hour, and hours more than 12 are 80 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Per Unit Cost
Technology: TO
Table: Rate
Internal Name: PerUnitCost
Type: Short Text (255)
Specifies the cost per unit on the route, as determined by the Unit Cost Basis. Enter a number for a constant Per Unit Cost. If the Per Unit Cost varies with the number of units, create a Step Cost Definition such as the following:
Name | Type |
PerUnitCost | Per Unit Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerUnitCost | 0 | 5 |
PerUnitCost | 300 | 4 |
When this step cost is defined, the first 300 units on the route are charged at 5 per unit and the units over 300 are charged at 4 per unit.
Unit Cost Basis
Technology: TO
Table: Rate
Internal Name: UnitCostBasis
Type: Short Text (100)
Units of measure from one of Quantity, Weight, Volume.
Specifies the basis on which the Per Unit Cost is applied. This is a unit of measure from one of:
- Quantity
- Weight
- Volume
Default: Quantity unit of measure
In Transit Stop Cost
Technology: TO
Table: Rate
Internal Name: PerStopCost
Type: Short Text (255)
Specifies the charge for each in transit stop. Enter a number for a constant Per Stop Cost. If the Per Stop Cost varies with the number of stops, create a Step Cost Definition such as the following:
Name | Type |
PerStop | In Transit Stop Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerStop | 0 | 0 |
PerStop | 1 | 100 |
When this step cost is defined, this means that the first stop is free, and the second stop and later are 100 per stop.
Default: 0
Variable Rest Time Cost
Technology: TO
Table: Rate
Internal Name: BreakTimeCost
Type: Short Text (255)
Specifies the charge per time unit of a long break as defined by Rest Time in the Transportation Assets table. Enter a number for a constant Variable Rest Time Cost. If the Variable Rest Time Cost varies with the number of wait time hours, create a Step Cost Definition such as the following:
Name | Type |
PerVariableOvernight | Variable Rest Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerVariableOvernight | 0 HR | 80 |
PerVariableOvernight | 4 HR | 60 |
When this step cost is defined, this means that the first 4 hours are charged at 80 per hour, and hours more than 4 are 60 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Fixed Rest Time Cost
Technology: TO
Table: Rate
Internal Name: PerLodgeCost
Type: Short Text (255)
Specifies the charge every time an overnight rest is incurred. Enter a number for a constant Fixed Rest Time Cost. If the Fixed Rest Time Cost varies with the number of lodgings, create a Step Cost Definition such as the following:
Name | Type |
PerOvernight | Fixed Rest Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerOvernight | 0 | 100 |
PerOvernight | 2 | 80 |
When this step cost is defined, this means that the first two overnights are charged at 100, and overnights more than 2 are 80 per lodging.
Default: 0
Minimum Cost
Technology: TO
Table: Rate
Internal Name: MinimumCost
Type: Short Text (255)
Specifies the minimum cost that must be incurred per route.
Drive Time Cost
Technology: TO
Table: Rate
Internal Name: DriveTimeCost
Type: Short Text (255)
Specifies the charge time unit of driving. Enter a number for a constant Drive Time Cost. If the Drive Time Cost varies with the number of drive time hours, create a step cost definition. For example, create a Step Cost Definition such as the following:
Name | Type |
PerDriveTime | Drive Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerDriveTime | 0 HR | 60 |
PerDriveTime | 8 HR | 80 |
When this step cost is defined, this means that the first 8 hours are charged at 60 per hour, and hours more than 8 are 80 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Service Time Cost
Technology: TO
Table: Rate
Internal Name: NonDriveWorkTimeCost
Type: Short Text (255)
Specifies the charge per time unit of on-duty time that is not driving or waiting. Examples of service time includes loading and unloading. In addition, time required to charge an electric vehicle battery also incurs Service Time Cost. Enter a number for a constant Service Time Cost. If the Service Time Cost varies with the service time, create a Step Cost Definition such as the following:
Name | Type |
PerUnitCost | Service Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerUnitCost | 0 HR | 60 |
PerUnitCost | 8 HR | 80 |
When this step cost is defined, this means that the first 8 hours are charged at 60 per hour, and hours more than 8 are 80 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Wait Time Cost
Technology: TO
Table: Rate
Internal Name: WaitTimeCost
Type: Short Text (255)
Specifies the charge per time unit of waiting. Enter a number for a constant Wait Time Cost. If the Wait Time Cost varies with the number of wait time hours, create a Step Cost Definition such as the following:
Name | Type |
WaitTimeCost | Wait Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
WaitTimeCost | 0 HR | 60 |
WaitTimeCost | 4 HR | 80 |
this means that the first 4 hours are charged at 60 per hour, and hours more than 4 are 80 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Break Time Cost
Technology: TO
Table: Rate
Internal Name: ShortBreakTimeCost
Type: Short Text (255)
Specifies the charge per time unit of short breaks as defined by Break Time in the Transportation Assets table. Short breaks are calculated if Max Drive Time Before Break and Break Time are both populated. It counts toward duty time. Enter a number for a constant Break Time Cost. If the Break Time Cost varies with the number of wait time hours, create a Step Cost Definition such as the following:
Name | Type |
PerBreak | Break Time Cost |
And create the associated Step Cost records:
Name | Minimum Quantity | Cost |
PerBreak | 0 HR | 80 |
PerBreak | 4 HR | 60 |
When this step cost is defined, this means that the first 4 hours are charged at 80 per hour, and hours more than 4 are 60 per hour. If you want the cost to be based on a different time unit, such as minutes, append the Minimum Quantity value with the required time unit of measure.
Default: 0
Surcharge Per Distance
Technology: TO
Table: Rate
Internal Name: SurchargePerDistance
Type: Short Text (255)
Typically used for full truckload, this is a surcharge that will be applied per distance unit. It is added to the Per Distance Cost and to the Per Reposition Distance Cost.
The actual loaded distance cost = Per Distance Cost + Surcharge Per Distance * (1 + Surcharge Percentage).
The actual reposition distance cost = Per Reposition Distance Cost + Surcharge Per Distance * (1 + Surcharge Percentage).
Default: 0
Surcharge Percentage
Technology: TO
Table: Rate
Internal Name: SurchargePercentage
Type: Short Text (50)
Typically used for full truckload, this is a percentage surcharge that will be applied. 0.02 means 2%. It is added to the Per Distance Cost.
The actual loaded distance cost = Per Distance Cost + Surcharge Per Distance * (1 + Surcharge Percentage).
The actual reposition distance cost = Per Reposition Distance Cost + Surcharge Per Distance * (1 + Surcharge Percentage).
Default: 0
Discount Rate
Technology: TO
Table: Rate
Internal Name: DiscountRate
Type: Short Text (255)
Used to define a discount percentage that is applied to the total charge.
Default: null
Status
Technology: TO
Table: Rate
Internal Name: Status
Type: Short Text (50)
One of Include, Exclude.
Use this field to determine if Transportation Optimization should consider the Rate record.
Default: Include
Last modified: Wednesday May 15, 2024