Contract and Rate Management

Rate Basis Items (RBIs)

This page is accessed via Contract and Rate Management > Contract Management > Rate Record. Then select the Rate Costs tab. Click Add a Cost. Then click the drop down arrow for Basis.

Naming Conventions

A rate basis item is a piece of data from a shipment such as total weight, total volume, distance traveled, number of stops, etc.

It is also a description of how to retrieve aggregate shipment data, such as the order release reference number or the packaged item ID from a ship unit picked up at the source. Aggregate objects are accessed in a loop.

Basically, everything starts with the shipment; from there, to the related object to get the detail.

SELECT

Sometimes you might need a simple sub-total for a condition or a cost. For example, you need to charge a cost, but only if the shipment has more than 10 ship units whose total weight is more than 50 pounds. For this a SELECT operator is used. The SELECT operator tells the rating engine to run it's main loop multiple times. Each object that fails the condition is excluded from the next run of the main loop. A select RBI, for example 'Shipment SELECT Weight', only totals up using sub-objects that were not excluded by the previous condition.

Conditional Example with Select:

The 'select' functionality for conditional RBIs can be useful in limited circumstances. For example, you may have a rate that is conditional on a conditional subset of shipment information. You may want to charge a penalty cost if the total weight of the ship units being picked up at a particular stop is greater than a certain amount. You would set the cost up as follows:

Conditional:

STOP LOCATION ID = 'MYLOCATION'

AND 'Stop Activity' = 'P'

SELECT 'Shipment SELECT Weight' >= 1000 LB

Charge:

$495 per SHIPMENT

The SELECT logical operator instructs the rating engine to perform multiple loops through the shipment data. In this case, it performs a loop through the ship units by stops, and marks all of the picked-up ship units at the stop 'MYLOCATION' as being included in the result set. Then, the rating engine loops through the shipment data again, this time using the 'Shipment SELECT Weight' RBI, which calculates the shipment total weight based on only the ship units included in the selected result set.

Suppose you have two shipments:

Shipment 1

Shipment 2

Pick up from MYLOCATION

                Ship Unit 1 = 500 lbs.

                Ship Unit 2 = 300 lbs.

Pick up from YOURLOCATION

                Ship Unit 3 = 400 lbs.

                Ship Unit 4 = 100 lbs.

Deliver all four ship units to DELIVERYLOCATION

Pick up from MYLOCATION

                Ship Unit 1 = 500 lbs.

                Ship Unit 2 = 500 lbs.

Pick up from YOURLOCATION

                Ship Unit 3 = 400 lbs.

                Ship Unit 4 = 100 lbs.

Deliver all four ship units to DELIVERYLOCATION

 

Shipment 1 would not incur the $495 shipment charge because the SELECT function will sum only the ship units being picked up from location MYLOCATION for evaluation. Although the entire shipment carries 1300 lbs., the weight being picked up at MYLOCATION is only 800 lbs., which is less than the 1000 lbs. specified by the condition.

By contrast, Shipment 2 would incur the $495 shipment charge because the sum of the ship units at location MYLOCATION is 1,000 lbs., which satisfies the specified condition.

Rate Basis Items

Following is the list of RBIs. Type refers to from where the RBI can be selected. "Conditional" means it is available to be selected as a rate basis item in the "Conditions" section of a rate cost. "Charge" means it is available to be selected as a rate basis item in the "Charge" section of a rate cost and "Both" means it is available to be selected as a rate basis item in both the"Conditional" and "Charge" sections of a rate cost.

Starting in 6.1, we list the version to which new RBIs were added. The ones noted with 6.1* were ported forward from an earlier version.

Note: RBIs related to time, such as SHIPMENT TOTAL TRANSIT TIME, can only be used for rate services with a rate service type of Simulation.

Note: Declared value RBIs such as 'Destination Declared Value' and 'Line Item Declared Value', cannot be allocated to a shipment when the order is split. The declared value can only be computed when orders are consolidated into a single shipment.

The glog.business.rate.ratedistance.failRateOnInvalidDistance property determines if OTM will still rate a shipment even if RBIs driven by distance fail.

RBI Name

Type

New in Version

Description

Buy Shipment Allocated Cost Accessorial Code

Conditional

 

Accessorial code of the allocated planned cost corresponding to an order of the Shipment.

Buy Shipment Allocated Cost Charge Amount

Both

 

Allocated planned cost amount corresponding to an order of the Shipment

Buy Shipment Allocated Cost Record

Charge

 

Allocated planned cost record of the shipment

Buy Shipment Allocated Cost Type

Conditional

 

Cost type of the allocated planned cost corresponding to an order of the Shipment.

Destination Ship Unit Line Item Commercial Invoice Value

Both

 

The amount of the commercial invoice of an order release line corresponding to the shipment ship unit line of a ship unit at the destination stop of the shipment.

Dest Ship Unit Total Commercial Invoice Value

Both

 

The sum of commercial invoice amounts of each of the order release lines corresponding to the shipment ship unit lines of ship units at the destination stop of a shipment.

Destination Activities

Charge

 

For all the activities at the destination stop

Destination Activity (activities associated with the Ship Unit at this Stop (pickup = P, drop-off = D))

Conditional

 

Activity of destination stop ship unit

Destination Actual Arrival Time

Conditional

 

Actual arrival time at the shipment destination stop.

Destination Actual Departure Time

Conditional

 

Actual departure time at the shipment destination stop.

Destination Address Lines

Charge

6.2

A collection of destination address lines.

Destination Address Line Value

Conditional

6.2

The value of each destination address line.

Destination Aggregate Density (aggregate density calculated by total weight / total volume)

Both

 

Density is calculated by dividing total weight of all the ship units of destination stop by total volume of all the ship units of destination stop

Destination Aggregate Net Density (aggregate density calculated by net weight / net volume)

Both

 

Density is calculated by dividing total net weight of all the ship units of destination stop by total net volume of all the ship units of destination stop

Destination Arbitrary Distance

Both

 

Destination arbitrary distance travelled.

Destination Best Determined Arrival Time

Conditional

 

Returns the time on the shipment stop from the following look up order : Actual Arrival Time, Estimated Arrival Time, Planned Arrival Time, Start Time, Earliest Possible Start time for the destination shipment stop

Destination Best Determined Departure Time

Conditional

 

Returns the time on the shipment stop from the following look up order: Actual Departure Time, Estimated Departure Time, Planned Departure Time, End Time, Latest Possible End time for the destination shipment stop

Destination City

Conditional

 

Destination City

Destination Count of Location Reference Numbers

Both

6.3

Total number of reference numbers present on the location, by unit. For example: charge xx for every xx reference numbers present on the destination location.

Destination Country

Conditional

 

Destination Country

Destination Delivery Appointment Date Conditional 23C Indicates the destination delivery appointment date on a shipment.

Destination Declared Value

Both

 

The sum of declared values of the ship units at the Destination Stop. Declared value of a ship unit is the declared value defined multiplied by ship unit count. We assume declared value is defined per ship unit.

Destination Distance to the Previous Stop (if any)

Both

 

The distance from the previous stop calculated using the rate distance assigned to the rate offering.

Destination Drive Time (duration spent driving to the destination from this stop)

Both

 

The transit time present on the destination stop. If not present, OTM will estimate the time using the rate service and the distance from previous stop.

Destination Equipment Reference Unit ID

Conditional

6.1

Equipment Reference Unit ID defined in the destination stop ship unit

Destination Equipment Reference Unit Usage Count

Both

6.1

Equipment Reference Unit usage count at this destination stop

Destination Equipment Reference Units (list of Equipment Reference Unit usage counts at this stop)

Charge

6.1

For all the Equipment Reference Units used at the destination.

Destination Estimated Arrival Time

Conditional

 

Estimated arrival time of shipment destination stop

Destination Estimated Departure Time

Conditional

 

Estimated departure time of shipment destination stop

Destination Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

The straight line distance from the pickup to drop-off is calculated for a line item of ship unit at the destination stop using the rate distance assigned to the rate offering.

Destination Location ID

Conditional

 

Destination Location ID

Destination Location Reference Number Qualifier

Conditional

6.3

Used as a conditional to test the presence of a certain reference number qualifier on the destination location.

Destination Location Reference Number Value

Conditional

6.3

Used as a conditional to determine whether the destination location has a reference number equal to a certain value.

Destination Location Reference Number Value as a Number

Both

6.3

Uses the reference number value of the destination location as a multiplier against the charge amount.

Destination Location Reference Number Value as Currency

Both

6.3

Uses the reference number value of the destination location as the cost. The charge amount field is dynamically removed from the charge basis when this rate basis item is selected.

Destination Location Reference Number Value as Distance

Both

6.3

The reference number value assumed to be specified in the default storage unit of measure for distance.

Destination Location Reference Number Value as Duration

Both

6.3

Converts the reference number value of the destination location to a duration value using the specified unit of time. This value is used as a multiplier against the charge amount.

Destination Location Reference Number Value as Volume

Both

6.3

Converts the reference number value of the destination location to a volumetric value using the specified unit of volume. This value is used as a multiplier against the charge amount.

Destination Location Reference Number Value as Weight

Both

6.3

Converts the reference number value of the destination location to a weight value using the specified unit of weight. This value is used as a multiplier against the charge amount.

Destination Location Reference Numbers

Charge

6.3

Per destination location reference number. For example, charge xx for every instance of this reference number.

Destination Pickup Appointment Date Conditional 23C Indicates the destination pickup appointment date on a shipment.

Destination Net Volume

Both

 

The sum of net volume of all destination stop’s ship units. The net volume of each ship unit is unit net volume multiplied with respective unit count

Destination Net Weight

Both

 

 

Destination Stop Number (if 1 then origin, if equals number of stops then destination)

Both

 

 

Destination Number of Activities that Occurred at this Stop

Both

 

 

Destination Number of Address Lines

Both

6.2

The count of destination address lines.

Destination Number of Ship Units at this Stop

Both

 

 

Destination Planned Arrival Time

Conditional

 

 

Destination Planned Departure Time

Conditional

 

 

Destination Postal (zip) Code

Conditional

 

 

Destination Province  (state) Code

Conditional

 

 

Destination Region (restricted by region group assigned to rate offering, if it exists)

Conditional

 

Region ID gets evaluated based on the region defined in region group and assigned to rate offering or destination shipment stop

Destination Rest Time (duration spent resting at the stop)

Both

 

 

Destination SELECTed Declared Value

Both

 

 

Destination SELECTed Density (aggregate density calculated by
selected weight / selected volume)

Both

 

 

Destination SELECTed Dimensional Weight

Both

 

 

Destination SELECTed Net Density (sel_netweight / sel_netvolume)

Both

 

 

Destination SELECTed Net Volume

Both

 

 

Destination SELECTed Net Weight

Both

 

 

Destination SELECTed Total Ship Unit Count

Both

 

 

Destination SELECTed Volume

Both

 

 

Destination SELECTed Weight

Both

 

 

Destination Ship Unit Chargeable Weight Both    

Destination Ship Unit Density

Both

 

 

Destination Ship Unit Destination Location

Conditional

 

 

Destination Ship Unit Dimensional Volume

Both

6.1*

 

Destination Ship Unit Distance Traveled

Both

6.1*

 

Destination Ship Unit Early Pickup Date

Conditional

 

 

Destination Ship Unit Equipment Group ID

Conditional

 

 

Destination Ship Unit Flex Commodity Qualifier

Conditional

 

 

Destination Ship Unit Is Splittable

Conditional

 

 

Destination Ship Unit Item Package Count

Both

 

 

Destination Ship Unit Line Item Commodity Code

Conditional

 

 

Destination Ship Unit Line Item Declared Value

Both

 

 

Destination Ship Unit Line Item Density

Both

 

 

Destination Ship Unit Line Item Dimensional Volume

Both

6.1*

 

Destination Ship Unit Line Item Dimensional Weight

Both

 

 

Destination Ship Unit Line Item Distance Traveled

Both

6.1*

 

Destination Ship Unit Line Item Hazmat Item ID

Conditional

 

 

Destination Ship Unit Line Item HTS

Conditional

 

 

Destination Ship Unit Line Item ID

Conditional

 

 

Destination Ship Unit Line Item NMFC Article at the Stop

Conditional

 

 

Destination Ship Unit Line Item NMFC Class

Conditional

 

 

Destination Ship Unit Line Item Package Count

Both

 

 

Destination Ship Unit Line Item Package Specification ID

Conditional

 

 

Destination Ship Unit Line Item Packaged Item ID

Conditional

 

 

Destination Ship Unit Line Item SITC

Conditional

 

 

Destination Ship Unit Line Item STCC

Conditional

 

 

Destination Ship Unit Line Item User-defined Commodity Code

Conditional

 

 

Destination Ship Unit Line Item Volume

Both

 

 

Destination Ship Unit Line Item Weight

Both

 

 

Destination Ship Unit Line Items

Charge

 

 

Destination Ship Unit Line Weight, Rounded

Both

 

 

Destination Ship Unit Line Weight, Rounded Down

Both

 

 

Destination Ship Unit Line Weight, Rounded Up

Both

 

 

Destination Ship Unit Net Density

Both

 

 

Destination Ship Unit Net Volume 

Both

 

 

Destination Ship Unit Net Weight

Both

 

 

Destination Ship Unit Number of Line Items (in ship unit)

Both

 

 

Destination Ship Unit Order Base Ship Unit ID (at the stop)

Conditional

 

 

Destination Ship Unit SELECTed Declared Value

Both

 

 

Destination Ship unit SELECTed Density

Both

 

 

Destination Ship Unit SELECTed Dimensional Weight

Both

 

 

Destination Ship unit SELECTed Net Density

Both

 

 

Destination Ship Unit SELECTed Net Volume

Both

 

 

Destination Ship Unit SELECTed Net Weight

Both

 

 

Destination Ship Unit SELECTed Total of Ship Units

Both

 

 

Destination Ship Unit SELECTed Volume

Both

 

 

Destination Ship Unit SELECTed Weight

Both

 

 

Destination Ship Unit Source Location

Conditional

 

 

Destination Ship Unit Specification ID

Conditional

 

 

Destination Ship Unit Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Destination Ship Unit Total Declared Value

Both

 

 

Destination Ship Unit Weight, Rounded

Both

 

 

Destination Ship Unit Weight, Rounded Down

Both

 

 

Destination Ship Unit Weight, Rounded Up

Both

 

 

Destination Ship Unit, Line Item Weight Per Package

Both

 

 

Destination Ship Unit, Unit Height

Both

 

 

Destination Ship Unit, Unit Length

Both

 

 

Destination Ship Unit, Unit Volume

Both

 

 

Destination Ship Unit, Unit Weight

Both

 

 

Destination Ship Unit, Unit Width

Both

 

 

Destination Ship Units (list of ship units)

Charge

 

 

Destination Source Distance (distance to the source stop)

Both

 

The distance from the destination stop to the source stop calculated using the rate distance assigned to the rate offering.

Destination Straight Line Distance to the Source Stop

Both

6.1*

 

Destination Total Activity Time

Both

 

Activity time defined in destination shipment stop.

This RBI can be used in Oracle Transportation Sourcing rate records.

Destination Total Chargeable Weight of Ship Units at this Stop

Both    

Destination Total Dimensional Volume of Ship Units at this Stop

Both

6.1*

 

Destination Total Equipment Reference Unit Usage Count

Both

6.1*

The sum of Total ERU Usage Count at this destination stop.

This RBI can be used in Oracle Transportation Sourcing rate records.

Destination Total Volume

Both

 

 

Destination Total Weight

Both

 

The sum of unit weight of all destination stop's ship units. The unit weight of each ship unit is unit weight multiplied with respective unit count

Destination Total Weight, Rounded

Both

 

The sum of unit weight of all destination stop's ship units and result values is rounded to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count

Destination Total Weight, Rounded Down

Both

 

The sum of unit weight of all destination stop's ship units and result values is rounded down to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count

Destination Total Weight, Rounded Up

Both

 

The sum of unit weight of all destination stop's ship units and result values is rounded up to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count

Destination Wait Time (duration spent waiting at stop)

Both

 

 

Driver Accumulated Idle Time

Both

6.1

 

Driver Distance from Calendar Event

Both

6.1

 

Driver Distance from Home

Both

 

The distance from a driver's current location (based on the latest NAT/NAL) and the driver's home location. The home location is uses the work profile home location unless there is not one in which case it uses the default home location for a driver.

Driver Idle Time from Previous Assignment

Both

 

 

Driver Is Team Driven

Conditional

 

 

Driver Location Preference Factor

Both

 

Average preference factor is the quotient of sum of preference factor for all the locations of different stops of the shipment divided by the number of locations.

Driver Night Driving Preference Factor

Both

 

 

Driver Special Services

Conditional

6.1

 

Driver Special Services Used

Conditional

6.1

 

Driver Time from Calendar Event

Both

6.1

 

Driver Time from Home

Both

 

 

Duration between Driver and Shipment End Time

Both

6.3

This RBI calculates the duration between the driver's shift end time and the shipment's end time (shipment end time - driver end time). In cases where no driver is assigned to the shipment or the driver does not have a calendar associated it, the system returns a null value.

Note: When using this RBI, the Recalculate Cost check box should be selected on the rate offering.  Failure to do so could result in some bad cost calculations (potentially some negative costs).

Equipment

Charge

 

Per equipment

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Equipment Chargeable Weight

Both    

Equipment Compartment Count

Both

6.2

Number of compartments in a piece of equipment (e.g. rail car).

Equipment Currency Flex Field Value

Both

6.4.2

 The equipment flex field value is currency.

Equipment Date Flex Field Value

Conditional

6.4.2

The equipment flex field value is date.

Equipment Declared Value

Both

 

 

Equipment Density (aggregate density calculated by total weight / total volume)

Both

 

 

Equipment Dimensional Volume

Both

6.1*

 

Equipment Effective Volume

Both

6.3.2

Effective volume of equipment as specified by the associated equipment group.

Equipment Effective Weight

Both

6.3.2

Effective weight of equipment as specified by the associated equipment group.

Equipment Flex Attribute (1-20)

Conditional

6.3.2

Value of the database field attribute of the associated equipment group.

For example, Equipment Flex Attribute 1would have the value of the database field attribute1 of the associated equipment group.

Equipment Flex Field Qualifier

Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the equipment flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to equipment string flex fields (Equipment String Flex Field value as Duration, Currency, Volume and so on).

 

Equipment Group ID

Conditional

 

 

Equipment Group Type ID

Conditional

 

 

Equipment Height

Both

6.3.2

Height of equipment as specified by the associated equipment group.

Equipment Item Package Count

Both

 

 

Equipment Length

Both

 

 

Equipment Loaded Compartment Count

Both

6.2

Number of loaded compartments in a piece of equipment.

Equipment Loading Length

Both

6.1

 

Equipment Number Flex Field Value

Both

6.4.2

The equipment number flex field value is number.

Equipment Number Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Equipment Number Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Equipment Number Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Equipment Number Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Equipment Number Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Equipment Number of Ship Units

Both

 

 

Equipment Selected Density (aggregate density calculated by selected
weight / selected volume)

Both

 

 

Equipment Ship Unit

Charge

 

 

Equipment Ship Unit Chargeable Weight

Both 6.1*  

Equipment Ship Unit Density

Both

 

 

Equipment Ship Unit Destination Location

Conditional

 

 

Equipment Ship Unit Dimensional Volume

Both

6.1*

 

Equipment Ship Unit Distance Traveled

Both

 

 

Equipment Ship Unit Early Pickup Date

Conditional

 

 

Equipment Ship Unit Flex Commodity Qualifier

Conditional

 

 

Equipment Ship Unit Is Splittable

Conditional

 

 

Equipment Ship Unit Line Item

Charge

 

 

Equipment Ship Unit Line Item Commercial Invoice Value

Both

 

 

Equipment Ship Unit Line Item Commodity Code

Conditional

 

 

Equipment Ship Unit Line Item Declared Value

Both

 

 

Equipment Ship Unit Line Item Density

Both

 

 

Equipment Ship Unit Line Item Dimensional Volume

Both

6.1*

 

Equipment Ship Unit Line Item Dimensional Weight

Both

 

 

Equipment Ship Unit Line Item Distance Traveled

Both

6.1*

 

Equipment Ship Unit Line Item Hazardous

Conditional

 

 

Equipment Ship Unit Line Item Hazmat Item ID

Conditional

 

 

Equipment Ship Unit Line Item HTS

Conditional

 

 

Equipment Ship Unit Line Item ID

Conditional

 

 

Equipment Ship Unit Line Item IMO Class (Hazardous Classification ID)

Conditional

 

 

Equipment Ship Unit Line Item NMFC Article

Conditional

 

 

Equipment Ship Unit Line Item NMFC Class

Conditional

 

 

Equipment Ship Unit Line Item Package Count

Both

 

The sum of item package counts of all ship unit lines in the given equipment. The item package count is calculated by multiplying the item package count on the ship unit line by the ship unit count.

Equipment Ship Unit Line Item Package Specification ID

Conditional

 

 

Equipment Ship Unit Line Item Packaged Item ID

Conditional

 

 

Equipment Ship Unit Line Item PSA Class (PSA Singapore Group)

Conditional

 

 

Equipment Ship Unit Line Item SITC

Conditional

 

 

Equipment Ship Unit Line Item STCC

Conditional

 

 

Equipment Ship Unit Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Equipment Ship Unit Line Item User-defined Commodity Code

Conditional

 

 

Equipment Ship Unit Line Item Volume

Both

 

 

Equipment Ship Unit Line Item Weight

Both

 

 

Equipment Ship Unit Line Item Weight Per Package

Both

 

 

Equipment Ship Unit Line Weight, Rounded

Both

 

 

Equipment Ship Unit Line Weight, Rounded Down

Both

 

 

Equipment Ship Unit Line Weight, Rounded Up

Both

 

 

Equipment Ship Unit Net Density

Both

 

 

Equipment Ship Unit Net Volume

Both

 

 

Equipment Ship Unit Net Weight

Both

 

 

Equipment Ship Unit Order Base, Ship Unit ID

Conditional

 

 

Equipment Ship Unit SELECT Declared Value

Both

 

 

Equipment Ship Unit SELECT Dimensional Weight

Both

 

 

Equipment Ship Unit SELECT Net Volume

Both

 

 

Equipment Ship Unit SELECT Net Weight

Both

 

 

Equipment Ship Unit SELECT Total of Line Items

Both

 

 

Equipment Ship Unit SELECT Volume

Both

 

 

Equipment Ship Unit SELECT Weight

Both

 

 

Equipment Ship Unit Selected Density

Both

 

 

Equipment Ship Unit Selected Net Density

Both

 

 

Equipment Ship Unit Source Location

Conditional

 

 

Equipment Ship Unit Specification ID

Conditional

 

 

Equipment Ship Unit Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Equipment Ship Unit Total Commercial Invoice Value

Both

 

 

Equipment Ship Unit Total Declared Value

Both

 

The sum of the declared value of all ship units in the given equipment. The declared value is calculated by multiplying the declared value on the ship unit by the ship unit count.

Equipment Ship Unit Total of Line Items

Both

 

 

Equipment Ship Unit Weight, Rounded

Both

 

 

Equipment Ship Unit Weight, Rounded Down

Both

 

 

Equipment Ship Unit Weight, Rounded Up

Both

 

 

Equipment Ship Unit, Unit Height

Both

 

 

Equipment Ship Unit, Unit Length

Both

 

 

Equipment Ship Unit, Unit Volume

Both

 

 

Equipment Ship Unit, Unit Weight

Both

 

 

Equipment Ship Unit, Unit Width

Both

 

 

Equipment Shipment Total Item Package Count

Both

 

 

Equipment Special Services

Conditional

6.1

 

Equipment Special Services Used

Conditional

6.1

 

Equipment String Flex Field Value

Both

6.4.2

 

The equipment string flex field value is string.

 

Equipment String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Equipment String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve equipments based on dates.   

Equipment String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Equipment String Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the string flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Equipment String Flex Field Value as a Number

Both

6.4.2

Converts the flex field value as number and uses the value as a multiplier against the charge amount.

Equipment String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Equipment String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Equipment Total Commercial Invoice Value

Both

 

 

Equipment Total FEU Equivalent Count

Both

 

 

Equipment Total Freight Volume

Both

 

 

Equipment Total TEU Equivalent Count

Both

 

 

Equipment Weight

Both

 

 

Equipment Weight, Rounded

Both

 

 

Equipment Weight, Rounded Down

Both

 

 

Equipment Weight, Rounded Up

Both

 

 

Equipment Width

Both

6.3.2

Width of equipment as specified by the associated equipment group.

Job

Charge

 

Note: All the job rate basis items are intended for Non-Freight Related Charges.

Job Currency Flex Field Value

Both

6.4.2

The job currency flex field value is currency.

Job Date Flex Field Value

Conditional

6.4.2

The job date flex field value is date.

Job Flex Field Qualifier

 Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the job flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to job string flex fields (Job String Flex Field value as Duration, Currency, Volume and so on).

 

Job Number Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Job Number Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Job Number Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the string flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Job Number Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Job Number Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Job Number of Orders

Both

 

 

Job Number of Primary Buy Shipments

Both

 

 

Job Number of Primary Sell Shipments

Both

 

 

Job Primary Buy Shipment Cost Accessorial Code (for costs of type A)

Conditional

 

 

Job Primary Buy Shipment Cost Charge Amount

Both

 

 

Job Primary Buy Shipment Cost Payment Method Code GID

Conditional

 

 

Job Primary Buy Shipment Cost Record

Charge

 

 

Job Primary Buy Shipment Cost Special Service Arbitrary

Conditional

 

 

Job Primary Buy Shipment Cost Special Service GID (for some costs of
type A)

Conditional

 

 

Job Primary Buy Shipment Cost Type (base = B, accessorial = A,
discount = D, circuity = C, etc.)

Conditional

 

 

Job Primary Buy Shipment Destination Region

Conditional

 

 

Job Primary Buy Shipment Destination Stop

Charge

 

 

Job Primary Buy Shipment Equipment

Charge

 

 

Job Primary Buy Shipment Equipment Chargeable Weight

Both    

Job Primary Buy Shipment Equipment Dimensional Volume

Both

6.1*

 

Job Primary Buy Shipment Equipment Group ID

Conditional

 

 

Job Primary Buy Shipment Equipment Ship Unit

Charge

 

 

Job Primary Buy Shipment Equipment Ship Unit Dimensional Volume

Both

6.1*

 

Job Primary Buy Shipment Equipment Ship Unit Dimensional Weight

Both

 

 

Job Primary Buy Shipment Equipment Ship Unit, Unit Volume

Both

 

 

Job Primary Buy Shipment Equipment Ship Unit, Unit Weight

Both

 

 

Job Primary Buy Shipment Equipment Total Freight Volume

Both

 

 

Job Primary Buy Shipment Equipment Weight

Both

 

 

Job Primary Buy Shipment Number of Costs Applied from Rating

Both

 

 

Job Primary Buy Shipment Ship Unit

Charge

 

 

Job Primary Buy Shipment Ship Unit Chargeable Weight

Both    

Job Primary Buy Shipment Ship Unit Dimensional Volume

Both

 

 

Job Primary Buy Shipment Ship Unit Line Item Commercial Invoice Value

Both

 

 

Job Primary Buy Shipment Ship Unit Line Items

Charge

 

 

Job Primary Buy Shipment Ship Unit Number of Line Items (in ship unit)

Both

 

 

Job Primary Buy Shipment Ship Unit Total Commercial Invoice Value

Both

 

 

Job Primary Buy Shipment Ship Unit Volume

Both

 

 

Job Primary Buy Shipment Ship Unit Weight

Both

 

 

Job Primary Buy Shipment Total Number of Ship Units

Both

 

 

Job Primary Buy Shipment Total Pieces of Equipment

Both

 

 

Job Primary Buy Shipment Total Volume

Both

 

 

Job Primary Buy Shipment Total Weight

Both

 

 

Job Primary Buy Shipment Source Region

Conditional

 

 

Job Primary Buy Shipment Source Stop

Charge

 

 

Job Primary Buy Shipment Total Chargeable Weight

Both 6.1* The sum of the total chargeable weight of all ship units associated with the shipment.

Job Primary Buy Shipment Total Commercial Invoice Value

Both

 

 

Job Primary Buy Shipment Total Dimensional Volume

Both

6.1*

 

Job Primary Buy Shipment Total FEU Equivalent Count

Both

 

 

Job Primary Buy Shipment Total TEU Equivalent Count

Both

 

 

Job Primary Buy Shipments

Charge

 

 

Job Primary Sell Shipment Cost Accessorial Code (for costs of type A)

Conditional

 

 

Job Primary Sell Shipment Cost Charge Amount

Both

 

 

Job Primary Sell Shipment Cost Payment Method Code GID

Conditional

 

 

Job Primary Sell Shipment Cost Record

Charge

 

 

Job Primary Sell Shipment Cost Special Service Arbitrary

Conditional

 

 

Job Primary Sell Shipment Cost Special Service GID (for some costs of type A)

Conditional

 

 

Job Primary Sell Shipment Cost Type (base = B, accessorial = A, discount = D, circuity = C, etc.)

Conditional

 

 

Job Primary Sell Shipment Destination Region

Conditional

 

 

Job Primary Sell Shipment Destination Stop

Charge

 

 

Job Primary Sell Shipment Equipment

Charge

 

Per equipment.

Job Primary Sell Shipment Equipment Dimensional Volume

Both

6.1*

 

Job Primary Sell Shipment Equipment Dimensional Weight

Both

 

The dimensional weight of equipment.

  • Dimensional Weight of Equipment = total volume of equipment * Dim Factor. If 0, Total Weight of Equipment).
  • Total Weight of Equipment = SUM (total gross weight of each ship unit associated with equipment).
  • Total Volume of Equipment = SUM (volume of each equipment compartment).

Job Primary Sell Shipment Equipment Group ID

Conditional

 

 

Job Primary Sell Shipment Equipment Ship Unit

Charge

 

 

Job Primary Sell Shipment Equipment Ship Unit Dimensional Volume

Both

6.1*

 

Job Primary Sell Shipment Equipment Ship Unit Dimensional Weight

Both

 

 

Job Primary Sell Shipment Equipment Ship Unit, Unit Volume

Both

 

 

Job Primary Sell Shipment Equipment Ship Unit, Unit Weight

Both

 

 

Job Primary Sell Shipment Equipment Total Freight Volume

Both

 

 

Job Primary Sell Shipment Equipment Weight

Both

 

 

Job Primary Sell Shipment Number of Costs Applied from Rating

Both

 

 

Job Primary Sell Shipment Ship Unit

Charge

 

 

Job Primary Sell Shipment Ship Unit Chargeable Weight

Both    

Job Primary Sell Shipment Ship Unit Dimensional Volume

Both

6.1*

 

Job Primary Sell Shipment Ship Unit Line Item Commercial Invoice Value

Both

 

 

Job Primary Sell Shipment Ship Unit Line Items

Charge

 

 

Job Primary Sell Shipment Ship Unit Number of Line Items (in ship unit)

Both

 

 

Job Primary Sell Shipment Ship Unit Total Commercial Invoice Value

Both

 

 

Job Primary Sell Shipment Ship Unit Volume

Both

 

 

Job Primary Sell Shipment Ship Unit Weight

Both

 

 

Job Primary Sell Shipment Total Number of Ship Units

Both

 

 

Job Primary Sell Shipment Total Pieces of Equipment

Both

 

 

Job Primary Sell Shipment Total Volume

Both

 

 

Job Primary Sell Shipment Total Weight

Both

 

 

Job Primary Sell Shipment Source Region

Conditional

 

 

Job Primary Sell Shipment Source Stop

Charge

 

 

Job Primary Sell Shipment Total Chargeable Weight

Both 6.1*  

Job Primary Sell Shipment Total Commercial Invoice Value

Both

 

 

Job Primary Sell Shipment Total Dimensional Volume

Both

6.1*

 

Job Primary Sell Shipment Total FEU Equivalent Count

Both

 

 

Job Primary Sell Shipment Total TEU Equivalent Count

Both

 

 

Job Primary Sell Shipments

Charge

 

Per sell shipment.

Job String Flex Field Value

Both

6.4.2

The job string flex field value is date.

Job String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Job String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve jobs based on dates.   

Job String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Job String Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the string flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Job String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Job String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Line Item

Charge

 

 

Line Item Commercial Invoice Value

Both

 

 

Line Item Commodity Code

Conditional

 

 

Line Item Declared Value

Both

 

 

Line item Density

Both

 

 

Line Item Dimensional Volume

Both

6.1*

 

Line Item Dimensional Weight

Both

 

Dimensional weight for Ship Unit Line Item calculated based on Dim Rate Factor ID defined in rate record or rate offering. First preference will be given to rate record. Use this RBI when you want to fetch the Line Item Dimensional Weight directly without going through ship unit

Line Item Distance Traveled

Both

6.1*

 

Line Item Hazardous

Conditional

 

 

Line Item Hazmat Item ID

Conditional

 

 

Line Item HTS

Conditional

 

 

Line Item IATA SCR Code

Conditional

 

 

Line Item ID

Conditional

 

 

Line Item IMO Class (Hazardous Classification ID)

Conditional

 

 

Line Item NMFC Article

Conditional

 

 

Line Item NMFC Class

Conditional

 

 

Line Item Package Count

Both

 

 

Line Item Packaged Item ID

Conditional

 

 

Line Item Packaged Specification ID

Conditional

 

 

Line Item PSA Class (PSA Singapore Group)

Conditional

 

 

Line Item SITC

Conditional

 

 

Line Item STCC

Conditional

 

 

Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Line Item String Flex Field

 

21C

Specifies the Rate Basis Item corresponding to line item string flex field. The value provided in the flex filed is considered as string.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Distance

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Duration

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Currency

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as a Number

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as number.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Weight

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as weight. The value provided in the flex filed is considered as weight.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Volume

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item String Flex Field as Date

 

21C

 

Specifies the Rate Basis Item corresponding to line item string flex field as date. The value provided in the flex filed is considered as date.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field as Distance

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field as Duration

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field as Currency

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field as Weight

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Number Flex Field as Volume

 

21C

 

Specifies the Rate Basis Item corresponding to line item number flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item Date Flex Field

 

21C

 

Specifies the Rate Basis Item corresponding to line item date flex field. The value provided in the flex filed is considered as date.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Line Item User-defined Commodity Code

Conditional

 

 

Line Item Volume

Both

 

 

Line Item Weight

Both

 

Ship Unit Line Item Weight. Use this RBI when you want to get the line item weight directly without going through ship unit

Line Item Weight Per Package

Both

 

 

Line Item Weight, Rounded

Both

 

 

Line Item Weight, Rounded Down

Both

 

 

Line Item Weight, Rounded Up

Both

 

 

Linked Shipment Participation

Conditional

 

This applies to work assignments also.

Linked Shipment Penalty Cost

Both

 

This applies to work assignments too.

Location Reference Number - Customer ID Conditional 23C

Retrieves the customer ID using reference number qualifier from either of the following business objects in the priority order of:

  • Order Release
  • Shipment or
  • Stop Location (only source location)

Note: The application considers the Reference Number Qualifier ID defined in the property glog.RatingEngine.CustomerID.refnumQual. The default value of the property is EXTERNAL_CUSTOMER_ID.

Order

Charge

 

 

Order Base ID

Conditional

 

 

Order Base Reference Number

Charge

 

 

Order Base Reference Number Qualifier

Conditional

 

 

Order Base Reference Number Value

Conditional

 

 

Order Chargeable Weight

Both    

Order Currency Flex Field Value

Both

6.4.2

The order currency flex field value is currency.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Currency Flex Field RBI.

Order Currency Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order currency flex field. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Date Flex Field Value

Conditional

6.4.2

The order date flex field value is date.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Date Flex Field RBI.

Order Date Flex Field

Conditional

21C

Specifies the Rate Basis Item corresponding to order date flex field.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Destination Location ID

Conditional

 

 

Order Destination Region (restricted by region group assigned to rate offering, if it exists)

Conditional

 

 

Order Dimensional Volume

Both

6.1*

 

Order Flex Field Qualifier

Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the order flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to ship unit string flex fields (Order String Flex Field value as Duration, Currency, Volume and so on).

Note: This RBI will be deprecated in upcoming releases. Instead of using value and qualifier as separate RBIs for checking a flex attribute, we recommend you to use the new Order Flex Field RBI such as Order String Flex Field as Duration, Currency, Volume, and so on.

 

Order Incoterm

Conditional

 

 

Order Line Item Commercial Invoice Value

Both

 

 

Order Line Item Commodity Code

Conditional

 

 

Order Line Item Declared Value

Both

 

 

Order Line Item Density

Both

 

 

Order Line Item Dimensional Volume

Both

6.1*

 

Order Line Item Dimensional Weight

Both

 

 

Order Line Item Distance Traveled

Both

6.1*

 

Order Line Item Hazardous

Conditional

 

 

Order Line Item Hazmat Item ID

Conditional

 

 

Order Line Item HTS

Conditional

 

 

Order Line Item ID

Conditional

 

 

Order Line Item IMO Class (Hazardous Classification ID)

Conditional

 

 

Order Line Item NMFC Article

Conditional

 

 

Order Line Item NMFC Class

Conditional

 

 

Order Line Item Package Count

Both

 

 

Order Line Item Package Specification ID

Conditional

 

 

Order Line Item Packaged Item ID

Conditional

 

 

Order Line Item PSA Class (PSA Singapore Group)

Conditional

 

 

Order Line Item SITC

Conditional

 

 

Order Line Item STCC

Conditional

 

 

Order Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Order Line Item String Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field. The value provided in the flex filed is considered as string.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI

Order Line Item String Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as a Number

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as number. The value provided in the flex filed is considered as number.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as weight. The value provided in the flex filed is considered as weight.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item String Flex Field as Date

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as date. The value provided in the flex filed is considered as date.

When you select this RBI, a VM ID drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order line item string flex field as date. The value provided in the flex filed is considered as date.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to order line item number flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field Duration

Both

21C

Specifies the Rate Basis Item corresponding to order line item number flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to order line item number flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to order line item number flex field as weight. The value provided in the flex filed is considered as weight.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Number Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to order line item number flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item Date Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order line item date flex field. The value provided in the flex filed is considered as date

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Line Item User-defined Commodity Code

Conditional

 

 

Order Line Item Volume

Both

 

 

Order Line Item Weight

Both

 

 

Order Line Item Weight Per Package

Both

 

 

Order Line Items

Charge

 

 

Order Line Weight, Rounded

Both

 

 

Order Line Weight, Rounded Down

Both

 

 

Order Line Weight, Rounded Up

Both

 

 

Order Number Flex Field Value

Both

6.4.2

The order number flex field value is string.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Number Flex Field  RBI.

Order Number Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI

Order Number Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Number Flex Field as Currency RBI.

Order Number Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field as currency. The value provided in the flex filed is considered as currency. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Number Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Number Flex Field as Duration RBI.

Order Number Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field as duration. The value provided in the flex filed is considered as duration. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Number Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Number Flex Field as Volume RBI.

Order Number Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field as volume. The value provided in the flex filed is considered as volume. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Number Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the new Order Number Flex Field as Weight RBI.

Order Number Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field as weight. The value provided in the flex filed is considered as weight. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Number of Order Release Stops

Both

 

 

Order Payment Method Code GID

Conditional

 

 

Order Release Allocated Cost

Both

 

The sum of all allocated planned shipment costs in the given order.

This is only for sell side shipments. This RBI can provide a markup of the buy allocated cost of an order release on the sell side.

Order Release Best Direct Cost Difference (best direct cost - order release allocated cost)

Both

 

The difference between the best direct cost and the sum of the planned allocated costs of all orders on a shipment. The best direct cost must be pre-computed on the shipment using the corresponding agent action.

Order Release Best Direct Cost Ratio (best direct cost - order release allocated cost)
/ best direct cost

Both

 

The ratio of the best direct cost savings and the best direct cost. The best direct cost savings is the difference between the best direct cost and the sum of the planned allocation costs for all orders on a shipment. The best direct cost must be pre-computed on the shipment using the corresponding agent action.

Order Release Best Direct Cost

Both

 

 

Order Release ID

Conditional

 

 

Order Release Reference Number

Charge

 

 

Order Release Reference Number Qualifier

Conditional

 

 

Order Release Reference Number Value

Conditional

 

 

Order Release Stop

Charge

 

 

Order SELECTed Declared Value

Both

 

When you use this RBI, OTM verifies if there is any declared value at the shipment ship unit line level and then uses that value. However, if the declared value is empty, OTM uses the corresponding order release line level declared value.

Order SELECTed Chargeable Weight

Both

 

 

Order SELECTed Total Number of Line Items

Both

 

 

Order SELECTed Volume

Both

 

 

Order SELECTed Weight

Both

 

 

Order Source Location ID

Conditional

 

 

Order Source Region (restricted by region group assigned to rate offering, if it exists)

Conditional

 

 

Order String Flex Field Value

Both

6.4.2

The order string flex field value is string.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field RBI.

Order String Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to order string flex field. The value provided in the flex filed is considered as string.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Currency RBI.

Order String Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to order string flex field as currency. The value provided in the flex filed is considered as currency. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve orders based on dates.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Date RBI.

Order String Flex Field as Date

 

Conditional

21C

Specifies the Rate Basis Item corresponding to order string flex field as date. The value provided in the flex filed is considered as date. When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the string flex field is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Distance RBI.

Order String Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to order string flex field as distance. The value provided in the flex filed is considered as distance. You must make sure that the string flex field is provided along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Duration

Both

6.4.2

Converts the flex field as duration and uses duration while calculating the shipment cost. You must make sure that the string flex field is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Duration RBI.

Order String Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to order number flex field as duration. The value provided in the flex filed is considered as duration. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Volume RBI.

Order String Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to order string flex field as volume. The value provided in the flex filed is considered as volume. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered. Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Order String Flex Field as Weight RBI.

Order String Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to order string flex field as weight. The value provided in the flex filed is considered as weight. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Order Total Commercial Invoice Value

Both

 

 

Order Total Declared Value

Both

 

The sum of the declared value of all ship unit line items in the given order. The declared value is calculated by multiplying the declared value on the ship unit by the ship unit count.

Order Total Item Package Count

Both

 

 

Order Total Number of Line Items

Both

 

 

Order Total Number of Order Base Reference Numbers

Both

 

 

Order Total Number of Order Release Reference Numbers

Both

 

 

Order Total Volume

Both

 

 

Order Total Weight

Both

 

The sum of the weight of all ship unit lines associated with an order.

Order Total Weight, Rounded

Both

 

 

Order Total Weight, Rounded Down

Both

 

 

Order Total Weight, Rounded Up

Both

 

 

Orders Declared Value on Shipment

Both

 

When you use this RBI, OTM verifies if there is any declared value at the shipment ship unit line level and then uses that value. However, if the declared value is empty, OTM uses the corresponding order release line level declared value.

Rate Offering Carrier SCAC Code Conditional 23C Indicates the SCAC code of the service provider configured in the Rate offering of a order release.

Rate Offering Service Provider GID

Conditional

 

 

Rate Offering Special Carrier Code

Conditional

 

 

Rate Offering/Record Rate Service GID

Conditional

 

 

Rate Remark - External Quote Type Conditional 23C

Retrieves the quote type remark from either of the following in the priority order of:

  • Rate Geo
  • Rate Offering

Note: The application considers the Remark Qualifier ID defined in the property glog.RatingEngine.ExternalQuoteType.remarkQual. The default value of the property is EXTERNAL_QUOTE_TYPE.

Ship Unit

Charge

 

Per ship unit. The number of ship units is calculated by aggregating the ship unit count of each ship unit in the given shipment.

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Ship Unit Chargeable Weight

Both  

The chargeable weight of ship unit. (Chargeable Weight of SU = Total gross volume of SU * dim factor. If 0, total gross weight of SU).

Ship Unit Currency Flex Field Value

Both

6.4.2

The ship unit currency flex field value is currency.

Ship Unit Date Flex Field Value

Conditional

6.4.2

The ship unit date flex field value is date.

Ship Unit Density

Both

 

 

Ship Unit Destination Location

Conditional

 

 

Ship Unit Dimensional Volume

Both

6.1*

 

Ship Unit Distance Traveled

Both

6.1*

 

Ship Unit Early Pickup Date

Conditional

 

 

Ship Unit Equipment Group ID

Conditional

 

 

Ship Unit Flexible Commodity Qualifier

Conditional

 

 

Ship Unit Flex Field Qualifier

Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the ship unit flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to ship unit string flex fields (Ship Unit String Flex Field value as Duration, Currency, Volume and so on).

 

Ship Unit Height

Both

 

 

Ship Unit Is Splitable Flag

Conditional

 

 

Ship Unit Length

Both

 

 

Ship Unit Line Height

Both

6.4.2

Use this RBI to send ship unit line height information of a shipment to the external rating engine. This is used in OTM to charge the shipment based on the ship unit line height.

Ship Unit Line Item Commercial Invoice Value

Both

 

 

Ship Unit Line Item Commodity Code

Conditional

 

 

Ship Unit Line Item Declared Value

Both

 

 

Ship Unit Line Item Density

Both

 

 

Ship Unit Line Item Dimensional Volume

Both

6.1*

 

Ship Unit Line Item Dimensional Weight

Both

 

Dimensional weight for ship unit line item calculated based on Dim Rate Factor ID defined in Rate Record or Rate Offering. First preference will be given to Rate Record. Use this RBI when you want to get the Line Item Dimensional Weight based on a particular ship unit

Ship Unit Line Item Distance Traveled

Both

6.1*

 

Ship Unit Line Item Hazardous

Conditional

 

 

Ship Unit Line Item Hazmat Item ID

Conditional

 

 

Ship Unit Line Item HTS

Conditional

 

 

Ship Unit Line Item ID

Conditional

 

 

Ship Unit Line Item IMO Class (Hazardous Classification ID)

Conditional

 

 

Ship Unit Line Item NMFC Article

Conditional

 

 

Ship Unit Line Item NMFC Class

Conditional

 

 

Ship Unit Line Item Package Count

Both

 

 

Ship Unit Line Item Package Specification ID

Conditional

 

 

Ship Unit Line Item Packaged Item ID

Conditional

 

 

Ship Unit Line Item PSA Class (PSA Singapore Group)

Conditional

 

 

Ship Unit Line Item SITC

Conditional

 

 

Ship Unit Line Item STCC

Conditional

 

 

Ship Unit Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Ship Unit Line Item User-defined Commodity Code

Conditional

 

 

Ship Unit Line Item Volume

Both

 

 

Ship Unit Line Item Weight

Both

 

Use this RBI when you want to get the Line Item Dimensional Weight via the ship unit. Use this RBI when you want to get the Line Item Weight based on a particular ship unit.

Ship Unit Line Item Weight Per Package

Both

 

 

Ship Unit Line Items

Charge

 

 

Ship Unit Line Length

Both

6.4.2

Use this RBI to send ship unit line length information of a shipment to the external rating engine.

This is used in OTM to charge the shipment based on the ship unit line length.

Ship Unit Line Width

Both

6.4.2

Use this RBI to send ship unit line width information of a shipment to the external rating engine.

This is used in OTM to charge the shipment based on the ship unit line width.

Ship Unit Line Weight, Rounded

Both

 

 

Ship Unit Line Weight, Rounded Down

Both

 

 

Ship Unit Line Weight, Rounded Up

Both

 

 

Ship Unit Number Flex Field Value

 

 

The ship unit number flex field value is string.

Ship Unit Number Flex Field Value as Currency

 

 

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Ship Unit Number Flex Field Value as Distance

 

 

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Ship Unit Number Flex Field Value as Duration

 

 

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Ship Unit Number Flex Field Value as Volume

 

 

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

 

Ship Unit Number Flex Field Value as Weight

 

 

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Ship Unit Net Density

Both

 

 

Ship Unit Net Volume

Both

 

 

Ship Unit Net Weight

Both

 

Fetch the Unit Net Weight from Ship Unit and if not present then fetch the Ship Unit Total Net Weight divided by Ship Unit Count

Ship Unit Order Base, Ship Unit ID

Conditional

 

 

Ship Unit SELECT Declared Value

Both

 

 

Ship Unit SELECT Dimensional Weight

Both

 

 

Ship Unit SELECT Net Volume

Both

 

 

Ship Unit SELECT Net Weight

Both

 

 

Ship Unit SELECT Total of Line Items

Both

 

 

Ship Unit SELECT Volume

Both

 

 

Ship Unit SELECT Weight

Both

 

Gross weight per ship unit, which is selected as part of rate conditionals.

Ship Unit Selected Density

Both

 

 

Ship Unit Selected Net Density

Both

 

 

Ship Unit Source Location

Conditional

 

 

Ship Unit Specification ID

Conditional

 

 

Ship Unit Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Ship Unit String Flex Field Value

Both

6.4.2

The ship unit string flex field value is string.

Ship Unit String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Ship Unit String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve ship units based on dates.   

Ship Unit String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Ship Unit String Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the string flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Ship Unit String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Ship Unit String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the string flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Ship Unit Total Commercial Invoice Value

Both

 

 

Ship Unit Total Declared Value

Both

 

 

Ship Unit Total Item Package Count

Both

 

 

Ship Unit Total of Line Items

Both

 

 

Ship Unit Volume

Both

 

 

Ship Unit Weight

Both

 

Gross weight per ship unit

Ship Unit Weight, Rounded

Both

 

 

Ship Unit Weight, Rounded Down

Both

 

 

Ship Unit Weight, Rounded Up

Both

 

 

Ship Unit Width

Both

 

 

Shipment 

Charge

 

Per shipment

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Shipment Accessorial Code GID

Conditional

 

 

Shipment Average Package Weight

Both

 

The total gross weight of the shipment divided by the total package count.

Shipment Base Cost Excluding Weight

Both

6.3

This RBI excludes the weighted cost while calculating the accessorial cost. This is more to be used in charges so it will give you the aggregated cost excluding the weighted cost.

Shipment Base Cost Including Weight

Both

6.3

This includes the weighted cost while calculating the accessorial cost. This is more to be used in an If condition so it will iterate through all the costs and exclude any cost that is weighted. When using this RBI, OTM uses charges related to shipment costs such as Shipment Cost Charge Amount.

Shipment Best Direct Cost Difference (best direct cost -order release allocated cost)

Both

 

 

Shipment Best Direct Cost Ratio (best direct cost -order release allocated Cost) / best direct cost

Both

 

 

Shipment Bobtail Distance

Both

 

The sum of the distance between stops on a shipment where the shipment has a power unit, but it does not have any equipment.

Shipment Circuity Distance

Both

6.1*

This RBI can be used in Oracle Transportation Sourcing rate records.

Shipment Circuity Percentage

Both

6.1*

 

Shipment Cost 'AS FREIGHTED' quantity

Both

 

 

Shipment Cost Accessorial Code (for costs of type A)

Conditional

 

 

Shipment Cost Category ID

Conditional

6.3

Allows for modelling different discounts for separate Base Cost, so you can have separate discounts on Basic Charge vs. Minimum Charge vs. Per LB Charge (Shipment Cost Level).

Shipment Cost Charge Amount

Both

 

 

Shipment Cost is Weighted

Conditional

6.3

If not checked, then it will exclude the Weighted Cost record while calculating the Accessorial Cost. This is more to be used in an If condition so it will iterate through all the costs and exclude any cost that is weighted. When using this RBI, OTM uses Charge related to Shipment Costs, like Shipment Cost Charge Amount.

Shipment Cost Payment Method Code GID

Conditional

 

 

Shipment Cost Record

Charge

 

 

Shipment Cost Special Service Arbitrary

Conditional

 

 

Shipment Cost Special Service GID (for some costs of type A)

Conditional

 

 

Shipment Cost Type (base = B, accessorial = A, discount = D, circuity = C, etc.)

Conditional

 

 

Shipment Count of Service Provider Reference Numbers

Both

6.3

Total number of reference numbers present on the service provider, by unit. For example: charge xx for every xx reference numbers present on the shipment.

Shipment Count of Shipment Reference Numbers

Both

 

 

Shipment Count of Stop Location Reference Numbers

Both

6.3

Total number of reference numbers present on the stop location, by unit. For example: charge xx for every xx reference numbers present on the shipment.

Shipment Count of Stop Reference Number

Both

6.3.6

Per shipment stop reference number. For example, charge xx for every instance of this reference number.

Shipment Customer Account Number

Conditional

 

 

Shipment Currency Flex Field value

Both

6.4.2

The shipment flex field value is currency.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Currency Flex Field RBI.

Shipment Currency Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to shipment currency flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Date Flex Field value

Conditional

6.4.2

The shipment flex field value is date.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Date Flex Field RBI.

Shipment Date Flex Field

Conditional

21C

Specifies the Rate Basis Item corresponding to shipment date flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Deadhead Distance

Both

 

The sum of the distance between stops on a shipment where the shipment has empty equipment (equipment does not contain any ship units).

Shipment Delivering Carrier GID

Conditional

 

 

Shipment Density (aggregate density calculated by total weight /
total volume)

Conditional

 

 

Shipment Destination Location Rail Station Code

Conditional

 

 

Shipment Destination Location SPLC

Conditional

 

 

Shipment Destination Stop

Charge

 

 

Shipment Distance from the Last Stop to the Destination Depot

Both

 

The distance from the last pickup/delivery stop to the destination depot calculated using the rate distance assigned to the rate offering.

Shipment Distance from the Source Depot to the First Stop

Both

 

The distance from the source depot location to the first pickup stop location. It is calculated using the rate distance assigned to the rate offering.

Shipment Empty Initial Distance from Service Provider Location

Both

6.1

The distance from the service provider location to the shipment source location. It is calculated using the rate distance assigned to the rate offering.

Shipment Empty Return Distance to Service Provider Location

Both

6.1

The distance from the shipment destination location to the service provider location. calculated using the rate distance assigned to the rate offering.

Shipment Equipment Average Turnaround Days

Both

6.3

For this RBI, the basic inputs are order source, order destination, equipment, package item/commodity/item. Using these inputs, OTM checks the equipment average turnaround duration table records based on lane information and then sorts these from specific to generic lanes. The corresponding turnaround duration is used.

Shipment Equipment Lease Cost for Average Turnaround Days

Both

6.3

Shipment Equipment Lease Cost for Avg Turnaround Days = Equipment Lease Charge Per Day * Equipment Avg. Turnaround Days.

For this RBI, there may or may not be a lease.

If there is a lease, Equipment Lease Charge Per Day is read from the Lease Asset Entity.

If there is no lease, OTM will check Average Shipment Equipment Average Turnaround Duration table for turnaround days. The basic inputs are order source, order destination, equipment, package item/commodity/item. Using these inputs, OTM checks the equipment average turnaround duration table records based on lane information and sorts these from specific to generic lanes. The corresponding turnaround duration is used.

Note: This RBI determines the charge and multiplies it by the average turnaround duration. The result of this RBI is an actual cost. Hence, the Charge Amount on Rate Geo Cost should always be specified as 1.

Shipment Equipment Registered Mileage Cost for Round Trip Distance Traveled

Both

6.3

Shipment Equipment Mileage Cost for Round Trip Distance = Equipment Mileage Charge Per Mile * Round Trip Distance Traveled.

Shipment Equipment Registered Mileage Charge is read from the lease or the equipment. If the charge is on both the lease and the equipment, the one on the equipment is used.

Note: This RBI will determine the registered mileage charge and multiply it by the round trip distance. The result of this RBI is an actual cost. Hence, the Charge Amount on Rate Geo Cost should always be specified as 1.

Shipment Flex Attribute (1-20)

Conditional

6.3.2

Value of the database field attribute of the shipment.

For example, Shipment Flex Attribute 1would have the value of the database field attribute1 of the shipment.

Shipment Flex Field Qualifier

Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the shipment flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to shipment string flex fields (Shipment String Flex Field value as Duration, Currency, Volume and so on).

Note: This RBI will be deprecated in upcoming releases. Instead of using value and qualifier as separate RBIs for checking a flex attribute, we recommend you to use the new Shipment Flex Field RBI such as Shipment String Flex Field as Duration, Currency, Volume, and so on.

 

Shipment Hundredweight Chargeable Weight

Both

 

The greater of the total shipment gross weight and the total package count multiplied by the minimum package weight defined on a rate offering.

Shipment Incoterm

Conditional

 

 

Shipment Involves Night Driving

Conditional

 

 

Shipment Itinerary

Conditional

6.4.2

This is available only for the generic external rating engines. This is used as an input into an external rating service using the generic rating engine. You can query rates from the external rating engine based on a specific itinerary. The Itinerary GID is passed as an input to the external rating engine using the SHIPMENT.ITINERARY RBI.

Note: Do not use this RBI for general rating purpose.

Shipment Loading Length

Both

6.1

 

Shipment Number Flex Field Value

Both

6.4.2

The shipment number flex field value is number.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Number Flex Field RBI.

Shipment Number Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as date. The value provided in the flex field is considered as date.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Number Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. Make sure that you provide the number flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Number Flex Field as Currency RBI.

Shipment Number Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to shipment number flex field as currency. The value provided in the flex field is considered as currency. Make sure that you provide the number flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Number Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. Make sure that you provide the number flex field value along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

Shipment Number Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to shipment number flex field as distance. The value provided in the flex field is considered as distance. Make sure that you provide the number flex field value along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Number Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. Make sure that you provide the number flex field value along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Number Flex Field as Duration RBI.

Shipment Number Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to shipment number flex field as duration. The value provided in the flex field is considered as duration. Make sure that you provide the number flex field value along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Number Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. Make sure that you provide the number flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Number Flex Field as Volume RBI.

Shipment Number Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to shipment number flex field as volume. The value provided in the flex field is considered as volume. Make sure that you provide the number flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Number Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. Make sure that you provide the number flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Number Flex Field as Weight RBI.

Shipment Number Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to shipment number flex field as weight. The value provided in the flex field is considered as weight. Make sure that you provide the number flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Net Density (aggregate density calculated by net weight /
net volume)

Both

 

 

Shipment Number of Costs Applied from Rating

Both

 

 

Shipment Number of Equipment Reference Units

Both

 

The sum of the equipment reference units of all ship units associated with a shipment. The equipment reference units rate basis item  is calculated by multiplying the equipment reference units on the ship unit by the ship unit count.

Shipment Number of Requested Accessorial Codes

Both

 

 

Shipment Originating Carrier GID

Conditional

 

 

Shipment Perspective (Buy or Sell)

Conditional

 

 

Shipment Position in Linked Set

Both

 

This applies to work assignments also.

Shipment Rate Offering

Conditional

6.4.2

This is available only for the generic external rating engines. This is used as an input into an external rating service using the generic rating engine. You can query rates from the external rating engine based on a specific rate offering. The Rate Offering GID is passed as an input to the external rating engine using the SHIPMENT.RATE_OFFERING RBI.

Note: This RBI is not used for any rating and is therefore incompatible for such type of rating.

Shipment Rate Record

Conditional

6.4.2

This is available only for the generic external rating engines. This is used as an input into an external rating service using the generic rating engine. You can query rates from the external rating engine based on a specific rate record. The Rate Record GID is passed as an input to the external rating engine using the SHIPMENT.RATE_RECORD RBI.

Note: This RBI is not used for any rating and is therefore incompatible for such type of rating.

Shipment Reference Number Qualifier

Conditional

 

 

Shipment Reference Number Value

Conditional

 

 

Shipment Reference Number Value as a Number

Both

 

Shipment reference number value as a number.

Shipment Reference Number Value as Currency

Both

 

 

Shipment Reference Number Value as Distance

Both

 

The reference number value assumed to be specified in the default storage unit of measure for distance.

Shipment Reference Number Value as Duration

Both

 

 

Shipment Reference Number Value as Volume

Both

 

 

Shipment Reference Number Value as Weight

Both

 

 

Shipment Reference Numbers

Charge

 

Per shipment reference number.

Shipment Requested Accessorial Codes

Charge

 

 

Shipment Return Trip Distance Traveled

Both

 

The distance from the last delivery stop on a shipment to the first pickup stop on a shipment. It is calculated using the rate distance assigned to the rate offering.

Shipment Round Trip Distance Traveled

Both

6.3

The complete round trip distance of the shipment, from source to destination and back to the source. This RBI can be used to determine the total mileage charges per cycle (round trip) when comparing private vs railroad. For example, you may be responsible for the return trip and cost of a rail car back to the source location.
It doubles the distance from the source to the destination. The distance between source to destination for a shipment includes all stop offs. So, if a shipment has 5 stops including the source and destination and this distance is captured on the shipment, the distance will be doubled for the return trip, assuming the same path and stops.

Shipment Route Template ID

Conditional

 

 

Shipment Route Template Leg Sequence Number

Both

 

 

Shipment SELECT Chargeable Weight

Both  

The sum of the total chargeable weight of all ship units associated with a shipment selected as part of rate conditionals.

Shipment SELECT Declared Value

Both

 

 

Shipment SELECT Item Package Count

Both

 

 

Shipment SELECT Net Volume

Both

 

 

Shipment SELECT Net Weight

Both

 

 

Shipment SELECT Number of Costs Applied from Rating

Both

 

 

Shipment SELECT Total of Equipment

Both

 

 

Shipment SELECT Total of Line Items

Both

 

 

Shipment SELECT Total of Orders

Both

 

 

Shipment SELECT Total of Ship Units

Both

 

 

Shipment SELECT Total of Stop

Both

 

 

Shipment SELECT Volume

Both

 

The sum of the total gross volume of all ship units associated with a Shipment selected as part of rate conditionals.

Shipment SELECT Weight

Both

 

 

Shipment Selected Density (aggregate density calculated by selected
weight / selected volume)

Both

 

 

Shipment Selected Net Density (sel_netweight / sel_netvolume)

Both

 

 

Shipment Service Provider Refnum Qualifier

Conditional

6.3

Used as a conditional to test the presence of a certain reference number qualifier on the shipment service provider.

Shipment Service Provider Refnum Value

Conditional

6.3

Used as a conditional to determine whether the shipment service provider has a reference number equal to a certain value.

Shipment Service Provider Refnum Value as a Number

Both

6.3

Uses the reference number value of the shipment service provider as a multiplier against the charge amount.

Shipment Service Provider Refnum Value as Currency

Both

6.3

Uses the reference number value of the shipment service provider as the cost. The charge amount field is dynamically removed from the charge basis when this rate basis item is selected.

Shipment Service Provider Refnum Value as Distance

Both

6.3

The reference number value assumed to be specified in the default storage unit of measure for distance.

Shipment Service Provider Refnum Value as Duration

Both

6.3

Converts the reference number value of the shipment service provider to a duration value using the specified unit of time. This value is used as a multiplier against the charge amount.

Shipment Service Provider Refnum Value as Volume

Both

6.3

Converts the reference number value of the shipment service provider to a volumetric value using the specified unit of volume. This value is used as a multiplier against the charge amount.

Shipment Service Provider Refnum Value as Weight

Both

6.3

Converts the reference number value of the shipment service provider to a weight value using the specified unit of weight. This value is used as a multiplier against the charge amount.

Shipment Service Provider Refnums

Charge

6.3

Per shipment service provider reference number. For example, charge xx for every instance of this reference number.

Shipment Source Location Rail Station Code

Conditional

 

 

Shipment Source Location SPLC

Conditional

 

 

Shipment Special Service Duration

Both

6.3

This RBI will find the duration for each special service and multiplies it with the charge defined in the RBI.

Shipment Special Service ID

Conditional

 

 

Shipment Stop Date Flex Field Value

 Conditional

6.4.2

 The shipment stop flex field value is date.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Date Flex Field RBI.

Shipment Stop Date Flex Field

 Conditional

21C

Specifies the Rate Basis Item corresponding to shipment stop date flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field. The value provided in the flex filed is considered as string.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Distance

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Duration

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Currency

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as a Number

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as number. The value provided in the flex filed is considered as number.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Weight

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as weight. The value provided in the flex filed is considered as weight.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Volume

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item String Flex Field as Date

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field as date. The value provided in the flex filed is considered as date.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field as Distance

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field as distance. The value provided in the flex filed is considered as distance.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field as Duration

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field as duration. The value provided in the flex filed is considered as duration.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field as Currency

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field as currency. The value provided in the flex filed is considered as currency.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field as Weight

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field as weight. The value provided in the flex filed is considered as weight.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Number Flex Field as Volume

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item number flex field as volume. The value provided in the flex filed is considered as volume.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Ship Unit Line Item Date Flex Field

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item date flex field.. The value provided in the flex filed is considered as date.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Currency Flex Field Value

Both

6.4.2

The shipment stop flex field value is currency.

Shipment Stop Flex Field Qualifier

Conditional

6.4.2

Specifies the type of flex fields (string, number, currency, and date) and which flex field is to be considered in evaluating the shipment cost. You need to select the flex field qualifier values from the Value(s) drop-down list.

Note: If you select the shipment stop flex field qualifier as string (STRING_FLEXFIELD_X), you must use the RBI corresponding to shipment stop string flex fields (Shipment Stop String Flex Field value as Duration, Currency, Volume and so on).

Note: This RBI will be deprecated in upcoming releases. Instead of using value and qualifier as separate RBIs for checking a flex attribute, we recommend you to use the new Shipment Stop Flex Field RBI such as Shipment Stop String Flex Field as Duration, Currency, Volume, and so on.

 

Shipment Stop Location Rail Station Code

Conditional

 

 

Shipment Stop Location Reference Number Qualifier

Conditional

6.3

Used as a conditional to test the presence of a certain reference number qualifier on the shipment stop location.

Shipment Stop Location Reference Number Value

Conditional

6.3

Used as a conditional to determine whether the shipment stop location has a reference number equal to a certain value.

Shipment Stop Location Reference Number Value as a Number

Both

6.3

Uses the reference number value of the shipment stop location as a multiplier against the charge amount.

Shipment Stop Location Reference Number Value as Currency

Both

6.3

Uses the reference number value of the shipment stop location as the cost. The charge amount field is dynamically removed from the charge basis when this rate basis item is selected.

Shipment Stop Location Reference Number Value as Distance

Both

6.3

The reference number value assumed to be specified in the default storage unit of measure for distance.

Shipment Stop Location Reference Number Value as Duration

Both

6.3

Converts the reference number value of the shipment stop location to a duration value using the specified unit of time. This value is used as a multiplier against the charge amount.

Shipment Stop Location Reference Number Value as Volume

Both

6.3

Converts the reference number value of the shipment stop location to a volumetric value using the specified unit of volume. This value is used as a multiplier against the charge amount.

Shipment Stop Location Reference Number Value as Weight

Both

6.3

Converts the reference number value of the shipment stop location to a weight value using the specified unit of weight. This value is used as a multiplier against the charge amount.

Shipment Stop Location Reference Numbers

Charge

6.3

Per shipment stop location reference number. For example, charge xx for every instance of this reference number.

Shipment Stop Location SPLC

Conditional

 

 

Shipment Stowage Mode (applicable to Consol shipments only)

Conditional

 

 

Shipment Stop Number Flex Field Value

Both

6.4.2

Converts the flex field value as number and uses the value as a multiplier against the charge amount.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field RBI.

Shipment Stop Number Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Number Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Currency RBI.

Shipment Stop Number Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as currency. You must make sure that the number flex field value is provided along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Number Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Distance RBI.

Shipment Stop Number Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as distance. You must make sure that the number flex field value is provided along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Number Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Duration RBI.

Shipment Stop Number Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as duration. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Number Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Volume RBI.

Shipment Stop Number Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as volume. You must make sure that the number flex field value is provided along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Number Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Weight RBI.

Shipment Stop Number Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as currency. You must make sure that the number flex field value is provided along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop Reference Number Qualifier

Conditional

6.3.6

Used as a condition to test the presence of a certain reference number qualifier on the shipment stop.

Shipment Stop Reference Number Value

Conditional

6.3.6

Used as a condition to determine whether the shipment stop

has a reference number equal to a certain value.

Shipment Stop Reference Number Value as Currency

Both

6.3.6

Uses the reference number value of the shipment stop as cost. When the rate basis item is selected, the charge amount field is dynamically removed from the charge basis.

Shipment Stop Reference Number Value as Distance

Both

6.3.6

The reference number value is assumed to be specified in the default storage unit of measure for distance.

Shipment Stop Reference Number Value as Duration

Both

6.3.6

Converts the reference number value of the shipment stop to a duration  value using the specified unit of time. This value is used as a multiplier against the charge amount.

Shipment Stop Reference Number Value as Volume

Both

6.3.6

Converts the reference number value of the shipment stop to a volumetric value using the specified unit of volume. This value is used as a multiplier against the charge amount.

Shipment Stop Reference Number Value as Weight

Both

6.3.6

Converts the reference number value of the shipment stop to a weight value using the specified unit of weight. This value is used as a multiplier against the charge amount.

Shipment Stop Reference Number Value as a Number

Both

6.3.6

Uses the reference number value of the shipment stop as a multiplier against the charge amount.

Shipment Stop String Flex Field Value

Both

6.4.2

The shipment stop flex field value is a string.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field RBI.

Shipment Stop String Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop string flex field.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field as Currency RBI.

Shipment Stop String Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop string flex field as currency. Make sure that you provide the string flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve shipment stops based on dates.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field as Date RBI.

Shipment Stop String Flex Field as Date

Conditional

21C

Specifies the Rate Basis Item corresponding to shipment stop string flex field as date.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Distance RBI.

Shipment Stop String Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as distance. You must make sure that the number flex field value is provided along with the unit of distance such as MI, KM, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Duration

 

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. Make sure that you provide the string flex field value along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop Number Flex Field as Duration RBI.

Shipment Stop String Flex Field as Duration

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop number flex field as duration. You must make sure that the number flex field value is provided along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as a Number

Both

6.4.2

Converts the flex field value as number and uses the value as a multiplier against the charge amount.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field as a Number RBI.

Shipment Stop String Flex Field as a Number

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop string flex field as a number.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field as Volume RBI.

Shipment Stop String Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to shipment stop string flex field as weight.  Make sure that you provide the string flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Stop String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment Stop String Flex Field as Weight RBI.

Shipment Stop String Flex Field as Weight

Both

6.4.2

Specifies the Rate Basis Item corresponding to shipment stop string flex field as weight. Make sure that you provide the string flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value

Both

6.4.2

The shipment flex field value is a string.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field RBI.

Shipment String Flex Field

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field. The value provided in the field is considered as a string. When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Currency

Both

6.4.2

Converts the flex field value as currency and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Currency RBI.

Shipment String Flex Field as Currency

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as currency. The value provided in the flex field is considered as currency. Make sure that you provide the string flex field value along with the unit of currency such as EUR, USD, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Date

Conditional

6.4.2

Used as a condition to retrieve shipments based on dates.   

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Date RBI.

Shipment String Flex Field as Date

Conditional

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as date. The value provided in the flex field is considered as date.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Distance

Both

6.4.2

Converts the flex field value as distance and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Distance RBI.

Shipment String Flex Field as Distance

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as distance. The value provided in the flex field is considered as distance. Make sure that you provide the string flex field value along with the unit of distance  such as MI, KM, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Duration

Both

6.4.2

Converts the flex field value as duration and uses duration while calculating the shipment cost. Make sure that you provide the string flex field value along with the unit of duration such as D/H/M otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Duration RBI.

Shipment String Flex Field as Duration

Both

6.4.2

Specifies the Rate Basis Item corresponding to shipment string flex field as duration. The value provided in the flex field is considered as duration. Make sure that you provide the string flex field value along with the unit of duration such as D/H/M otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Number

Both

6.4.2

Converts the flex field value as number and uses the value as a multiplier against the charge amount.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as a Number RBI.

Shipment String Flex Field as Number

Both

6.4.2

Specifies the Rate Basis Item corresponding to shipment string flex field as number. The value provided in the flex field is considered as number.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Volume

Both

6.4.2

Converts the flex field value as volume and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Volume RBI.

Shipment String Flex Field as Volume

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as volume. The value provided in the flex field is considered as volume. Make sure that you provide the string flex field value along with the unit of volume such as GAL, CAN GAL, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment String Flex Field Value as Weight

Both

6.4.2

Converts the flex field value as weight and uses the value as a multiplier against the charge amount. Make sure that you provide the string flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

Note: This RBI will be deprecated in upcoming releases. We recommend you to use the Shipment String Flex Field as Weight RBI.

Shipment String Flex Field as Weight

Both

21C

Specifies the Rate Basis Item corresponding to shipment string flex field as weight. The value provided in the flex field is considered as weight. Make sure that you provide the string flex field value along with the unit of weight such as LB, KG, etc otherwise the default unit is considered.

When you select this RBI, a Qualifier drop-down list will be available.

You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Total Commercial Invoice Value

Both

 

 

Shipment Total Cost (at the current stage of rating)

Both

 

When using this RBI, the rating engine does not keep a constant running total due to the possibility of the imposition of minimum and maximum charges, and a few other cases.

However, you can set up a series of rate cost groups to accomplish this.

Shipment Total Cost Including Fixed Cost

Both

6.3

Includes all costs: the base cost, rated accessorials and unrated accessorials.

Shipment Total Declared Value

Both

 

The sum of the declared value of all of the orders on a shipment.

Shipment Total Dimensional Volume

Both

6.1*

 

Shipment Total Dimensional Volume

(Sum of Individual Ship Unit Dimensional Volumes)

Both

18C

This RBI calculates the individual ship units dimensional volume and sum up to get the total shipment volume and rate on this value.

Shipment Total Chargeable Weight

Both

 

The total gross weight of the shipment calculated using the gross volume of the shipment and a dimensional factor which converts volume into weight.

Shipment Total Dimensional Weight (Sum of Individual Ship Unit Dimensional Weight)

Both

18C

This RBI calculates the individual ship units dimensional weight and sum up to get the total shipment weight and rate on this value.

Shipment Total Distance Traveled

Both

 

The sum of the distance between stops for all stops on a shipment, regardless of whether the equipment is loaded or empty. It is calculated using the rate distance assigned to a rate offering.

Note: The total distance for this rate basis does not include distances to and from a depot.

This RBI can be used in Oracle Transportation Sourcing rate records.

Shipment Total Distance (Including Depot Stops)

Both

22A

This RBI calculates the total distance of the shipment including the distance between the source depot stop and the source stop, and the distance between the destination stop and the destination depot stop. If the depot stops do not exist, then this RBI will return the distance between the stops of the shipment from source to destination.

Shipment Source Depot Stop

Charge

22C

Indicates the source depot stop of a shipment.

Shipment Destination Depot Stop

Charge

22C

Indicates the destination depot stop of a shipment

Source Delivery Appointment Date Conditional 23C Indicates the source delivery appointment date on a shipment.

Source Depot Stop Location

Conditional

22C

Provides the source depot stop location ID associated with a shipment.

Source Pickup Appointment Date Conditional 23C Indicates the source pickup appointment date on a shipment.

Destination Depot Stop Location

Conditional

22C

Provides the destination depot stop location ID associated with a shipment.

Shipment Total Empty Distance Traveled

Both

 

 

Shipment Total FEU Equivalent Count

Both

 

 

Shipment Total Handling Time

Both

 

Total handling time is the difference between end time and start time of the shipment.

Shipment Total Item Package Count

Both

 

 

Shipment Total Loaded Distance Traveled

Both

6.1*

The sum of the distance between stops on a shipment where the shipment has loaded equipment (equipment containing ship units).

Shipment Total Net Volume

Both

 

The sum of the total net volume of all ship units associated with a shipment.

When you rate a shipment based on the total net volume, OTM identifies whether the net volume value is available at the Ship unit level (OTM considers even if the net volume value is 0). If the value is not available, OTM calculates the net volume value from the ship unit line by adding the net volume values of the individual ship unit lines.

Shipment Total Net Weight

Both

 

The sum of the total net weight of all ship units associated with a shipment.

When you rate a shipment based on the total net weight, OTM identifies whether the net weight value is available at the Ship unit level (OTM considers even if the net weight value is 0). If the value is not available, OTM calculates the net weight value from the ship unit line by adding the net weight values of the individual ship unit lines.

Shipment Total Number of Line Items

Both

 

 

Shipment Total Number of Orders

Both

 

 

Shipment Total Number of Packages

Both

 

Number of packages associated with a shipment.
- When package count setting on a rate offering is specified as ship unit, then sum of ship unit count of all ship units associated with the shipment.
- When package count setting on a rate offering is specified as ship unit line, then sum of item package count of all ship unit lines associated with a shipment.

Shipment Total Number of Ship Units

Both

 

 

Shipment Total Number of Stops

Both

 

Number of stops associated with a shipment.

Shipment Total Order Release Allocated Costs

Both

 

 

Shipment Total Order Release Best Direct Costs

Both

 

 

Shipment Total Pieces of Equipment

Both

 

Number of pieces of equipment associated with a shipment.

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Shipment Total Rest Time

Both

6.4.2

The total rest time for a shipment is calculated by accumulating the information from all the stops. This includes rest time from all the Hour of Service (HOS) rules which includes rest breaks, lunch hours, and overnight layovers between stops.

Shipment Total TEU Equivalent Count

Both

 

 

Shipment Total Transit Time

Both

 

The sum of the transit time of each stop associated with the shipment. If the transit time on a specific stop is empty then transit time is calculated using the distance from previous stop and the rate service on the shipment.
This RBI can only be used for rate services with a rate service type of Simulation.

Shipment Total Volume

Both

 

The sum of the total gross volume of all ship units associated with a shipment.

Shipment Total Weight

Both

 

The sum of the total gross weight of all ship units associated with a shipment.

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Ship Unit Line Item String Flex Field

 

21C

Specifies the Rate Basis Item corresponding to ship unit line item string flex field. The value provided in the flex filed is considered as string.

When you select this RBI, a Qualifier drop-down list will be available. You can select the required User Defined Attribute from the Qualifier drop-down list and then select an operator and specify the required value for the RBI.

Shipment Weight, Rounded

Both

 

 

Shipment Weight, Rounded Down

Both

 

 

Shipment Weight, Rounded Up

Both

 

The round-up value of the sum of the total gross weight of all ship units associated with a shipment.

SMC3 Destination Location Routing Flag

Conditional

 

Allows OTM to differentiate the discounts on a lane depending on whether the destination location on the shipment is serviced directly or indirectly. Points that are serviced directly typically receive a higher discount than indirect points. To discount based on service type, define this conditional using values of null, Direct or Indirect.

SMC3 Source Location Routing Flag

Conditional

 

Allows OTM to differentiate the discounts on a lane depending on whether the source location on the shipment is serviced directly or indirectly. Points that are serviced directly typically receive a higher discount than indirect points. To discount based on service type, define this conditional using values of null, Direct or Indirect.

Source Activity

Charge

 

 

Source Activity (activities associated with the Ship Unit at this Stop
(pickup = P, drop-off = D))

Conditional

 

Activity of source stop ship unit

Source Actual Arrival Time

Conditional

 

Actual arrival time of shipment source stop.

Source Actual Departure Time

Conditional

 

Actual departure time of shipment source stop.

Source Address Lines

Charge

6.2

Collection of address lines.

Source Address Line Value

Conditional

6.2

The value of each address line.

Source Aggregate Density (aggregate density calculated by total
weight / total volume)

Both

 

Density is calculated by dividing total weight of all the ship units of source stop by total volume of all the ship units of source stop

Source Arbitrary Distance

Both

 

Source arbitrary distance travelled.

Source Best Determined Arrival Time

Conditional

 

Returns the time on the shipment stop from the following look up order: Actual Arrival Time, Estimated Arrival Time, Planned Arrival Time, Start Time, Earliest Possible Start time for the source shipment stop

Source Best Determined Departure Time

Conditional

 

Returns the time on the shipment stop from the following look up order: Actual Departure Time, Estimated Departure Time, Planned Departure Time, End Time, Latest Possible End time for the source shipment stop

Source City

Conditional

 

Source City

Source Count of Location Reference Numbers

Both

6.3

Total number of reference numbers present on the location, by unit. For example: charge xx for every xx reference numbers present on the source location.

Source Country

Conditional

 

Source Country

Source Declared Value

Both

 

The sum of the declared value of all ship units associated with the source stop. The declared value is calculated by multiplying the declared value on the ship unit by the ship unit count.

Source Distance to the Previous Stop (if any)

Both

 

N/A. Don't use this RBI since it will always return a value of zero.

Source Drive Time (duration spent driving to the stop)

Both

 

The transit time present on the source stop. If not present we will estimate the time using the driver simulation and the distance from previous stop.

Source Estimated Arrival Time

Conditional

 

Estimated arrival time of shipment source stop

Source Estimated Departure Time

Conditional

 

Estimated departure time of shipment source stop

Source Location ID

Conditional

 

Source Location ID

Source Location Reference Number Qualifier

Conditional

6.3

Used as a conditional to test the presence of a certain reference number qualifier on the source location.

Source Location Reference Number Value

Conditional

6.3

Used as a conditional to determine whether the source location has a reference number equal to a certain value.

Source Location Reference Number Value as a Number

Both

6.3

Uses the reference number value of the source location as a multiplier against the charge amount.

Source Location Reference Number Value as Currency

Both

6.3

Uses the reference number value of the source location as the cost. The charge amount field is dynamically removed from the charge basis when this rate basis item is selected.

Source Location Reference Number Value as Distance

Both

6.3

The reference number value assumed to be specified in the default storage unit of measure for distance.

Source Location Reference Number Value as Duration

Both

6.3

Converts the reference number value of the source location to a duration value using the specified unit of time. This value is used as a multiplier against the charge amount.

Source Location Reference Number Value as Volume

Both

6.3

Converts the reference number value of the source location to a volumetric value using the specified unit of volume. This value is used as a multiplier against the charge amount.

Source Location Reference Number Value as Weight

Both

6.3

Converts the reference number value of the source location to a weight value using the specified unit of weight. This value is used as a multiplier against the charge amount.

Source Location Reference Numbers

Charge

6.3

Per source location reference number. For example, charge xx for every instance of this reference number.

Source Net Density (aggregate density calculated by net weight
/ net volume)

Both

 

 

Source Net Volume

Both

 

 

Source Net Weight

Both

 

 

Source Number of Activities

Both

 

 

Source Number of Address Lines

Both

6.2

The count of address lines.

Source Number of Ship Units

Both

 

 

Source Planned Arrival Time

Conditional

 

 

Source Planned Departure Time

Conditional

 

 

Source Postal (zip) Code

Conditional

 

 

Source Province (state) Code

Conditional

 

 

Source Region (restricted by region group assigned to rate offering,
if it exists)

Conditional

 

Region ID gets evaluated based on the region defined in region group and assigned to rate offering or source shipment stop.

Source Rest Time (duration spent resting at the Stop)

Both

 

 

Source SELECT Chargeable Weight

Both    

Source SELECT Declared Value

Both

 

 

Source SELECT Net Volume

Both

 

 

Source SELECT Net Weight

Both

 

 

Source SELECT Total of Ship Units

Both

 

 

Source SELECT Volume

Both

 

 

Source SELECT Weight

Both

 

 

Source Selected Density (aggregate density calculated by selected
weight / selected volume)

Both

 

 

Source Selected Net Density (selected net weight / selected net volume)

Both

 

 

Source Ship Unit Chargeable Weight

Both    

Source Ship Unit Density

Both

 

 

Source Ship Unit Destination Location

Conditional

 

 

Source Ship Unit Dimensional Volume

Both

6.1*

 

Source Ship Unit Distance Traveled

Both

6.1*

 

Source Ship Unit Early Pickup Date

Conditional

 

 

Source Ship Unit Equipment Group ID

Conditional

 

 

Source Ship Unit Flex Commodity Qualifier

Conditional

 

 

Source Ship Unit Is Splittable

Conditional

 

 

Source Ship Unit Item Package Count

Both

 

 

Source Ship Unit Line Item Commercial Invoice Value

Both

 

The amount of the commercial invoice of an order release line corresponding to the shipment ship unit line of a ship unit at the source stop of the shipment.

Source Ship Unit Line Item Commodity Code

Conditional

 

Used as a conditional to determine whether the flex commodity code ID or ship unit line item commodity ID is equal to a certain value. First preference will be given to flex commodity code ID.

Source Ship Unit Line Item Declared Value

Both

 

 

Source Ship Unit Line Item Dimensional Volume

Both

6.1*

 

Source Ship Unit Line Item Dimensional Weight

Both

 

 

Source Ship Unit Line Item Distance Traveled

Both

6.1*

 

Source Ship Unit Line Item Hazmat Item ID

Conditional

 

 

Source Ship Unit Line Item HTS

Conditional

 

 

Source Ship Unit Line Item ID

Conditional

 

 

Source Ship Unit Line Item NMFC Article at the Stop

Conditional

 

 

Source Ship Unit Line Item NMFC Class

Conditional

 

 

Source Ship Unit Line Item Package Count

Both

 

 

Source Ship Unit Line Item Package Specification ID

Conditional

 

 

Source Ship Unit Line Item Packaged Item ID

Conditional

 

 

Source Ship Unit Line Item SITC

Conditional

 

 

Source Ship Unit Line Item STCC

Conditional

 

 

Source Ship Unit Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Source Ship Unit Line Item User-defined Commodity Code

Conditional

 

 

Source Ship Unit Line Item Volume

Both

 

 

Source Ship Unit Line Item Weight

Both

 

 

Source Ship Unit Line Item Weight Per Package

Both

 

 

Source Ship Unit Line Items

Charge

 

 

Source Ship Unit Line Weight, Rounded

Both

 

 

Source Ship Unit Line Weight, Rounded Down

Both

 

 

Source Ship Unit Line Weight, Rounded Up

Both

 

 

Source Ship Unit Net Density

Both

 

 

Source Ship Unit Net Volume 

Both

 

 

Source Ship Unit Net Weight

Both

 

 

Source Ship Unit Number of Line Items (in ship unit)

Both

 

 

Source Ship Unit Order Base Ship Unit ID (at the stop)

Conditional

 

 

Source Ship Unit SELECT Chargeable Weight

Both    

Source Ship Unit SELECT Declared Value

Both

 

 

Source Ship Unit SELECT Net Volume

Both

 

 

Source Ship Unit SELECT Net Weight

Both

 

 

Source Ship Unit SELECT Total of Ship Units

Both

 

 

Source Ship Unit SELECT Volume

Both

 

 

Source Ship Unit SELECT Weight

Both

 

 

Source Ship Unit Selected Density

Both

 

 

Source Ship Unit Selected Net Density

Both

 

 

Source Ship Unit Source Location

Conditional

 

 

Source Ship Unit Specification ID

Conditional

 

 

Source Ship Unit Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Source Ship Unit Total Commercial Invoice Value

Both

 

 

Source Ship Unit Total Declared Value

Both

 

 

Source Ship Unit Weight, Rounded

Both

 

 

Source Ship Unit Weight, Rounded Down

Both

 

 

Source Ship Unit Weight, Rounded Up

Both

 

 

Source Ship Unit, Unit Height

Both

 

 

Source Ship Unit, Unit Length

Both

 

 

Source Ship Unit, Unit Volume

Both

 

 

Source Ship Unit, Unit Weight

Both

 

 

Source Ship Unit, Unit Width

Both

 

 

Source Ship Units (list of ship units)

Charge

 

 

Source Stop Number

Both

 

 

Source Total Activity Time

Both

 

Activity time defined in source shipment stops.

 

This RBI can be used in Oracle Transportation Sourcing rate records.

Source Total Chargeable Weight of Ship Units at this Stop

Both    

Source Total Dimensional Volume of Ship Units at this Stop

Both

6.1*

 

Source Total Volume

Both

 

 

Source Total Weight

Both

 

The sum of unit weight of all source stop's ship units. The unit weight of each ship unit is unit weight multiplied with respective unit count.

Source Total Weight, Rounded

Both

 

The sum of unit weight of all source stop's ship units and result values is rounded to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count.

Source Total Weight, Rounded Down

Both

 

The sum of unit weight of all source stop's ship units and result values is rounded down to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count.

Source Total Weight, Rounded Up

Both

 

The sum of unit weight of all source stop's ship units and result values is rounded up to nearest integer. The unit weight of each ship unit is unit weight multiplied with respective unit count.

Source Unit Line Item Density

Both

 

 

Source Wait Time (duration spent waiting at stop)

Both

 

 

Stop

Charge

 

Per shipment stop.

Stop Activities

Charge

 

 

Stop Activity (activities associated with the ship unit at this stop
(pickup = P, drop-off = D))

Conditional

 

 

Stop Actual Arrival Time

Conditional

 

 

Stop Actual Departure Time

Conditional

 

 

Stop Address Lines

Charge

6.2

The collection of stops address lines.

Stop Address Line Value

Conditional

6.2

The value of each stops address line.

Stop Best Determined Arrival Time

Conditional

 

 

Stop Best Determined Departure Time

Conditional

 

 

Stop City

Conditional

 

 

Stop Country

Conditional

 

 

Stop Delivery Appointment Date Conditional 23C Indicates the stop delivery appointment date on shipment.

Stop Declared Value

Both

 

 

Stop Density (aggregate density calculated by total weight /
total volume)

Both

 

 

Stop Destination

Conditional

 

 

Stop Distance to the Previous Stop (if any)

Both

 

The distance from the previous shipment stop, regardless of whether the shipment is loaded or empty. It is calculated using the rate distance assigned to the rate offering.

Stop Drive Time (duration spent driving to the stop)

Both

 

 

Stop Empty Drop-off Equipment Available Percent

Both

6.1

This value is computed for shipment stops where empty equipment is dropped off (but not where loaded equipment is dropped off). For locations without a check inventory bucket and a target, the value returned is -100%, because the intent of this RBI is to identify locations with a check inventory surplus percentage is too large (so that taking equipment to such a location can be discouraged).

Stop Empty Pickup Equipment Available Percent

Both

6.1

This value is computed for shipment stops where empty equipment is picked up (but not where loaded equipment is picked up). For locations without a check inventory bucket and a target, the value returned is 100%, because the intent of this RBI is to identify locations with a check inventory surplus percentage is too small (so that picking equipment from such a location can be discouraged).

Stop Empty Pickup Equipment Location Dwell Time

Both

6.1

 

Stop Equipment Reference Unit ID

Conditional

6.1

Equipment Reference Unit ID defined in the stop ship unit.

Stop Equipment Reference Unit Usage Count

Both

6.1

Equipment Reference Unit usage count at this stop.

Stop Equipment Reference Units (list of Equipment Reference Unit usage counts at this stop)

Charge

6.1

For all the Equipment Reference Units used at this stop.

Stop Estimated Arrival Time

Conditional

 

 

Stop Estimated Departure Time

Conditional

 

 

Stop Location ID

Conditional

 

 

Stop Net Density (aggregate density calculated by net weight /
net volume)

Both

 

 

Stop Net Volume

Both

 

 

Stop Net Weight

Both

 

 

Stop Number (1 = source, numStop = dest)

Both

 

 

Stop Number of Activities that Occurred at this Stop

Both

 

 

Stop Number of Address Lines

Both

6.2

The count of address lines on stops.

Stop Number of Ship Units at this Stop

Both

 

 

Stop Pickup Appointment Date Conditional 23C Indicates the stop pickup appointment date on shipment.

Stop Planned Arrival Time

Conditional

 

 

Stop Planned Departure Time

Conditional

 

 

Stop Postal (zip) Code

Conditional

 

 

Stop Province (state) Code

Conditional

 

 

Stop Region (restricted by region group assigned to rate offering, if
it exists)

Conditional

 

 

Stop Rest Time (duration spent resting at the Stop)

Both

 

 

Stop SELECT Chargeable Weight

Both    

Stop SELECT Declared Value

Both

 

 

Stop SELECT Net Volume

Both

 

 

Stop SELECT Net Weight

Both

 

 

Stop SELECT Total of Ship Units

Both

 

 

Stop SELECT Volume

Both

 

 

Stop SELECT Weight

Both

 

The sum of the total gross weight of all ship units associated with a stop selected as part of rate conditionals.

Stop Selected Density (aggregate density calculated by selected
weight / selected volume)

Both

 

 

Stop Selected Net Density (sel_netweight / sel_netvolume)

Both

 

 

Stop Ship Unit Chargeable Weight

Both    

Stop Ship Unit Density

Both

 

 

Stop Ship Unit Destination Location

Conditional

 

 

Stop Ship Unit Dimensional Volume

Both

6.1*

 

Stop Ship Unit Distance Traveled

Both

6.1*

 

Stop Ship Unit Dwell Time

Both

6.3.4

Time duration of a particular ship unit spent at a pickup stop. This is mainly used for secondary charge shipments created on outbound shipments at a particular location. Dwell time is calculated based on the difference between the departure time of the ship unit on the outbound shipment and the arrival time of the corresponding ship unit on the inbound shipment. The departure and  arrival time are taken from the shipment stop where a ship unit is picked up and dropped off respectively.

The glog.business.secondarycharge.shipUnitDwellTimeCalc.truncateDates property calculates dwell time for secondary charge shipments. For more details about this property, see glog.business Properties.

 

Stop Ship Unit Early Pickup Date

Conditional

 

 

Stop Ship Unit Equipment Group ID

Conditional

 

 

Stop Ship Unit Flex Commodity Qualifier

Conditional

 

 

Stop Ship Unit Is Splittable

Conditional

 

 

Stop Ship Unit Item Package Count

Both

 

 

Stop Ship Unit Line Item Commercial Invoice Value

Both

 

 

Stop Ship Unit Line Item Commodity Code

Conditional

 

 

Stop Ship Unit Line Item Declared Value

Both

 

 

Stop Ship Unit Line Item Density

Both

 

 

Stop Ship Unit Line Item Dimensional Volume

Both

6.1*

 

Stop Ship Unit Line Item Dimensional Weight

Both

 

 

Stop Ship Unit Line Item Distance Traveled

Both

6.1*

 

Stop Ship Unit Line Item Hazmat Item ID

Conditional

 

 

Stop Ship Unit Line Item HTS

Conditional

 

 

Stop Ship Unit Line Item ID

Conditional

 

 

Stop Ship Unit Line Item NMFC Article at the Stop

Conditional

 

 

Stop Ship Unit Line Item NMFC Class

Conditional

 

 

Stop Ship Unit Line Item Package Count

Both

 

 

Stop Ship Unit Line Item Package Specification ID

Conditional

 

 

Stop Ship Unit Line Item Packaged Item ID

Conditional

 

 

Stop Ship Unit Line Item SITC

Conditional

 

 

Stop Ship Unit Line Item STCC

Conditional

 

 

Stop Ship Unit Line Item Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Stop Ship Unit Line Item User-defined Commodity Code

Conditional

 

 

Stop Ship Unit Line Item Volume

Both

 

 

Stop Ship Unit Line Item Weight

Both

 

 

Stop Ship Unit Line Item Weight Per Package

Both

 

 

Stop Ship Unit Line Items

Charge

 

 

Stop Ship Unit Line Weight, Rounded

Both

 

 

Stop Ship Unit Line Weight, Rounded Down

Both

 

 

Stop Ship Unit Line Weight, Rounded Up

Both

 

 

Stop Ship Unit Net Density

Both

 

 

Stop Ship Unit Net Volume 

Both

 

 

Stop Ship Unit Net Weight

Both

 

 

Stop Ship Unit Number of Line Items (in ship unit)

Both

 

 

Stop Ship Unit Order Base Ship Unit ID (at the stop)

Conditional

 

 

Stop Ship Unit SELECT Chargeable Weight

Both    

Stop Ship Unit SELECT Declared Value

Both

 

 

Stop Ship Unit SELECT Net Volume

Both

 

 

Stop Ship Unit SELECT Net Weight

Both

 

 

Stop Ship Unit SELECT Total of Ship Units

Both

 

 

Stop Ship Unit SELECT Volume

Both

 

Fetch volume per ship unit and if not present fetch the sum of volumes in the selected ship unit lines. The ship unit in consideration belongs to a particular stop. When we say select it means that the particular stop is selected by the rate conditionals either at the stop level or at a higher level i.e. the shipment stop or shipment level.

Stop Ship Unit SELECT Weight

Both

 

 

Stop Ship Unit Selected Density

Both

 

 

Stop Ship Unit Selected Net Density

Both

 

 

Stop Ship Unit Source Location

Conditional

 

 

Stop Ship Unit Specification ID

Conditional

 

 

Stop Ship Unit Straight Line Distance Pickup to Drop-off

Both

6.1*

 

Stop Ship Unit Total Commercial Invoice Value

Both

 

 

Stop Ship Unit Total Declared Value

Both

 

 

Stop Ship Unit Weight, Rounded

Both

 

 

Stop Ship Unit Weight, Rounded Down

Both

 

 

Stop Ship Unit Weight, Rounded Up

Both

 

 

Stop Ship Unit, Unit Height

Both

 

 

Stop Ship Unit, Unit Length

Both

 

 

Stop Ship Unit, Unit Volume

Both

 

 

Stop Ship Unit, Unit Weight

Both

 

 

Stop Ship Unit, Unit Width

Both

 

 

Stop Ship Units (list of ship units)

Charge

 

 

Stop Source Distance (distance to the source stop)

Both

 

The distance from a shipment stop to the first pickup stop location. It is calculated using the rate distance assigned to a rate offering.

Stop Source

Conditional

 

 

Stop Straight Line Distance to the Source Stop

Both

6.1*

 

Stop Total Activity Time

Both

 

 

Stop Total Commercial Invoice Value

Both

 

 

Stop Total Dimensional Volume of Ship Units at this Stop

Both

6.1*

 

Stop Total Dimensional Weight of Ship Units at this Stop

Both

 

 

Stop Total Equipment Reference Unit Usage Count

Both

6.1*

The sum of Total ERU Usage Count at this stop.

Stop Volume

Both

 

The sum of the total gross volume of all ship units associated with a stop.

Stop Wait Time (duration spent waiting at stop)

Both

 

 

Stop Weight

Both

 

The sum of the total gross weight of all ship units associated with every stop on the shipment.

Stop Weight, Rounded

Both

 

 

Stop Weight, Rounded Down

Both

 

 

Stop Weight, Rounded Up

Both

 

 

Tiered Rating Date Shipment Was Recorded

Conditional

 

 

Tiered Rating Ordinal Position of Shipment Within Time Period

Both

 

 

Tiered Rating Shipment Chargeable Weight

Both 24A

This returns the total aggregated shipment chargeable weights. The shipment chargeable weight can be calculated as follows based on the flag 'Calculate Chargeable Weight/Volume and Dimensional Weight Using':

  • Shipment Total Dimensional Weight/Volume - Converting total volume of the shipment to weight using the dimensional factor.
  • Sum of Individual Ship Unit Dimensional Weight/Volume - Total sum of all ship unit dimensional weights of the shipment.

Tiered Rating Shipment Count

Both

 

 

Tiered Rating Time Period End Date

Conditional

 

 

Tiered Rating Time Period Start Date

Conditional

 

 

Tiered Rating Total Shipment Net Weight

Both

 

This returns the total aggregated shipment weights. 

Tiered Rating Total Shipment Volume

Both

 

This returns the total aggregated shipment volume. 

Tiered Rating Total Shipment Weight

Both

 

 

Total Distance of the Linked Set that Includes this Shipment

Both

 

The sum of the loaded distance of all the shipments in a continuous move tour. Empty distance between shipments is not included. This applies to work assignments also.

Voucher Allocated Cost Accessorial Code

Conditional

 

 

Voucher Allocated Cost Charge Amount

Both

 

The sum of the voucher allocated costs for all orders on the related buy-side shipments for a given sell-side shipment.

Voucher Allocated Cost Record

Charge

 

 

Voucher Allocated Cost Type

Conditional

 

 

 

 

 

 

Related Topics