Revenova TMS 7.9 User Guide

Overview

Revenova TMS™ (TMS) is the leading multi-modal Transportation Management System on the Salesforce AppExchange. As a fully-native force.com managed package, it seamlessly connects to your CRM environment and takes advantage of all the capabilities inherent in the Salesforce platform. These include mobile support, point-and-click reports and dashboards, anytime/anywhere access, and industry-leading reliability, scalability, and security.

Document Purpose

The purpose of this document is threefold:

1. To assist everyday TMS users in the performance of their tasks.
2. To assist managers/team leaders in optimally configuring TMS.
3. To assist Salesforce administrators in understanding and supporting TMS.

Managed Package Installation

Please see the Revenova TMS Installation Guide for basic instructions on how to install Revenova TMS into an existing Salesforce environment. You will also need to read this document to complete all but the simplest installations.

Salesforce CRM and Platform Online Help

Salesforce provides an extensive library of online text and video describing the capabilities of the Force.com platform and the CRM (and other) products it provides. Please click on the Help links and icons present on every page of the application to access these resources.

Critical Customer Responsibilities

1. Make sure you maintain your security profiles and sharing settings so that the appropriate capabilities and data are exposed to your various user groups.
2. If you are using the Customer Portal or Carrier Portal, you must make sure that all data that should be inaccessible is properly secured with security profiles and sharing settings.
3. If you are using the Sales Tax table, ensure that the rates defined there are current and correct.
4. Make sure the TMS Auto-Reject Carrier Transportation Profile workflow rule is active or an equivalent method to invalidate unacceptable carriers.
5. Enter the Inbound Packet IP Ranges for all credentials records for APIs that provide “push” updates to limit inbound transactions to those IP addresses.

Salesforce Environment Configuration

As a native Salesforce application, TMS is completely seamless within your Salesforce environment. This means that most configuration activities that are Salesforce platform-related are exhaustively described via online help and training videos. Please access this help via the links on every page for the following platform-related activities:

1. Adding or modifying a user.
2. Deactivating a user.
3. Adding, modifying, or deleting a security profile.
4. Changing a page layout for a specific records type or table.
5. Adding, modifying, or deleting a tab-based list view.
6. Creating dashboards and reports.

Application Preferences

Most TMS configuration occurs from the TMS Admin tab:

Global Settings

Click on the TMS Admin🡪Configuration link to access global settings:

1. Product Configuration
   1. Shipper or Broker/3PL.
   2. This setting determines the global default tender document – BOL for shipper and Carrier Rate and Load Confirmation for Broker/3PL and default load payment terms.
   3. This setting also determines whether customer-related information (in addition to carrier-related information) is displayed in the Freight Quote page.
2. Default Transportation Profile
   1. If set, controls global defaults for:
      1. Tender document type(s).
      2. Customer and Carrier assignments to lanes.
      3. Customer and Carrier rates, if stored locally.
      4. Relevant for both Shipper/Consignee and Carrier (“Sell” and “Buy” side).
3. Customer Invoice Creation Trigger
   1. If set, represents the Load Status value that will trigger the auto-creation of a Customer Invoice (assuming the presence of an accepted Customer Quote off of which to model the invoice).
4. Carrier Invoice Creation Trigger
   1. If set, represents the Load Status value that will trigger the auto-creation of a Carrier Invoice (assuming the presence of an accepted Carrier Quote off of which to model the invoice).
5. In Transit Load Trigger
   1. Determines which first stop date, when populated, auto-sets a Load to “In Transit” status.
6. Delivered Load Trigger
   1. Determines which last stop date, when populated, auto-sets a Load to “Delivered” status.
7. Email Communications Site URL
   1. Set to external, secure URL for the site you set up for the “email loop” smart email link process.
8. Default Weight Search Bracket
   1. When viewing the Quick Quote pages’ load history, what plus or minus should we use when filtering on load weight.
9. Stop Charge Accessorial
   1. The accessorial record (usually “Stop Off”) that is used for stop charges (which can be automatically added via customer and carrier stored rates).
10. HazMat Accessorial
    1. The accessorial to automatically add to any hazmat loads (as defined on the line items).
11. Carrier Removal Accessorial
    1. The accessorial to automatically add to any carrier quote if the carrier is removed from a load.
12. Cargo Insurance Accessorial
    1. The accessorial to automatically add to any customer quote if insurance was requested via API.
13. Invoice Management
    1. Which product is being used for invoice and payment management.
14. Truck Posting Retention Period (Days)
    1. How many days to retain one-time and load board truck postings.
15. Load Posting Refresh Interval (Minutes)
    1. How often should active load board postings be refreshed.
16. Tracking Update Frequency (Minutes)
    1. How often to process MacroPoint inbound API location update.
17. Default Carrier Mode
    1. The mode to use when auto-creating carriers from SaferWatch, RMIS or MyCarrierPackets when mode information is not available in the packet. 
18. Pricing Workbench Batch Size
    1. Batch process batch size for pricing workbench.
19. Customer Invoice File Prefix
    1. Prefix customer invoices with Load Number or Invoice Number.
20. Queued Transaction Retention Period
    1. Delete Queued Transaction records older than the retention period.
21. Queued Transaction Maximum Process Count
    1. The maximum number of parallel queue transaction job processes. Default is “3”.
22. Override AR Calculator Class
    1. Custom Apex Class for overriding the packaged Revenova calculation of Unbilled, Current, and Past Due AR and Unapplied Cash/Credit Memos.
23. HubTran Credentials Selector
    1. The picklist field on the Load table (if any) that determines which credentials to use.
24. Public Customer Community URL
    1. URL to the email loop customer guest community page.
25. Public Carrier Community URL
    1. URL to the email loop carrier guest community page.
26. Inbound API Community URL:
    1. URL to guest community REST service for push API data capture.
27. Freeze Load Number
    1. Check this box to prevent users from changing the Load Number field on loads.
28. Freight Plans Enabled
    1. Check this box to allow for complex, multi-stop, cross-dock, multi-carrier loads.
29. Disable Customer Creation
    1. Check this box to disallow new customer creation when creating a load.
30. Calculate and Display Taxes
    1. Check this box to enable the display and calculation of (Canadian) sales taxes for Customer Quotes and Invoices.
31. Calculate Negative Taxes
    1. Check this box to calculate negative taxes on customer credit memos.
32. Enforce Customer Credit Limits
    1. Enable if you want to enforce customer credit limits.
33. Enable Commodity Lookup
    1. If checked, commodities can be searched on during line item and rate entry creation.
34. Enable Community Commodity Lookup
    1. If checked, commodities can be searched on during customer community line item entry.
35. Used Default Pickup/Delivery Status
    1. If checked, the default logic to populate the stop- and load-level Pickup/Delivery Status fields will be employed.
36. Display Shipping/Receiving Hours (on Carrier Documents)
    1. If checked, Shipping/Receiving Hours are displayed on carrier documents.
37. Calculate Linear Feet
    1. If checked, linear feet will be auto-calculated for each line item if (1) dimensional fields are populated and (2) the mode or equipment type is set on the load. The cube information comes from either the mode’s default equipment type or the provided equipment type.
38. Enabled GPS-Only Loads
    1. If checked, loads with non-street-address stops (latitude/longitude only) are supported.
39. Use Default Cargo Summary
    1. If checked default calculation will be used for Line Item Cargo Summary field.
40. Allow Carrier Address Updates
    1. If checked RMIS and MyCarrierPackets can update carrier billing and shipping addresses.
41. RMIS Carrier Remit To Sync
    1. If  checked the Carrier Remit To information from RMIS or MyCarrierPackets will automatically update the Carrier Remit To field on the Transportation Profile.
42. Customer Optional on Load Creation
    1. If “true” customer entry is optional when creating loads.
43. Mode Optional on Load Creation
    1. If “true” mode entry is optional when creating loads.
44. Assign Default Equipment Type
    1. If “true” upon mode selection the default equipment type will be set on the new load being created.
45. State Country Picklists Enabled
    1. Read-only field that indicates if State and Country Picklists are enabled.
46. Allow Carrier Document Upload
    1. If checked allow carriers to upload documents via the email loop process.
47. Customer Rebates Enabled
    1. If checked calculate customer rebates on Customer Quotes.
48. Show Freight Class Calculator
    1. Enabled if you want to use the NMFC Class calculator when configuring line items for a load.
49. Access Historical Attachments
    1. If checked retrieves files from BOTH the Attachment and Content Version tables. Release 7.7 and later customers with no historical attachments should leave this UNCHECKED.
50. Use Platform Events
    1. If checked offload certain Queued Transaction Job traffic to Queued Transaction Events (Platform Event) to improve performance.
51. Disable Fuel Card Auto-Naming
    1. If checked the automatic fuel card naming convention will not be used.

Freight Plan

1. Freight Plans Enabled
   1. If checked and the Freight Plan Management batch job is not running or scheduled, the Job Monitor LWC will show the Status as  with a red icon.
2. Monochrome Freight Planner
   1. If checked, use gray for all covered loads on Freight Planner display.
3. Freight Plan Cost Allocation Method
   1. Determines how carrier load costs are allocated to customer loads in a freight plan. Choices:
      1. Weight
      2. Linear Feet
      3. Handling Unit Count
      4. Packaging Unit Count
      5. Distance-Weighted Handling Unit Count
      6. Distance-Weighted Packaging Unit Count
4. Freight Plan Stops – TMS Type
   1. Determines what TMS Types are included in the lookup on Freight Plan Stops.

Carrier Engagement Automation

1. Auto-Tender Frequency (min)
   1. Number of minutes to wait between tendering to carriers based on carrier quotes queued for the auto-tender process.
2. Auto-Tender Book It Responses
   1. When yes, the auto-tender process will tender to the first "Book It" request received after dedicated carriers are engaged.
3. Auto-Tender Max Pay Amount
   1. The maximum amount of a Carrier Quote that can be auto-tendered.
4. Skip Quotes in On Hold Tender Status
   1. If checked, quotes in the queue that are On Hold status are skipped.
5. Auto-Tender Carrier Sales Rep Assignment
   1. Determines what user will be assigned as the Carrier Sales Rep on a load when the load is auto-tendered:
      1. Carrier Account Owner
      2. Carrier Service Owner
6. Auto-Tender Max Pay Amount Currency
   1. The currency of the amount entered in the Auto-Tender Max Pay Amount (multi-currency orgs only).

Debugging

1. Logging Enabled
   1. Enable if working with Revenova on a technical issue. Displays extra information on the user interface and in the logs for debugging purposes.
2. Logging User
   1. The user for which logging is enabled.
3. Enable Packet Replay
   1. If checked you can inject test API XML/JSON responses into the application by saving them as Files named after the APIOperation class you are debugging. The Logging User – if set – is the recipient of the test response.
4. Retain API Response Packets
   1. Enable if working with Revenova on a technical issue. Attaches XML responses to load or quote records as they are retrieved.
5. Block API Inbound Packets
   1. Enabled if no inbound traffic is desired.

Fleet Management

1. Fleet Management Enabled
   1. If checked run all 15 passes of Fleet Management Job and enable other Fleet Management features.
2. Fleet Management Email
   1. Errors from Fleet Management Job will be sent to this email address.
3. Fleet Management Default Carrier
   1. The internal carrier that handles all Fleet loads.
4. Timezone Update Disabled
   1. The Fleet Management Job sets this field to “true” if it is prevented from updating accounts with the appropriate Timezone field value.
5. Driver Log Grace Period (Days)
   1. This setting determines how far back driver HOS logs are retrieved, allowing for adjustment of past logs for a few days.
6. Fleet Management Job Last Run
   1. Set by the Fleet Management Job during each successful run.
7. Fleet Management Pass Counter
   1. Set this value (0-15) to run one pass of the Fleet Management Job. Use for debugging only.

Document Production Settings

Most document-specific settings are contained in Document Options (see below). Two global settings are here:

1. Include Master BOL
   1. If checked, include a Master BOL document and number when multi-stop load BOL documents are created.
2. BOL Number Auto-Generation
   1. The logic (If any) when a BOL document and number is generated for a load. Options include:
      1. None – Use when creating your own BOL Number generation logic.
      2. Unique Numeric – Default behavior; unique integer generated for BOL Number.
      3. [Load Table Field] – Choose from any other load table fields, such as PO Number or Load Number.

EDI Settings

1. EDI Enabled
   1. Turns on support for Load Tender (204), Load Tender Response (990), Shipment Status (214), and Load Detail and Invoice (210).
2. EDI Run Frequency (Minutes)
   1. Determines how often Load Tenders are requested from the EDI VAN via the EDIJob process.
3. Enable EDI Overrides
   1. Check if you want to redirect 214 and 210 transactions to a different EDI Provider or Trading Partner – overriding default behavior – for certain accounts.
4. EDI Administrator
   1. Set to the person who should receive emails in case of EDI issues and errors.
5. EDI Shipment Id Field
   1. The field from the Load table that is used to uniquely identify Shipments/Loads in EDI transactions. Usually the PO Number field as designated by the EDI trading partner(s) sending Load Tenders.
6. Display EDI References on Carrier Docs
   1. Check if you want to display EDI reference numbers on the carrier and driver tender documents.
7. Enable EDI Transaction Logging
   1. Check if you want a record of each EDI XML packet stored with the load in the EDI Transaction table.
8. EDI Freight Charges Code
   1. Passed in outbound EDI 210 transactions, if set.
9. EDI Fuel Surcharge Code
   1. Passed in outbound EDI 210 transactions, if set.
10. EDI Transaction Logging Types
    1. List of transactions that will be logged to EDI Transaction table.

Carrier Management/Load Status

1. Expiration Check Policy Types
   1. Which insurance policies should be checked for expiration before tendering a load to a carrier.
2. Policy Expiration Lead Time (Days)
   1. How many days before policy expiration is a carrier ineligible for tendering.
3. Carrier Status Reply To User
   1. Defines which user’s email is the reply to email for load status emails to carriers.
4. Carrier Status Reply To Email
   1. If a carrier simply replies to a carrier status email (instead of clicking on the embedded link) the reply will be sent to this email address (If Carrier Status Reply To User is set to Email).
5. Carrier Status BCC User
   1. If checked, the user is BCCed on individually-sent carrier status emails.
6. Carrier Monitor Email
   1. The email address that receives status messages at the completion of the Carrier Monitor Job (SaferWatch).
7. Carrier Monitor Last Run Date
   1. Last time carrier FMCSA monitoring job was successfully run.
8. Carrier Monitor Run Frequency (Mins)
   1. RMIS and MyCarrierPackets only: how often the “net change” job runs to get new onboarding carriers or carriers that have updates.
9. Load Status Start Time, Load Status Email Frequency (Hrs), and Load Status API Frequency (Hrs).
   1. Determines how often the Load Status job runs by email and API update type.
   2. This job requests status of assigned, dispatched, and in-transit loads based on the preferred communication method with the carrier (service).
   3. API status loads are pinged for 5 days after delivery to capture any available POD images.

Multi-Currency Settings

1. Default Load Currency
   1. The currency code to use for new load records.
2. Use Dated Exchange Rates
   1. Check if you have a multi-currency instance and are using Dated Exchange Rates for conversion of load-level currency rollup fields.

Load Name Setup

These fields define the format and start number for the load name field (Load Number).

Load Locking

1. Enabled Operations Load Locking
   1. Check if you want to use load locking to prevent certain simultaneous operations on loads.
2. Load Locking Hold Time
   1. The number of minutes a load lock is active.

If load locking is used, make sure internal profiles have View All Custom Settings checked.

Document Options

Document Options represent a group of logos, email templates, instruction text, terms and conditions, and footer text specific to a division, mode, or user. The following major processes and documents are tailored based on the selected Document Options record:

1. “Email Loop” Process with Customers and Carriers
2. Online Carrier Application
3. Customer Quote Confirmation Email and PDF Document
4. Carrier RFQ Email and PDF Document
5. Carrier Rate and Load Confirmation Email and PDF Document
6. Bill of Lading Email and PDF Document
7. Driver Load Confirmation Email and PDF Document
8. Customer Invoice Email and PDF Document
9. Customer Invoice Batch Email and PDF Document
10. Shipping Label format

Document Options Selection Criteria records allow you to designate when to use which Document Options record. These criteria are based on:

• Mode 
• (Any) User Field

Common TMS customer scenarios include:

• One global Document Options record that serves for the entire company.
• Division/Office-specific logos and legal text requiring distinct Document Options records.
• Mode-specific logos and legal text for different groups (LTL versus Truckload) within a brokerage.

Document Options “Cascade”

Document Options work in “cascade” fashion. If a field for a particular Document Option is missing, the global record’s value is used. This allows you to create “sparse” document options records without having to re-key all the global defaults values that are still relevant.

For example, if the only difference between the global record and a mode-specific record is the BOL Legal Text, you would only have to enter that one different field on the mode-specific record. 

Document Options Load Field

The Document Options Load field is auto-populated during the email or fax tender process. This can be manually overridden later to, for example, send out a customer invoice with a different logo. Before tendering, the Document Options record is dynamically selected based on the Document Options Selection Criteria, if any.

Document Options Override/Additions

You may add any Load, Stop, and Line Item fields to many of the documents. You may add any Customer Quote fields to the Customer Quote document only, and Carrier Quote fields to the BOL document only.

You may also suppress the HazMat and NMFC sections of documents (if these fields are not relevant to your loads).  

You may also suppress or change the logo image on a per-document basis.

Note that if you add “flex fields” to documents that appear on the Customer Portal or Email Loop site (such as Customer Invoice and BOL) you must make those fields accessible to the related external security profile.

Document Options Maintenance

Access Document Options from the TMS Admin🡪 Document Options link:

You are presented with the list of Document Options and Document Options Selection Criterion records:

In this case there are two Document Options records and one criterion for selecting the non-global default record. This criterion indicates that the “Truckload Options” record should be used IF:

Mode = “Truckload” AND User Division = “Tractor”

If this criterion evaluates to “false”, the global Document Options record is used to tailor documents and emails.

Make sure you have exactly one Document Options record with Global Defaults set to “true”.

Make sure to enter relevant values for all the fields on (at least) the global Document Options record.

Selecting a Document Options record from the list allows the user to edit the record details.

General Info / Email Templates

1. Name: Uniquely identifies the record.
2. Global Defaults: Make sure exactly one record has this checked.
3. Mask Shipper/Consignee on Carrier RFQ: Check if you want to hide shipper/consignee identity from carriers on the Quotation Request and quote entry form.
4. Mask Shipper/Consignee on Carrier Tender: Check if you want to hide shipper/consignee identity from carriers on the Carrier Rate and Load Confirmation document until after a load tender Is accepted. Note that the BOL is also not sent until a tender is accepted if this field is checked.
5. No Documents Until Tender Accepted: Check if you do not want the carrier to receive RFQ or tender documents via email until the tender is accepted.
6. Enabled Assign Carrier On Tender Option: Check if you want to be able to assign a carrier on (email) tender and not require an Accept link to be clicked by the carrier.
7. Request Tender Decline Reason: Check if you want to require the carrier to specify a reason for declining a tender. 
8. Itemize Carrier Quote Accessorials: Check if you want carriers to enter itemized accessorial charges on email RFQ links.
9. Document Account: Populates certain documents with name and address when TMS user company referenced.
10. Default Carrier Bill To: Populates the Load’s Carrier Bill To field automatically upon tendering.
11. Suppress HazMat Column: Suppress HazMat column on all documents if not a HazMat load.
12. Suppress NMFC Columns: Suppress NMFC columns on all documents is not populated.
13. Quote Reply To Email: The reply to email for quote emails to customers/carriers based on the Quote Reply To Email Option.
14. Quote Reply To Email Option: Determines the reply to email for system quote emails to customers/carriers (Quote Reply To Email or user’s email).
15. Tender Reply To Email: The reply to email for tender emails to carriers based on the Tender Reply To Email Option.
16. Tender Reply To Email Option: Determines the reply to email for system tender emails to carriers (Tender Reply To Email or user’s email).
17. Document Logo: Select a logo that will appear on all documents.
18. Email templates:  Select 11 email templates for all email communications with customers and carriers. The simplest approach is to use the default settings and modify the templates to taste.

Document Settings

You may partially or completely override the appearance of TMS documents produced by the system. The documents you can tailor here are:

1. Bill of Lading
2. Carrier Application
3. Carrier Quotation Request
4. Carrier Rate and Load Confirmation
5. Customer Invoice
6. Customer Invoice Batch
7. Customer Rate and Load Confirmation
8. Driver Load Confirmation
9. Ocean Bill of Lading (Ocean FCL mode loads)
10. Shipping Label
11. Warehouse Lading Form

Select the document you want to configure:

Click the Show Preview button to obtain immediate visual feedback on the changes you are making. Click on the text that you want to change to enter edit mode.

Click the Add Field button to add Customer Quote, Carrier Quote, Load, Stop, and Line Item fields to those documents that support field additions.

Choose a Document Logo Override if you want a document-specific logo image different from the default logo. Click the Suppress Logo checkbox to suppress the logo image on a given document. Click Suppress Expected Delivery Date to suppress this field on the BOL document for LTL loads only.

Make sure to click the save button after changes to any document before going to the next document.

The language a PDF document is rendered in is based on the Language field setting on the customer/carrier Transportation Profile record. You must translate all labels found in the documents using the Translation Workbench to generate non-English versions of the documents.

Load-Specific Bill of Lading PDF Filename and Field Overrides

On a load-by-load basis, you may enter override values for the Filename and certain fields on the Bill of Lading PDF. These overrides can be used to produce Blind or Double-Blind BOL documents from the TMS. They also enable you to hide extra accessorial information from uninterested parties on the BOL for the Load. Lastly, the ‘Third Party Freight Charges Bill To’ section of the BOL can be overridden to make it appear to the carrier as if they are working exclusively with the customer for which they have specific pricing. The fields that can overridden are as follows:

• Ship From Name
• Ship From Address
• Ship From City/State/Zip
• Ship To Name
• Ship To Address
• Ship To City/State/Zip
• Third Party Bill To Name
• Third Party Bill To Address
• Third Party Bill To City/State/Zip
• Special Instructions
• Carrier Name

User can add/remove/edit override values by navigating on the Load record to the Documents tab 🡪 Generate Document tab 🡪 select ‘Bill of Lading’ in the Select a Document to Generate picklist as show below:

Custom Document Formats

You may replace the (already highly-configurable) TMS document formats with your own custom Visualforce pages as desired, at the Document Options/Document Type level:

Note that your extension controller must be present, and different than the extension controller used by the out-of-the-box Visualforce page.

Reference Data Setup

Mode Setup

Access the list of supported modes from the TMS Admin🡪Modes link. TMS currently supports ten modes. You may disable those modes that are not relevant to your business.

The Customer Portal Selection field indicates if the mode is available on the self-serve Customer Portal.

Mode-specific online carrier application documents for upload are set up from each Mode detail page. Make sure this is filled out for each enabled mode if you use the online carrier application. Adding values to this picklist allows you to add values to the required documents uploading with an online carrier application.

Equipment Type Setup

Access the list of Equipment Types from the TMS Admin🡪Equipment Types link. Each load can have an associated Equipment Type, which allows for cube/weight calculations and optimizations. Equipment Type is also important as an informational element on quote and tender documents, and for Ocean FCL loads.

Payment Terms Setup

Set up Payment Terms from TMS Admin🡪Payment Terms. These can be applied to Carrier Quotes to determine (quick pay) Payment Discount and Invoice Due Date when Vendor Invoices/Payables are auto-generated.

Fuel Index Setup

Access the list of Fuel Indexes from the TMS Admin🡪Fuel Indexes link. These indexes are an input into Fuel Surcharge schedule setups.

Each index has one or more Fuel Index History records which can be automatically retrieved from the Energy Information Administration (EIA) via the FuelIndexUpdateJob batch process. Be sure to set each Data Series Id to a weekly index value as provided by the EIA in order to enable automatic updates.

TMS supports the weekly EIA indexes which have an effective date of Monday.

RateIQ

RateIQ allows you to set up blended carrier rate estimates using internal load history and Truckstop/DAT/FreightWaves API rates. Set up your calculation weighting factors from TMS Admin🡪Rate Calculations.

Supported Data Sources:

1. TMS (internal data)
2. DAT
3. FreightWaves
4. Truckstop – Posted
5. Truckstop – Paid
6. Custom Source(s)

Set up RateIQ from TMS Admin🡪Rate Calculations.

Note that RateIQ is mode-specific and does Lane-matching to select the best-matched rate calculation based on Match Priority.

Import/Delete Custom Source data by clicking on the Data button above or using the TMSRateIQSourceService web service:Custom Data uploaded is located at TMS Admin🡪RateIQ Rate Sources.

Fuel Surcharge Setup

Fuel surcharges can be automatically applied to Customer Quotes, Customer Invoices, Carrier Quotes, and Carrier Invoices. They can be applied via Rate Entries when setting up stored rates for customer and global transportation profiles. To create a Fuel Surcharge schedule, go to TMS Admin🡪Fuel Surcharges.

Select the Fuel Index the surcharge should be based on. The Fuel Index Value field determines which value of the index is used in the calculation:

• Current Week
• Prior Week
• Two-Week Average
• Three-Week Average
• Four-Week Average
• Prior Calendar Month

The Current Week Start Day determines how a week is defined for purposes of selecting the “current” index. For example, a Current Week Start Day of Tuesday means that the index available next Monday is considered current for Tuesday through Monday. This value is typically Sunday or Monday.

You must schedule the FuelIndexUpdateJob daily to enable automatic index and fuel surcharge refreshes.

Note that the load’s Expected Ship Date determines the starting date for fuel surcharge calculations.

Fuel Surcharge Calculation

The following records are automatically updated based on changes in the relevant fuel index if they were created via stored rates:

• Customer Quote: Updated until load ship date.
• Carrier Quote: Updated until load ship date.
• Customer Invoice: Updated until invoice is no longer Pending status.
• Carrier Invoice: Updated when customer invoice is no longer Pending status.

The purpose of this recalculation is to deal with the fact that the contracted fuel index value may not be available at the time of record creation. Therefore, quotes and invoices may need to be adjusted as indexes are updates.

Note that you can freeze the fuel surcharge calculation (so subsequent index updates have no effect) by setting the Auto-Update Quotes/Invoices field to No.

For the following types of Rate Entries, the fuel surcharge is automatically calculated along with a complete Customer or Carrier Quote:

• Fixed Cost
• Distance-Based
• Weight-Based
• Billable Weight-Based
• Handling Unit-Based
• Linear Feet-Based
• Equipment-Based

Breakthrough Fuel Support

Breakthrough Fuel-based fuel surcharges are supported for stored rate customer quotes. Populate the Breakthrough Fuel Shipper Id on the Transportation Profile for any customers using Breakthrough Fuel. Populate the Customer Load Id on any load where a surcharge is calculated. This ID must be provided to Breakthrough Fuel by the customer.

Note that the Fuel Surcharge Update Job repopulates the Fuel Surcharge in the same way for both index-based and Breakthrough Fuel-based customer quotes.

Fuel-Only Rate Entries

Rate Entries of type Fuel Only are applied when clicking the Save button in the Freight Quote Assistant, when creating a “spot” quote with a pre-negotiated fuel surcharge:

1. Customer Quotes are associated with a Fuel Surcharge via the Rate Entry lookup field that is populated on stored rate quote creation.
2. Carrier Quotes are associated with a Fuel Surcharge via the Rate Entry lookup field that is populated on stored rate quote creation.
3. Customer Invoices are associated with a Fuel Surcharge via the Customer Quote lookup field that is populated when an invoice is auto-generated.
4. Vendor Invoices are associated with a Fuel Surcharge via the Carrier Quote lookup field that is populated when an invoice is auto-generated.

Freight Class Calculation Rules

To employ the NMFC Freight Class Calculator when creating loads internally or via the Customer Portal, review the density/class rules from the TMS Admin🡪Freight Class Calculation Rules link:

Carrier Liability Limits

Define Carrier Liability Limits to calculate and display load-specific limits on internal and customer portal carrier quote list.

For stored rates, the Carrier Quote Liability Coverage and Liability Coverage Exceeded By fields are auto-calculated if the Load Commodity Condition field is populated and a Carrier Liability Limit is defined for the Carrier Service on the quote.

               Liability Coverage Exceeded By = Math.max(0, Cargo Value – Liability Coverage)

Customer-Specific Commodity Lookup

From TMS Admin🡪Commodity Catalogues enter any recurring commodities that are often used when creating loads and rate entries. These Catalogues are used by customers by setting the Commodity Catalogue field on the customer Transportation Profile record.

During load and rate entry creation, these commodities can be searched on and accessed.

Commodity lookup can also be enabled for the customer portal.

You may define a Commodity Catalogue at the global Transportation Profile level to serve as a “backstop” catalogue. It will be used for all customers that do not have a catalogue defined at the Transportation Profile level.

Batch Processes

Access the status of key TMS batch processes from the Job Monitor Lightning Web Component, which is generally located on the Home Page Layout, but it can also be placed on your own custom Lightning App Page. This same information can also be accessed from TMS Admin🡪Batch Processes. 

A description of each job and the corresponding actions available are given in the table below. Please note that if a particular job is shown as ‘Not Applicable’ in the Status column, this means that either the Credentials for the corresponding API are not enabled or the TMS Configuration setting that controls the job is not enabled. A definition for each ‘Not Applicable’ Status is given in the second table below.

There are some batch processes not included in the monitor list that are run automatically by the TMS or with manual button pushes. Those jobs are listed below.

EPayment Setup

If you are using EFS, then each EFS credential you want to use for EPayments must have the Money Codes option selected (and be Active) in the Credentials page in the TMS Admin tab:

You need to have at least one active EFS credentials with the Money Codes option selected, or an active Comdata credentials before you can configure any users for EPayments.

To configure EPayments, go to the EPayment Administration page in the TMS Admin tab. The EPayment Administration page has 3 subtabs: Users, Transaction Types and Settings.

The first time you access this page the Users and Transaction Types tabs will have no data in them:

The Settings tab will default the Accounting Configuration to “Vendor Payments” for the TMS Accounting configuration:

First time configuration for EPayments should be done in the following order:

1. Settings
2. Transaction Types
3. Users

Configuration Steps:

1. Settings:
   1. Accounting Configuration: options are Vendor Payments and Vendor Invoices/Credit Memos.
   2. Choose Vendor Payments to create a Vendor Payment record when an EPayment is issued.
   3. Choose Vendor Invoices/Credit  Memos to create Vendor Invoices and Credit Memos when an EPayment is issued. If you choose this option, you will need to map either an EFS or Comdata vendor account for the vendor invoices that will be created. You will also need to map the appropriate Amount, Charge and Fee to the appropriate accessorial records (TMS Accounting) or product records (Accounting Seed) that will be created for the vendor invoices (TMS Accounting) or payables ( Accounting Seed), and map them in this page:
      
      Click Save to save the Settings configuration.
2. Transaction Types:

The Transaction Types you create here will be available to your users when creating an EPayment based on the user’s setup (Users tab – next step).

Enter the Transaction Type information in the bottom section of the page: Name, Credit/Deduction Amount Default, Credit Memo Amount Default, Fee Type and Charge Type. If you have a multi-currency org, the Currency will available to select. The currency selected applies to the Charges and Fees associated with the transaction type:

The Credit/Deduction Amount Default picklist defines which credit memos are created for the vendor invoices or payable records when an EPayment is issued.

The Credit Memo Amount Default picklist are Read-Only and Edit. These values dictate whether the user can change the Credit/Deduction Amount setting above when issuing an EPayment.

The Fee Type and Charge Type picklist values are Amount and Percent. Your choices here what data you enter in the Fees and Charges table underneath for each transaction type.

The Fees and Charges table allow to define the From and To Amount ranges to apply the appropriate Fee and Charge values to the amount of the EPayment. The To Amount of a record should match the From Amount of the following record so there are no gaps when calculating fees and charges when an EPayment is issued. The range is defined as greater or equal (>=) of the From Amount to less (<) than the To Amount in order for the EPayment page to calculate the right fee and charge for a transaction type based on the amount of the EPayment.

A sample transaction type looks like this once entered and saved:

Click the New button to create a new transaction type. You can also click on the action menu button on the right hand of the Transaction Types table (top table) on a specific transaction type to either Edit, Clone or Delete that transaction type.

3. Users:

Set up all the users in this tab that will be able to issue EPayments. Type the user’s name in the User field and select it from the list.

Enter the Per Load Max (%) and Per Load Max Amount limits. Optionally, enter the Per Day Max Amount and Per Day Max (#) of limits.

For multi-currency orgs, enter the currency of the amount fields in the user’s limits.

The Issue Authority values are: Assigned Carrier Only, Any Authorized Vendor and Assigned Driver Only. The value selected here will be validated when the user issues an EPayment.

User limits are validated in the following cascading order:

1. Check the Per Day Max Amount 
2. Check the Per Day (#) 
3. Check the minimum of the Per Load Max % and Per Load Max Amount 

A null value on a. and b. means that those limits are not checked.

Click the Save button to save your changes.

If you have many users, you can type their name on the search box next to the left of the “New” button.

Each record on the “Authorized Users” list has an Action menu button on the last column. You can click on the Edit, Clone or Delete for each record. You can also click on the “User Name” column to select that user’s data for editing purposes.

A sample user setup may look like this:

4. Issuing an EPayment:

Once you are done with the configuration, users can start issuing EPayments from the load record. Your configuration may look different, but there will be tab or section in your load page where you can access the EPayments:

Click on the New button on the EPayments header section to create a new EPayment:

The following values from the load are defaulted:

1. Load
2. Currency (in multi-currency orgs)
3. Vendor (Carrier on the load)
4. Recipient (Driver on the load)
5. Funding Source (the Default Funding Source from the user’s authority record) 

The user will need to select the Transaction Type and enter Amount. All fields are editable while the EPayment is in Pending status.

After selecting the Transaction Type and entering the Amount, the user can Issue the EPayment:

The EPayment will be available to view from the load record:

Clicking on the EPayment will allow you to view the details of the EPayment:

Other actions available to perform on an Issued EPayment, such as Stop (Canceling) the EPayment for EFS and Comdata, or Freezing the EPayment (Comdata), can be performed by clicking on the Edit button on the top right hand corner of the page. Clicking on the Edit button will open the EPayment form again with all fields in read-only mode and with the appropriate buttons available:

EDI Locations

From TMS Admin🡪EDI Locations, enter the EDI identifiers for each EDI trading partner.

There are two types of records in this table:

1. Trading Partner EDI Identifier records, where the Trading Partner and Location fields are identical, and the Trading Partner Id flag is true.
2. Trading Partner location records, where codes for specific locations, by trading partner, are identified.

Note that this table “fills” automatically as EDI Load Tenders (204) are processed (if they contain location codes).

Trading partners for inbound EDI 204 tenders are the customers or customer bill to. Trading partners for outbound EDI 204 tenders are the carriers.

Several account records can be associated with the same customer trading partner by populating the SCAC field. [Location Code + SCAC] must be unique. This allows for “division-specific” treatment of trading partners.

EDI Transaction Routing Overrides

You can override the EDI Provider and the Trading Partner for 990, 214, and 210 transactions on an account-specific basis from a trading partner EDI Location record:

Auto-Accept and EDI Order Update Console (990)

You can automatically send back 990 Load Tender Accept transactions for both Original 204s and Update 204s on a trading partner-specific basis:

Alternatively, for inbound Update 204s, you can activate the EDI Order Update Console, which requires manual processing of all inbound Update 204s on a trading partner-specific basis. See the section of the User Guide related to the EDI Order Update Console for a description of how to use the console.

EDI Location Child Tables

The following tables provide additional EDI functionality and should be set up for trading partner records (only) in the EDI Location table.

EDI Update Settings

These records control what updates can occur on a load if a 204 update is received(these settings only apply if the trading partner is not using the EDI Order Update Console):

You can also direct the TMS to use stored rates instead of the customer quote information in the 204:

In the absence of EDI Update Setting records, the default behavior is to allow updates.

EDI Load References

These records allow you to dynamically create Load References that are then sent with all outbound EDI transactions:

You may add to the TMS Field picklist if you have custom fields you wish to send as Load Reference elements.

EDI Bulk 214 Send

If EDI 214 status transactions need to be (re-)sent in bulk, select the loads in question from the list view, and click the EDI Status button. You can then (re-)send all the relevant EDI 214 transactions with one click.

EDI Record Validation

You can validate that your EDI Location table is properly set up by clicking on the Validate button from the list view:

All lists on this page should be empty.

“Divisional” EDI Tendering

By setting the SCAC field on a trading partner EDI Location record, you can set up “divisional” EDI tendering. This allows you to use the same Location Code for multiple accounts and differentiate them by also setting the SCAC field uniquely. Location Code + SCAC must be unique for each trading partner.

EDI Bulk Accept/Decline

The EDI Order Console allows for bulk 990 Accept/Decline transactions from the load list view:

EDI Load References

EDI Load- and Stop-level reference numbers are passed in the 204 tender transaction. They must be passed back to the trading partner via the outbound 990, 214, and 210 EDI transactions. They are stored in the Load References table, and accessible (read-only) via a related list on the Load Detail page:

EDI Setup and Processing Summary

1. Set up EDI global parameters from TMS Admin🡪Configuration.
2. If desired, set the Customer Charge Code on each Accessorial record.
3. Enter Kleinschmidt, Cleo, and/or Custom EDI credentials from TMS Admin🡪Credentials.
4. Set up each Trading Partner from TMS Admin🡪EDI Locations.  You may also bulk load this information if you have it. This will avoid the creation of duplicate accounts and contacts when EDI Load Tender (204) transactions are processed.  Enter values for the six override fields as needed.
5. Set up each EDI Bill To from TMS Admin🡪EDI Locations.
6. Start the EDIWatcherJob (which starts the EDIJob) batch job which does the following:
   1. Receives inbound Load Tender (204) transactions from customers.
   2. Receives inbound Load Tender Response (990) transactions from carriers.
   3. Receives inbound Load Status (214) transactions from intermodal carriers.
   4. Sends outbound Load Status (214) location updates to customers for moving loads.
   5. Sends outbound Load Tender Response (990) transactions to “auto-accept” customers.
   6. Receives inbound Load Invoice (210) transactions from carriers.
7. This job also sends EDI 214 status transactions for in-transit EDI loads for those customers requesting them.
8. Load Tenders are represented as Loads with an EDIStatus field value of Pending.
9. Load Tenders can be updated or cancelled by the client.  For trading partners that are not using the EDI Order Update Console, the EDI Status field in these cases changes to Updated by Customer and Cancelled by Customer, respectively. You must re-accept updated load tenders. For trading partners that are using the EDI Order Update Console, the EDI Status field will change to Update Pending from Customer when update 204s are received, which requires a user to process the update 204 from the EDI Order Update Console. See the section below for details on how to use the console.
10. For trading partners that are not using the EDI Order Update Console, Initiate Load Tender Response (990) transactions merely by changing the EDI Status field to Accept or Decline. You can also pass the EDI Decline Reason field by setting it on the Load.
11. You must respond to an EDI Tender before the EDI Response Deadline if this field is populated.
12. Shipment Status (214)transactions are sent when:
    1. Appointment Time is populated on a Stop.
    2. Arrival Date is populated on a Stop.
    3. Departure Date is populated on a Stop.
    4. Once a day location updates when a load is in-transit.
13. EDI 214 transactions can also be sent manually from the Load Detail page for completed/delivered loads.
14. Outbound Invoice (210) transactions are initiated by selecting Customer Invoices and clicking on the Generate & Send button from the Customer Invoice tab or individually by clicking the Send Via EDI button from the page layout.
15. Add the EDI Accept/Decline button to the load list view if bulk EDI 990 Accepts/Declines are desired.
16. Add the EDI Status button to the load list view if bulk EDI 214 send transactions are desired.
17. Note that the Stop table Carrier Status Reason picklist is used for EDI 214 status transactions. You may delete entries from this list, but do not add to or modify existing entries if you are using EDI.
18. The EDI Provider field on the Load table indicates which EDI Provider sent the Tender (204) Transaction.
19. For carriers that will receive EDI 204 tenders and send EDI 990 Accepts/Declines make sure the Carrier Service Tender Method field is set to EDI and that the EDI Provider field is also set.
20. A Quote/Contract Id is typically required for carrier quotes that are going to be tendered via EDI.
21. For each EDI Location that is a trading partner, add or configure EDI Update Setting and EDI Load Reference records as needed. Make sure these are related lists on the page layout.
22. Make sure the EDI Transaction table is on the Load page layout as a related list.
23. Note that the Load Container/Trailer Number field may be populated by an inbound EDI 214 transaction.
24. Set the Transportation Profile table Location Update Send Frequency field for those customers who require frequent EDI 214 X6 location updates for moving loads.
25. If Appointment Times are populated on an inbound EDI 204 tender, the corresponding EDI 214 Appointment Time status updates will automatically be sent on tender acceptance.
26. If you are using Orderful you must populate the Trading Partner ID from TMS Admin🡪Configuration.
27. You may use a custom EDI implementation by exactly implementing the web service methods in the EDI Specification. You then enter your URL and credential information from TMS Admin🡪Credentials, using the Custom EDI record. Note that the Custom EDI connector supports Basic Authentication.
28. For Inbound EDI 210s, the system will attempt to create a new or update an existing Vendor Invoice/Payable based on the following logic:
    1. If the PRO Number is provided in the 210, a search for the Load by this PRO Number is performed.
       1. If that search results in zero matches, a search for the Load by the Shipment Id (Load Number) is performed.
          1. If that search results in zero matches, the EDI Admin is notified by the EDI batch job error email.
       2. Else If that search results in multiple matches, a search by the PRO Number AND the Shipment Id is performed.
          1. If that search results in zero matches, the EDI Admin is notified by the EDI batch job error email.
    2. Else, a search for the Load by the Shipment Id (Load Number) is performed.
       1. If that search results in zero matches, the EDI Admin is notified by the EDI batch job error email.
    3. Assuming a matching load is found in steps a. or b. above, all Vendor Invoices(non-Accounting Seed)/Payables(Accounting Seed) for that Load are cycled through to determine if the EDI 210 matches one of them, and if so, it is determined if the invoice is in ‘Pending’ status and can still be updated. The following logic describes this flow:
       1. If the Vendor Invoice/Payable “Payee Reference” field matches the <InvoiceNum> from the EDI 210 AND the Vendor Invoice/Payable “Vendor” field matches the Id of the Vendor Account associated with the Trading Partner Id who sent the EDI 210 transaction, this constitutes a match.
          1. If a match is found and the “Invoice Status”(non-AS)/”Posting Status”(AS) is ‘Pending’ (non-AS)/’In Process’ or ‘Waiting for Approval’(AS), the invoice is updated with the data from the 210.
          2. Else If a match is found and the “Invoice Status”/”Posting Status” is NOT ‘Pending’/’In Process’ or ‘Waiting for Approval,’ the invoice is NOT updated with the data from the 210, and a failed EDI 210 transaction is logged.
       2. Else if no Vendor Invoice match is found, a new Vendor Invoice/Payable is created.

EDI Order Update Console

To activate the EDI Order Update Console for a trading partner, go to their EDI Location record and check the ‘Use EDI Order Update Console’ checkbox. Note that you cannot have both ‘Auto-Accept Update 204’ checked and the ‘Use EDI Order Update Console.’ 

With that checkbox checked, any inbound update 204s that are received for this trading partner will be saved as new EDI Transaction records to the corresponding Load record they are associated with. The loads receiving those updates will have their “EDI Status” field flipped to ‘Update Pending from Customer’. The EDI Transaction saved to the Load will be in a ‘Pending’ status, indicating that it needs to be processed with the EDI Order Update Console.

Access the console by clicking the hyperlink to the EDI Transaction record itself from the EDI Transactions related list on the Load page:

Upon clicking the link to the EDI Transaction detail record, the console should render on the second tab of the page:

The console will attempt to match-up the Stops and Line Items between the inbound update 204 and the existing Revenova Load for comparison purposes according to a “fingerprint” as defined below. There are five columns for each section:

1. Field Name: This is the name of the field on the object being updated.
2. EDI Update Value: This is the value of the field that is present on the inbound 204 update.
3. Current Value: This is the value of the field that is present on the existing Revenova Load.
4. Save As Value: This is the value that will be saved as an update to the Load, Stop, Line Item, etc. when one of the Save buttons is clicked.
5. Undo/Redo: This is a column of undo and redo buttons, which allows for quick accept/decline of a specific field in the console.

By default, the ‘Save As Value’ is populated with the same value as the ‘EDI Update Value.’ If that value is different from the ‘Current Value,’ it is highlighted in yellow, indicating a difference between the inbound 204 update and the actual value on the Load in Revenova. Clicking the Undo button sets the ‘Save As Value’ back to the ‘Current Value,’ removing the highlight. Clicking the Redo button sets the ‘Save As Value’ to the ‘EDI Update Value,’ which again will be highlighted if there is a difference. Users may also type directly into the ‘Save As Value’ field as needed.

Each section representing the different objects that make up the load has an expand/collapse button on the right-hand side for ease of navigation.

There are four buttons across the top right and bottom of the console, which perform the following actions:

• Accept & Save: Click this button to save all updates to the Load, Stops, Line Items and Customer Quote as indicated in the ‘Save As Value’ column. An EDI 990 Acceptance is sent, and the user is brought to the updated Load. The “EDI Status” field on the Load is flipped to ‘Accept.’
• Decline & Save: Click this button to save all update to the Load, Stops, Line Items and Customer Quote as indicated in the ‘Save As Value’ column. An EDI 990 Rejection is sent, and the user is brought to the updated Load. The “EDI Status” field on the Load is flipped to ‘Decline.’
• Show Updates Only/Show All Values: Click this button to show only the updates where the ‘Current Value’ is different than the ‘Save As Value’. Click the same button again to show all fields.
• Reload Console Data: If during processing, the user wants to refresh the data and start the processing over, clicking this button will re-load the console back to its original state.

Each section of fields has an Undo and Redo button at the top of the ‘Save As Value’ column, which will Undo or Redo the updates of all fields in the section for faster processing.

When processing the Stops, there are Up and Down arrows in the ‘EDI Update Value’ column, which allow you to quickly shift the Stops on the inbound update 204 for ease of ordering stops and processing.

Note that the Stop-matching logic attempts to align the stops according to a “fingerprint,” which is defined as:

Location Name + Location Shipping Street + Location Shipping City + Location State + Location Postal Code

The Line Item-matching logic attempts to align the line items according to a “fingerprint” defined as:

Name + Description + Handling Units + Pickup Stop Number + Delivery Stop Number

There are several validations built into the console for when the user attempts to Accept or Decline and Save to prevent users from mistakenly editing 204s with invalid data. Four important items to be aware of are:

1. Each saved stop must have a Number, Location Name, Shipping Street, Shipping City, Shipping State/Province, Shipping Zip/Postal Code, Shipping Country, Appointment Required, and Expected Date.
2. To have a stop removed, each of the fields in #4 should be blank.
3. Each saved line item must have an Item Number, Item Description, Weight, Weight Units, Pickup Stop Number, and Delivery Stop Number.
4. To have a line item removed, each of the fields in #6 should be blank.

After making the appropriate edits and either accepting or declining the load tender using the buttons at the top or bottom of the console, the user will be brought back to the Load detail page. The EDI Transaction that was just processed will now be in a ‘Success’ status, and the “Transaction Payload After Console Update” field on the EDI Transaction will be populated with the XML as updated by the user with the console.

API Integration Setup

TMS supports direct, API-based integration to the following carriers, load boards, FMCSA, advance payment, load tracking, EDI transaction processors, and map/miles data providers:

Carrier APIs

1. Project44 (LTL Carrier Aggregator)

2. Banyan (LTL Carrier Aggregator)

3. AccuFrate (LTL Carrier Aggregator)

4. Worldwide Express (LTL Carrier Aggregator)

5. SMC3 RateWare/CarrierConnect

Carrier Monitoring/FMCSA APIs

6. SaferWatch

7. RMIS

8. MyCarrierPackets

Route Map/Distance APIs

9. PC Miler

10. Rand McNally (Mileage only)

Load Tracking APIs

11. FourKites

12. Trucker Tools

13. MacroPoint

14. Project44

Rate/Load Board APIs

15. Internet Truckstop (Load Board, Truck Postings, and Market Rates)

16. DAT (Load Board, Truck Postings, and Market Rates)

17. LoadBoard Network

18. TransCore (Load Board, Truck Postings)

19. FreightWaves

20. Trucker Tools (Load Board, Truck Postings) 

EDI (via web service)

21. Kleinschmidt (Customer and Carrier Tenders)

22. Cleo (Customer Tenders)

23. Custom EDI Connector

Address Lookup APIs

24. Addrexx (US and International)

Advance Carrier Payment APIs

25. Comdata Comcheks

26. EFS MoneyCodes

27. TriumphPay

Rate History Upload

28. LoadDex

Fuel Indexes/Surcharges

29. Energy Information Administration (EIA)

30. Breakthrough Fuel

Invoice Processors

31. HubTran

ELD/Asset-Driver Tracking

32. Samsara

Cargo Insurance

33. Falvey

API-to-Email

34. Twilio

API Types

The carrier APIs provide capabilities for quoting, tendering, BOL creation, and receiving status updates for loads.  

The load board APIs allow for posting of loads, truck posting retrieval, and for access to market and historical spot customer and carrier rates.

The PC Miler API provides accurate route mileage and maps, and current driver location. Rand McNally supplements PC Miler by also providing route mileage (but not maps). Which product to use for mileage is a customer transportation profile setting.

SaferWatch, RMIS and MyCarrierPackets provide FMCSA data and insurance certificates on carriers.

Comdata and EFS provide issuing, blocking, unblocking, and cancelling ePayments to carriers and vendors. TriumphPay provides carrier quick pay capabilities.

FourKites, Trucker Tools, Project44, Truckstop, and MacroPoint provide GPS/Cell-based tracking of loads via the driver’s (smart) phone or in-cab ELD.

FourKites, Trucker Tools, and MacroPoint provide “push” status updates to the TMS via a page GET (MacroPoint) or a sites-based web service (FourKites and Trucker Tools).

MacroPoint supports status updates from the TMS to (ultimate) customer tracking sessions not initiated by the TMS.

Banyan, AccuFrate, Worldwide Express (WWEX) and Project44 provide APIs for LTL quote, tender, track, and document retrieval.

EDI support is for the following transactions:

The Addrexx API provides address lookup/completion:

• Get city and state given zip code
• Get zip code given city and state

The EIA provides weekly fuel indexes needed for fuel surcharge calculations.

SMC3 RateWare provides tariff-based LTL quoting capabilities, with transit times and terminal information provided by SMC3 CarrierConnect.

HubTran provides an AI-based vendor invoice parsing/reading capability that helps automate the quote/invoice reconciliation process.

Samsara provides direct integration to drivers and the assets they are driving via an ELD device and a phone application.

Falvey provides internal users and customer portal users the ability to directly purchase cargo insurance on loads.

Blue Yonder provides Blue Yonder customers with the ability to create loads, retrieve rates, and tenders loads within the TMS.

You must enable the APIs you are using and enter the appropriate credentials from the TMS Admin🡪Credentials page.

1. Set the Enabled flag appropriately for each record. (Disable APIs you are not using.)
2. Set the Test Mode flag to unchecked when you are finished testing.
3. Set the Options field for load boards and PC Miler.
4. Enter the credentials you were provided. Note that the default, dummy values indicate which fields are required for each API. Leave the dummy values for APIs you are not using.
5. Click the Save button in the section you are working on.
6. Note that DAT, Transcore, and Truckstop credentials are user-specific. Clone the original record and select new users, as needed, to enter additional DAT and Truckstop credentials.
7. Verify that Remote Site Settings are present for each API you are using from Setup🡪Security Controls🡪Remote Site Settings.
8. Comdata credentials are the most complex, requiring two user ids, two password 1s, a password 2, and two customer numbers. See the instructions below.
9. From TMS Admin🡪Credentials, populate the Vendor field for use Blue Grace, Worldwide Express, or any of the direct LTL API connections.

Queued Transactions and “Push” APIs

The following “push” APIs require a partner community to be set up to handle them. All inbound packets are inserted into the Queued Transaction table and processed by the QueuedTransactionJob.

• Project44
• Project44 Tracking
• MacroPoint
• FourKites
• Trucker Tools
• Trucker Tools Load Board (Book It Now only) 
• HubTran
• Truckstop (Book It Now only)
• Samsara

1. Create a new (“Build Your Own”) Partner Community named API that will receive all inbound (push) API data packets.
2. From the Builder on the home page click the left side Settings snowflake🡪General tab :
   1. Check the Public can access the community checkbox.
   2. Click the Guest User Profilelink at the bottom of the tab:
      1. Click on View Users and click on the user:
         1. Assign a TMS license to the guest community user.
         2. Assign the TMS API Community permission set.
3. Publish and activate the community.
4. Do NOT include ‘/s/’ in the URLs below.
5. From TMS Admin🡪Configuration set the Inbound API Community URL(without the ‘/s/’).  
   1. Example: https://full-revesc1.cs64.force.com/api
6. Update the post-back URLs of “push” APIs to use the community URL as the root:
   1. Project44: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=Project44&pwd=[credentials code field]
   2. MacroPoint: [Community URL]/services/apexrest/rtms/tmslistener
   3. FourKites: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=FourKites&pwd=[credentials code field]
   4. Trucker Tools: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=TruckerTools&pwd=[credentials code field]
   5. Trucker Tools Load Board: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=TruckerToolsLoadBoard&pwd=[credentials code field]
   6. HubTran: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=HubTran&pwd=[credentials code field]
   7. Truckstop: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=Truckstop2&pwd=[credentials code field]
   8. Samsara: [Community URL]/services/apexrest/rtms/tmslistener?org=[18-character org id]&source=Samsara&pwd=[credentials code field]
7. From TMS Admin🡪Configuration set the Queued Transaction Retention Period field to 1 day (or as desired). Records falling outside of the retention period are deleted.
8. From TMS Admin🡪Configuration set the Queued Transaction Maximum Process Count to “3” unless you have more available. Leave at least two for other batch processes.
9. From TMS Admin🡪Batch Processes start the QueuedTransactionJob. The job runs every minute and processes Queued Transaction records from the push APIs.
10. TEST ALL PUSH APIs.

API-Specific Information

Credential Requirements

This table summarizes which credential fields are required by API:

API-Specific Notes

1. SaferWatch
   1. Go to saferwatch.com to view your watch list or change your risk model settings.
   2. Use the same User Id and Password 1 as the TMS credentials to log into this site.
   3. The third credential (Service Key) is the same for all customers.
   4. The first, second, and fourth credentials are customer-specific.
2. RMIS
   1. The TMS online carrier application is never used with RMIS as onboarding of carriers occurs there.
   2. If you enable RMIS credentials the system ignores the SaferWatch credentials and settings.
   3. Unlike SaferWatch (where the CarrierMonitorJob is manually scheduled once per day) the CarrierMonitorRMISJob runs continuously. 
   4. The batch job brings down new carriers who have just applied and any old carriers that have FMCSA data changes.
   5. The config setting "Carrier Monitor Run Frequency (Mins)" determines how often the batch job runs.
   6. If the customer is already using RMIS, they need to populate the "Net Change Queue" with ALL carriers prior to you turning on the batch job. This will bring down all the carriers (once).
   7. If the customer is new to RMIS, you need to provide RMIS with a spreadsheet of all loaded carriers that includes carrier name, MC Number, DOT Number, Address, and Transportation Profile Id. Then RMIS will add the RMIS Id to the spreadsheet and send it back. You must then data load this data to populate the RMIS Id on all carrier TPs. This step is very important or you will get duplicates when you turn on the job. (The job matches on RMIS Id, then DOT Number, then MC Number, then Provincial Permit Number/Province. If no ID is present a duplicate carrier may be created.)
   8. Note that the Quick Carrier Review can only be used by carriers that RMIS has set up for you. You do not have access to all carriers when using RMIS. Only those who are set up in RMIS for your account.
   9. Verify the Minimum Weight, Maximum Weight, and Weight Units fields are populated correctly for each Mode record.
   10. Populate the RMIS Code field (left-side all caps values below) on Modes that match the definitions (the right-side mode names are not literal, but the codes are):
       1. MOTLDR - TL Dry
       2. MOTLRE - TL Reefer
       3. MOTLFL - TL Flatbed
       4. MOLTLT -- LTL
       5. MOIMDL - Intermodal
       6. MOTANK - Tanker
       7. MOBULK - Bulk
       8. MOOTHE – Other
   11. Initiate the CarrierMonitorRMISJob from TMS Admin🡪Batch Processes.
3. MyCarrierPackets
   1. The TMS online carrier application is never used with MyCarrierPackets as onboarding of carriers occurs there.
   2. The Saferwatch and RMIS credentials must be disabled and the MyCarrierPackets credentials enabled in order for the TMS to use the MyCarrierPackets API.
   3. The CarrierMonitorMCPJob runs continuously. The config setting "Carrier Monitor Run Frequency (Mins)" determines how often the batch job runs.
   4. Verify the Minimum Weight, Maximum Weight, and Weight Units fields are populated correctly for each Mode record.
   5. Initiate the CarrierMonitorMCPJob from the Job Monitor LWC.
   6. Preferences used by the MCP API:
      1. Allow Carrier Address Updates: when checked, the Shipping Address of the carrier will be updated to the information coming from MCP.
      2. Carrier Remit To Sync: when checked, the Carrier Remit To field of the carrier’s TP will be updated to Carrier Remit To information coming from MCP.
      3. Carrier Monitor Last Run: Date/time when the job last run. This value is used in several API calls to MCP.
      4. Carrier Monitor Run Frequency (Mins): how often the job run. The lowest setting is 15 minutes.
   7. The batch job runs in 3 different modes:
      1. First time run (Carrier Monitor Last Run preference is set to null/blank):
         1. Gets the list of monitored carriers from MCP and creates/updates those carriers in the TMS. The Carrier Monitor checkbox on the Transportation Profile of the carriers is set to true (e.g. carrier is monitored at MCP).
         2. Gets the list of carriers in the TMS where Carrier Monitor checkbox on the Transportation Profile of the carrier is set to false and registers that carrier as unmonitored at MCP.
         3. Get the completed packets from MCP and creates/updates those carriers in the TMS.
         4. Update the carriers in the TMS with the latest set of changes from MCP for monitored carriers only.
      2. Daily run Monday through Saturday (Carrier Monitor Last Run preference has a date/time in the past):
         1. Get the completed packets from MCP and creates/updates those carriers in the TMS.
         2. Update the carriers in the TMS with the latest set of changes from MCP for monitored carriers only.
      3. Sunday run:
         1. Gets the list of carriers in the TMS where Carrier Monitor checkbox on the Transportation Profile of the carrier is set to false and registers that carrier as unmonitored at MCP.
         2. Gets the list of monitored carriers from MCP and creates/updates those carriers in the TMS. The Carrier Monitor checkbox on the Transportation Profile of the carriers is set to true (e.g. carrier is monitored at MCP).
         3. Get the completed packets from MCP and creates/updates those carriers in the TMS.
      4. Update the carriers in the TMS with the latest set of changes from MCP for monitored carriers only.
4. Internet Truckstop (Load/Truck Board and Rates)
   1. Go to Truckstop.com to view loads you have posted via TMS, if desired.
   2. Your “handle” on this site must be identical to your TMS user name (as seen in the upper right corner of TMS) in order for the API integration to function.
   3. Your login credentials for this site are not the same as the TMS credentials.
   4. Use the Revenova-provided User Id and Password 1 for your TMS credentials.
   5. Use a customer-specific numeric identifier for Password 2.
5. Internet Truckstop 2 (New API Family)
   1. You must use OAuth to retrieve access and refresh tokens for each user.
   2. Complete Login Process:
      1. Navigate to TMS Admin🡪Credentials and select Truckstop 2 from the dropdown.
      2. Enter the Client ID in the User Id field.
      3. Enter the Client Secret in the Password 1 field.
      4. Enter the Redirect URL in the Password 2 field.
         1. https://login.salesforce.com/apex/rtms__oauthcode for production
            1. (You may also use <mydomain>/apex/rtms__oauthcode) 
         2. https://test.salesforce.com/apex/rtms__oauthcode for sandbox
         3. Note that you must provide these URLs to Truckstop.
      5. Click the Save button.
      6. Click the Auth button and enter your Truckstop account credentials on their login page.
      7. Click the Get Tokens button on the OAuth page.
   3. If using Truckstop Book It Now functionality:
      1. A Terms and Conditions must be created within the Truckstop environment. 
      2. You must set up the “Post-back” URL with Truckstop support for the inbound Book It request: 
         {API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=Truckstop2&pwd=4wGFDgnT950Ovg1
         
      3. Truckstop support must enable the LOADBOOKED and optionally enable LOADDROPPED webhook events and disable all other webhook events.

6. Truckstop Tracking

1. You need four credentials for Truckstop Tracking:
   1. Used Id: “Account Id” (email address)
   2. Password1: “Password”
   3. Password2: “Secret”
   4. Customer Number: “client_Id”

7. Blue Grace

1. You must inform Blue Grace that the “Load Book Number” (our load number) is the primary reference for tendering and tracking.

8. DAT

1. DAT credentials are user-specific.
2. DAT current and historical rate web service calls are cached to reduce usage charges.

9. Comdata

1. Seven credential fields are required.
2. For the User Id, Password 1, and Customer Number, enter the two credentials items with a semi-colon separating them.

10. EFS

1. The Master Contract Id is usually “0.”

11. Project44

1. Provides a direct pass-through to the carrier APIs. You must set up an account on the Project44 web site and enter the carrier credentials you have for each carrier you want to employ.
2. If you want to use customer-specific pricing you must:
   1. Create a Login Group for each customer on the Project44 web site.
   2. Populate the customer-specific credentials for each Login Group.
   3. Populate the Carrier API Login Group field on the customer Transportation Profile with the Login Group Key.
3. There are TWO remote site settings required. One for the API and one for the BOL document URL.
4. A BOL # is NOT generated by Project44, but is generated and passed from the TMS during the tender operation.
5. Load status API calls may return signed BOL and POD images.
6. You must properly-configure carrier pickup notes on the Project44 web site to prevent tenders from failing (if the note is too long).
7. A Bill of Lading Number must be present to use the Truckload load tracking API.
8. You may set up multiple contracts for a given capacity provider by naming them uniquely on the Project44 portal:
   
9. Project44 supports a “login group cascade” concept.  You can define two login groups – setting the Carrier API Login Group field at both the customer and default transportation profile levels.  When quotes are retrieved from Project44, two queries are made, one with each login group. Quotes retrieved from the first query are masked out of the second query.
10. Inquire of Project44 what customer-specific URL documents will be available from and add it as a Remote Site Setting. It will be of a format such as https://prod-44742-images.s3.amazonaws.com.
11. Set the Pickup Only flag on Project44 carrier services if you do not want an immediate PRO Number generated. (If the PRO Number changes later tracking data will be invalid.)
12. Project44 relies on a “push” approach to event processing, like MacroPoint.   
    1. A TMS web service “listener” handles events pushed from Project44 in real time.
    2. You must set up the “Post-back” URL with Project44 support to point at your listener:

{API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=Project44&pwd=4wGFDgnT950Ovg1

12. Project44 Tracking

1. Note that you do not have to provide a listener URL for push updates from Project44 Tracking as the push URL is automatically created via the API when tracking is initiated.
2. The webhook ‘configName’ for tracking is:
   1. Unified tracking: “unified-“ + 18-character org ID
   2. Truckload tracking: “truckload-“ + 18-character org ID

13. PC Miler

1. The API Key is the only credential used for authentication.
2. Check Dynamic Maps Enabled from TMS Admin🡪Configuration only if you purchased ALK Maps.
3. The version of mileage data used can vary by customer. Set the Mileage API Version on the customer transportation profile as desired.
4. Set the Mileage API Routing to Practical or Shortest on the customer Transportation Profile as desired. The default behavior is Practical.
5. Make sure the following CSP Trusted Site is enabled: *.alk.com

14. MacroPoint

1. The ID and password used to access their web site are NOT what we use for API connections.
2. MacroPoint can also send tracking updates from the TMS to tracking sessions initiated by other systems. These events include Appointment Time, Stop Arrival, Stop Departure, and Location Update.
3. Set the Tracking Update Frequency (Minutes) configuration field to “meter” how many location updates you track in a given time period.
4. To use MacroPoint ELD trackingyou must provide MacroPoint a spreadsheet with the following data:
   1. Carrier Name
   2. Carrier Id (18-character Account Id – use CASESAFEID formula field to get this value)
   3. Carrier DOT
   4. Carrier MC Number
   5. Carrier NSC Number (Canada)
   6. Carrier CAAT (Mexico)
5. MacroPoint relies on a “push” approach to event processing.  
   1. A TMS web service “listener” handles events pushed from MacroPoint in real time.
   2. You must set up the “Post-back” URL with MacroPoint support to point at your listener:

{API COM URL}/services/apexrest/rtms/tmslistenerTMS users can share MacroPoint updates with the designated customer on a Load. Make sure the MacroPoint Customer Id is set on the (Load) customer Transportation Profile:

When clicking the Track button on the Tracking Log widget for Loads for this customer, and additional checkbox is provided to have MacroPoint share Load updates with both the TMS user and the Customer:

Make sure the MacroPoint IP Address field is populated from TMS Admin🡪Configuration. Any load status post-backs from MacroPoint that do not originate from this IP mask are rejected as a security feature.

15. LoadDex

1. You must update the Service URL and Remote Site Setting with your customer-specific URL as provided by LoadDex.

16. FourKites

1. FourKites relies on a “push” approach to event processing, like MacroPoint.   
2. A TMS web service “listener” handles events pushed from FourKites in real time.
3. You must set up the “Post-back” URL on the FourKites web site to point at your listener.
   1. From the Four Kites portal, go to Settings🡪3^rd Party Integration.
   2. Enter the Update Url based on your “email loop” sites page URL, 18-character org ID, and FourKites API credentials code (last column on page).  For example:
      {API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=FourKites&pwd=4wGFDgnT950Ovg1
   3. Enter the Authorization Scheme: No Authorization.
   4. You must contact FourKites and have them provision the following call-back events:
      1. Location Update
      2. Carrier ETA Update
      3. Stop Arrival
      4. Stop Departure
      5. User Note
4. Location and Carrier ETA event frequency is based on the following heuristic:
   1. If pickup/delivery day, every 30 minutes
   2. Else, every 4 hours

17. Trucker Tools

1. Trucker Tools relies on a “push” approach to event processing, like MacroPoint.
2. A TMS web service “listener” handles events pushed from Trucker Tools in real time.
3. TruckerTools relies on a “push” approach to event processing.
   1. A TMS web service “listener” handles events pushed from TruckerTools in real time.
   2. You must set up the “Post-back” URL with TruckerTools support to point at your listener:

{API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=TruckerTools&pwd=4wGFDgnT950Ovg1

18. Trucker Tools Load Board

1. Truck posting search: 
   1. The searching user email inside Revenova must match the username in Trucker Tools.
   2. A load must be posted to the load board to search for trucks on the load.
   3. Trucker Tools will only return in network carriers in Trucker Tools when returning trucks. To add carriers to Trucker Tools either follow the directions in their portal or reach out to a Trucker Tool representative. When generating a .csv file of the carriers the external Id will be the carrier’s Account Id in Revenova. The columns in red require values:

      company_ name

      mc

      dot_ number

      ext_ id

      truck_ numbers_range

      truck_ numbers

      contact_ email

      contact_ phone

      can_see_ loads

      book_it_ now

2. USD currency must be enabled to use Book It Now functionality.
3. If using Book It Now functionality you must set up the “Post-back” URL for the inbound Book It request: 

{API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=TruckerToolsLoadBoard&pwd=4wGFDgnT950Ovg1

19. EIA

1. Obtain an API Key from https://www.eia.gov/opendata/register.php.

20. BIC

1. Obtain a user Id and password from https://www.bic-boxtech.org.
2. The password2 value for BIC credentials is (always) YmljYXBwOmJpY3NlY3JldGFwcA==

21. SMC3

1. SMC3 provides Line Haul (only) via their APIs. Set up Accessorials and add Fuel Surcharge to the SMC3-related Rate Entries to incorporate locally-calculated accessorials and fuel surcharges.
2. Make sure to enter the Tariff Effective Date for all Rate Entry records.
3. When available, terminal information is provided for the pickup and delivery stops and is stored on the carrier quote and first/last stops.
4. To treat discounts like surcharges, check the Apply As Negative Discounts checkbox. With this option, discounts will be added tot he freight chargest returned from SMC3 rather than subtracted.

22. AccuFrate

1. You must run the Load Status Batch Job if you want automatic tracking updates from AccuFrate.

23. HubTran

1. Credentials consist of:
   1. User Id: Revenova
   2. Password1: Revenova
   3. Password2: API Token (Looks like bf5f267000ae8e8e6pe0ef656746588x)
2. Credentials can be group-specific. Set the HubTran Credentials Selector field from TMS Admin🡪Configuration to use group-based credentials and enter all the credentials from TMS Admin🡪Credentials.
3. You must provide a URL for the “pushed” invoice documents and totals similar to other “push” APIs above:
   {API COMM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=HubTran&pwd=0mIMLnLen2BP6qF0
4. You must set the Vendor Invoice Processor field on the Transportation Profile record for all participating carriers to “HubTran.”
5. You must set the Vendor Invoice Processor field on the Load record for all participating loads to “HubTran.” This is set on carrier assignment if you do not set it earlier.
6. Make sure to add the Vendor Invoice Number, Vendor Settlement Total, and Vendor Settlement Variance, and Vendor Invoice Date fields to the Carrier Quote (as read-only fields). These fields will be populated by HubTran.
7. Bill of Lading Number on the Load record may also be populated by HubTran if available.
8. HubTran must provide login credentials to users to access their web portal. There users can review and approve invoices and deal with exceptions related to the auto-parsing of invoices and other documents.
9. To maximize the performance of HubTran, make sure to populate the SCAC, MC Number, US DOT Number, and Billing Address fields as well as possible for all participating carriers. Also add all carrier contact emails and keep them up to date. The email used for carrier documents sent to HubTran is a major determinant in the proper routing/parsing of them.
10. You must pre-load carriers and loads into HubTran. Click the HubTran Data Load button from TMS Admin🡪Configuration to do this. This can be done multiple times. Only loads for participating carriers will be uploaded to HubTran.
11. Note that load information is resent to HubTran when a load changes in any significant way.
12. If the Carrier Remit To on a carrier’s Transportation Profile is updated, the updated carrier information is sent to HubTran.
13. The Accounting Notes is passed to HubTran.
14. The Load TMS19 Field Set and Stop TMS2 Field Set are used to pass “flex” references to HubTran.

24. LoadBoard Network

1. The service key is the same for all Revenova customers.

25. TransCore

1. Note that you must post a load on the load board in order to search for trucks for that load!

26. Banyan

1. You must run the LoadStatusUpdateJob to get load tracking updates from Banyan. There is no load-specific status call for Banyan loads.
2. You may add additional accessorials and limited access accessorial as they become available by adding API Accessorial records for Banyan. See the development team for more information.
3. Both Code and Subcode must be populated correctly for Banyan API Accessorial records.
4. Make sure the two Credentials checkbox options – Shipper Rates and Submit Pickup – are set correctly.
5. We pass a “ClientRefNum” field to Banyan to determine which rates are used when quoting. This defaults to the 18-character org Id unless the Customer Transportation Profile’s Carrier API Login Group field is populated, in which case it uses that. Make sure to communicate all values for this field to Banyan during project setup.

27. Breakthrough Fuel

1. You must populate the Breakthrough Fuel Shipper Id on all customer Transportation Profiles who are using BTF.
2. The Customer Load Id must be populated on the Load in order to retrieve BTF data. This is the load identifier shared across BTF and TMS.

28. Worldwide Express

1. Add any of the following Accessorial and API Accessorial records that you need.

29. Samsara

1. Samsara relies on a “push” approach to event processing, like MacroPoint.
   1. A TMS web service “listener” handles events pushed from Samsara in real time.
   2. You must set up the “Post-back” URL with Samsara support to point at your listener:

{API COM URL}/services/apexrest/rtms/tmslistener?org=00D180000008oA9EAI&source=Samsara&pwd=4wGFDgnT950Ovg1

30.Twilio

1. User ID is the single verified sender email address from Twilio if you are using this option. If you have performed the Domain Authentication setup, enter “Revenova” for the User ID.
2. Password1 is the API Key generated on the Twilio portal.

31. Blue Yonder

1. Access tokens to Blue Yonder are granted through OAuth 2.0 Client Credentials grant type. The User ID represents the Client ID and Password 1 represents the Client Secret.
2. The Blue Yonder credentials are used only for returning rates to the Blue Yonder system. All other actions are performed by the REST based classes in the TMS.
3. The EDI Tenders checkbox under the Blue Yonder credentials should be enabled if the tenders to Blue Yonder loads will be done via EDI instead of through Blue Yonder. Enabling the field will automatically populate relevant EDI fields on Blue Yonder loads.

SMC3 Quoting + Project44/Banyan Tender/Track/Images

You may set up hybrid API carrier services that employ SMC3 for quoting and Project44 or Banyan for tendering, tracking, and image retrieval. These carrier services should be set up with the SMC3 RateWare Credentials Id.

Carrier Monitoring API Field Mapping

The following fields are inserted/updated by the Carrier Monitoring APIs as follows:

I – Insert

U – Update

(1) => update if the global setting “Allow Carrier Address Updates” is checked OR the value in the TMS field is null 

(2) – update if the value in the TMS field is null

(3) – update if there is a value in the response 

(4) – update if there is a value in the response AND the value in the TMS field is null

(5) – update if the global setting “Carrier Remit To Sync” is checked AND the response has factor company information

(6) – update to ‘Pending’ if RMIS Certified is not ‘Yes’

I – Insert

U – Update

(1) => update if the global setting “Allow Carrier Address Updates” is checked OR the value in the TMS field is null 

(2) – update if the value in the TMS field is null

(3) – update if there is a value in the response 

(4) – update if there is a value in the response AND the value in the TMS field is null

(5) – update if the global setting “Carrier Remit To Sync” is checked AND the response has factor company information

(6) – update to ‘Pending’ if RMIS Certified is not ‘Yes’

Queued Transactions

The following transactions are queued in the Queued Transaction table and then processed by the QueuedTransactionJob, which run every minute.

Inbound Transactions

• “Email Loop” transactions from customers and carriers
• Project44 LTL load status updates
• Project44 TL load status updates
• Project44 Unified load status updates
• MacroPoint load status updates
• FourKites load status updates
• Trucker Tools load status updates
• HubTran invoice transactions
• Carrier App Update Transportation Profile
• Carrier App Generate PDF
• Samsara driver/asset events

Outbound Transactions

• HubTran carrier and load updates
• HubTran document retrieval
• MacroPoint outbound updates
• Load Posting removal for covered loads
• EDI 214 transactions – Appointment, Arrival, Departure, Loading Complete, Unloading Complete
• Project44 Unified load status start/stop

Note that in an effort to reduce the footprint of this set of jobs, we are shunting some traffic to the Queued Transaction Event Platform Event (object) for asynchronous non-batch processing. Current traffic that can be shunted:

• HubTran outbound carrier and load updates
• HubTran document retrieval

Lanes and Zones

Lanes and Zones are globally defined – and usable across all shippers and consignees from the TMS Admin tab.

Lane Setup

Click on the Lanes link to access the global list of all Lanes. There are seven types of lane start/end point types:

“Location” types refer to unique account records, which represent distinct locations in the TMS such as a warehouse, factory, corporate HQ, etc.

You can mix and match origin and destination types when defining a lane. For example, Origin = “Chicago, IL” and Destination = “California.”

Zone Setup

Click on the Zones link to access the global list of all zones. There are seven types of zones:

Zones represent origin and destination location “bags” and are an efficient way to capture arbitrarily-complex lanes.

For example, assume you have 50 cities that fall evenly into two zones.  To define a lane using the two zones would require three setup steps: Defining zone one, defining zone two, and defining the zone-one-to-zone-two lane. Using lanes only would require 25 x 25 = 625 distinct lane setups, or 1250 setups if you needed bi-directional lanes.

Accessorials

Accessorial tracking is a pervasive aspect of TMS for almost every step in the lifecycle of a load. They are manually or automatically associated with loads, quotes, and invoices over time. In rough chronological order, accessorials come into play as follows:

1. A global list of “generic” accessorials is defined in TMS.
   1. These records are stored in the Accessorial table.
2. API-specific versions of the generic accessorials needed to invoke specific carrier aggregation APIs.
   1. These records are stored in the API Accessorial table.
3. Generic accessorials are optionally associated with a load when it is created/configured.
   1. These records are stored in the Load Accessorial table.
4. Accessorials to be automatically added to a load upon creation are stored in the Default Accessorial table.
5. Auto-costed Accessorials can be defined in Rate Entry table records.
6. Customer Quotes are manually/automatically generated for a load, with associated quotes for accessorial charges.
   1. These records are stored in the Customer Quote Accessorial table.
7. Customer Invoices are manually/automatically generated for a load, with associated accessorial charges.
   1. These records are stored in the Customer Invoice Accessorial table.
8. Carrier Quotes are manually/automatically generated for a load, with associated stored, API-based, or entered accessorial charges.
   1. These records are stored in the Carrier Quote Accessorial table.
9. Vendor/Carrier Invoices received can be entered into TMS, with associated line item accessorial charges.
   1. These records are stored in the Vendor Invoice Accessorial table.
10. Accessorial Exclusions are defined to exclude certain carriers from being assigned to loads with specific accessorials.
    1. These records are stored in the Accessorial Exclusion table.

These ten accessorial tables are highly interrelated to properly track and reconcile accessorial charges during the lifecycle of a load.

Access the global accessorial list from the TMS Admin🡪Accessorials link. Disable those accessorial charges that you never want to associate with loads.  

Stop Charges

Stop Charges can be added to stored rate customer and carrier quote/invoices via stored rate setup. These are accessorial charges that are not explicitly added to loads – they are automatically added to customer and carrier quotes based on stored rate setup.

You may add accessorials as needed, but API-based Carrier Quotes (usually for LTL carriers) cannot process user-added accessorials.

API-based carrier service accessorials (usually for LTL carriers) are pre-loaded, as these are defined by the technical integrations to these carriers. When you create new Carrier Services, use the Transportation Profile detail page to enter carrier-specific assessorial stored rates.

DO NOT CHANGE THE NAME OF THE GENERIC ACCESSORIALS AS SOME CARRIER APIS DEPEND ON THESE NAMES.

Hazardous Materials Support

The Revenova TMS supports hazardous material loads via fields on the Line Item record:

The HazMat checkbox field automatically rolls up to a Load-level field of the same name.

The Blue Grace, Worldwide Express, and Project44 LTL API all support hazardous materials quoting and tendering with some variation regarding what details are passed to the carriers.

The Transportation Profile

The Transportation Profile extends the Salesforce concept of an account to include additional information related to configuring, quoting, tendering, and tracking loads. The logistics concept of a “Routing Guide” is contained in the Transportation Profile and supporting tables for shippers, brokers, and consignees.

The Transportation Profile record also is used to store and analyze carrier data, and forms the home page for the TMS Carrier Management function.

An Account table lookup field (Transportation Profile) references this additional information.

Note that one Transportation Profile record can be shared by multiple related accounts. For example, a large customer with 10 account (location) records in the TMS may all reference the same single Transportation Profile record.

There are six types of Transportation Profiles, corresponding to the six types of accounts (for logistics purposes):

Transportation Profile Auto-Creation

Transportation Profile records are automatically created and associated with an account whenever an account is inserted or updated under the following circumstances:

• There is no existing Transportation Profile populated on the account record.
• The TMS Type field is populated with anything other than Factoring Company or Customs Broker.

This auto-creation occurs during the following TMS activities:

• Manual creation of an account from the New account button.
• Creation of a load with new Customer, Shipper, or Consignee accounts.
• Creation of a load on the Customer Portal with new Shipper or Consignee accounts.
• Creation of an account during the entry of an online carrier application.

Note that the TMS Type for Sharing field duplicates the TMS Type field value but is accessible as a criterion for account sharing rules. It should not be displayed on the account page layout.

Transportation Profile (TP) Processing Logic

When a TMS Load is created and worked, there are several Transportation Profiles that can affect the process:

• The Customer Account’s Transportation Profile
• The Bill To Account’s Transportation Profile
• The Stop Location Accounts’ Transportation Profiles
• The Global Default Transportation Profile
• The Carrier Account’s Transportation Profile

The following details how these Transportation Profile (TP) records and associated routing guide information (if present) interact with the Load during its lifecycle:

1. Stop Creation
   1. The Stop’s Appointment Required field is copied from the Location TP.
   2. If null, the Stop’s Instructions field is copied from the Location TP.
2. Stop Creation/Update
   1. If null, the Stop’s Shipping/Receiving Hours field is copied from the Location TP.
3. Load Creation/Update
   1. A Transportation Profile for the Load is searched for in this order: Customer🡪Global. If null, the Load’s Payment Terms field is copied from the TP if present there.
   2. If null, the Load’s Customer Bill To field is copied from the Customer TP.
   3. The Load’s Tax Exempt field is copied from the Customer TP.
   4. The Customer TP Customs Brokers records are examined for any cross-border loads, and the appropriate one assigned to the load.
   5. The carrier TP Carrier Remit To will be populated when a load is tendered to a carrier.
4. Load Accessorials
   1. If Default Accessorials are defined for any stop account’s Transportation Profile, they are automatically added to the load upon creation.
5. Stored-Rate Customer Quote Auto-Creation
   1. A Transportation Profile for the Load is searched for in this order: Customer🡪Global.
   2. Lane/Rate matches for the Load from the TP are searched for and used to construct quote(s).
   3. TP Fuel Surcharge is used to calculate the quote’s fuel surcharges, if present.
   4. TP Accessorial charges are used, if present.
6. Carrier Quote Auto-Creation
   1. A Transportation Profile for the Load is searched for in this order: Customer🡪Global.  
   2. Carrier Service/Lane/Rate matches for the Load from the TP are searched for and used to construct quote(s).
   3. If a carrier is in the Carrier Exclusion table for a given customer/global transportation profile, it will not be considered.
   4. For Stored Rate Quotes:
      1. The Fuel Surcharge associated with the Carrier Service from the TP is applied.
7. Customer Invoice Creation
   1. The Load’s Bill To TP is used to determine the invoice’s POD Required and Billing Method values.
8. Load Tender 
   1. A Transportation Profile for the Load is searched for in this order: Customer🡪Global.
   2. The TP defines which Carrier Service record is used to determine tendering method and carrier contacts.
9. Tender Document Creation
   1. A Transportation Profile for the Load is searched for in this order: Customer🡪Global.
   2. The TP determines which tender documents to produce, if present.   
   3. Else, the Product Configuration global setting determines which documents to produce.
10. Bill of Lading Creation
    1. The SCAC field from the Carrier TP is displayed on the Bill of Lading.
11. Carrier Equipment Type and Cargo Carried
    1. Carriers can be filtered in/out of the Available Carrier list via the Carrier Equipment Type related list and the Cargo Carried picklist on the Carrier TP.

Customer/Shipper/Consignee Transportation Profile Setup

From the Transportation Profiles tab, click the New button.

Select Record Type of Shipper/Consignee and click the Continue button. Fill in the appropriate header information and click the Save button:

Much of the information above defaults into loads when created, and each customer, bill to, shipper, and consignee may have an associated transportation profile.

The Refresh Credit button recalculates the A/R balances and credit limit available for this customer.

The Invoice Docs button navigates to the customer-specific invoice document requirements page.

Default Accessorials

A location/profile may always require certain accessorials. Create them for each Shipper/Consignee profile that requires them:

Carrier Exclusions

If a customer wants to exclude one or more carriers from being considered for quote/tender, add these via the Carrier Exclusions related list. Carriers can be excluded by:

• Global/Customer Transportation Profile
• Carrier
• Carrier Service
• Lane
• Location
• Exclusion Type
• Effective Date 
• Expiration Date

Excluded carriers will not be included in the FQA or any stored carrier rate-generated Carrier Quotes.

Carrier Markup Group Assignment

Assign a Carrier Markup Group to the global and/or customer transportation profiles to support cost-plus customer quotes.

Customs Broker Support

TMS supports customs brokers for cross-border loads. Customs brokers are set up in the Customer Transportation Profile:

Load fields capture cross-border information:

• Entry Number
• Clearance Number
• Customs Broker

Accounts can be designated as Customs Brokers:

And all this information comes together on the Carrier Rate and Load Confirmation and Driver Load Confirmation documents:

Note that the Load’s Customs Broker field is auto-assigned on load creation based on the load from/to countries and the customer Transportation Profile settings.

Customer Reference Numbers

If a customer has specific reference numbers corresponding to Load or Stop fields that they always require, those reference numbers can be populated in this “Customer Reference Numbers” table. A customer can have zero-to-many reference number records defined. Each Customer Reference Number record defines the TMS Object (Load or Stop), the TMS Field (Load or Stop fields), the Mode, and the Load Validation Status (Tendered, Assigned, Dispatched, In Transit or Delivered). For customers with these reference number requirements created, a modal will pop-up on the Load at different events in the Load lifecycle if the required field is blank. The modal will warn the user that one of the customer’s required reference number fields is not populated, and it will allow the user to either populate and save the field updates or skip the warning entirely. Note that any Load or Stop field can be added to the ‘TMS Field’ picklist, including custom fields.

The events that will cause the modal to pop-up are:

• Clicking the ‘Tender’ or ‘Assign’ button on the Carrier Quote Builder (Load Status moving to ‘Tendered’ or ‘Assigned’).
• Clicking the ‘Tender’ or ‘Assign’ button on the Carrier Quote List (Load Status moving to ‘Tendered’ or ‘Assigned’).
• Clicking the ‘Save’ or ‘Thumbs Up’ button on the Stop Detail widget for the first stop or last stop of the Load after making a Stop Status update (Load Status moving to ‘Dispatched’, ‘In Transit’ or ‘Delivered’).

Broker/3PL Transportation Profile Setup

This process is virtually identical to the Shipper/Consignee process, with slightly different header information exposed.

Stored customer and carrier rates can be defined for this type of profile, as it is often selected as the type for the global transportation profile.

Stored Rate Support

Summary

TMS supports the entry of both customer and carrier stored/negotiated rates and lanes via the Rate Entry LWC and Lane LWC:

Lanes can be defined by any A-to-B permutation of the following:

• Country
• State
• City
• Zip 3
• Zip 5
• Postal Code
• Location (Account)
• Zone

Customer and Carrier rate entries can be based on the following calculation methods:

• API
• Email
• Manual
• Fixed Amount
• Per Mile
• Per Kilometer
• Per Pound
• Per Pound (Billable)
• Per Kilogram
• Per Kilogram (Billable)
• Per CWT
• Per Ton (US)
• Per Cubic Foot
• Per Cubic Meter
• Per Gallon
• Per Liter
• Per Linear Foot
• Per Square Foot
• Per Square Meter
• Per Handling Unit
• Per Packaging Unit
• Per Equipment Type
• Per Stop
• Per Day
• Per Hour
• Percent of Amount
• Per 100.00 of Amount

Rate Entries can have a Base, Minimum, and/or Maximum calculation defined, using the following logic when calculating the cost for a quote:

If(Base Cost > Maximum Cost) {

               Use Maximum Cost

}

Else If(Base Cost < Minimum Cost) {

               Use Minimum Cost

}

Else {

               Use Base Cost

}

If two Rate Entry records match when generating a stored rate customer quote, the Lane Rate Entry Match Priority field will determine which Rate Entry is used based on the sum of the Origin and Destination Type score as follows (lowest score record is selected):

1. Location         => 10,
2. Postal Code    => 40, 
3. Zip5              => 60, 
4. Zip3              => 80,
5. City               => 100,
6. State             => 120,
7. Country         => 140,

Zone Match Priority:

1. Location         => 20,
2. Mixed             => 30,
3. Postal Code     => 50,
4. Zip5               => 70,
5. Zip3               => 90,
6. City/State       => 110,
7. State              => 130,
8. Country          => 150,

Billable Weight-Based Notes

The Rate Entry DIM Factor field is used to calculate the DIM (Dimensional) Weight. TMS calculates the DIM Weight by dividing the volume of the load by the DIM Factor. If the load does not have the volume specified, TMS will calculate the volume based on the handling unit L/W/H dimensions of the line items of the load.

The Billable Weight will be the greater value of the DIM Weight and Total Weight on the load.

The DIM Weight and the Billable Weight are on the Customer Quote and Carrier Quote objects are populated by billable weight-based rate entries. They are in the load  weight units.

Global Rate Entry Access

You can access all customer and carrier stored rates from TMS Admin🡪Rate Entries:

Fuel Surcharges

Fuel Surcharges are specified at the Rate Entry record level. This means that the fuel schedule can vary by Customer, Carrier Service, Lane, Mode, etc.

Accessorial Negotiated Rates

All negotiated rates should be set up as Rate Entries of Rate Type Accessorial.

RFP Support

Customer and Carrier RFP support is now available in the TMS, including the bulk import of lane/rate spreadsheets to facilitate setup, response, and operationalizing RFP-based stored rates.

Lanes and Rate entries can be uploaded from a .csv file via the RFP Banner LWC:

LTL Tariff Rating Support

LTL Tariff-based carrier and customer quotes are available via the SMC3 API integration. From TMS Admin🡪Rate Entries, define Tariff Schedules as inputs to the rating process.

Tariff-Based Rate Entries

Associate Tariff Schedules with the appropriate Rate Entries from TMS Admin🡪Rate Entries. You can also elect to prevent deficit rating with SMC3 by checking the Prevent Deficit Rating checkbox on the Rate Entry record. As a shipment increases in weight, the rate per 100 pounds will decrease. Within each weight break there is generally a point at which the charge would be lower if a higher weight break were used (alternation). This is when deficit weight rating is used. The weight necessary to take the shipment up to the higher weight break is added to the shipment so that the shipper gets the benefit of the lower rate. If the Prevent Deficit Rating checkbox is checked, the maximum weight to stop the rating alternation is set equal to the total load weight plus one pound. Stop Alternation allows the user to turn off a desired weight level (and higher). 

SMC3 Carrier Service Setup

To set up an SMC3-based carrier service, perform the following steps:

• Quote Method Field Setting: API
• Tender Method Field Setting: Email
• Status Method Field Setting: Email
• Credentials Field Setting: The record Id of the SMC3 RateWare credentials from TMS Admin🡪Credentials

Note that you can set up Fuel Surcharge and Accessorial rate entry records for SMC3-based quotes (as only Line Haul is provided via the API).

SMC3 Quoting and Invoicing

When utilizing SMC3 to retrieve customer or carrier quotes via API, the itemized freight charges by load line item will be captured on the Customer Quote Freight Charge Item and Carrier Quote Freight Charge Item objects respectively, which can be viewed from the record detail page.

For customer invoicing, if there are Customer Quote Freight Charge Items associated with the Customer Quote associated with the Customer Invoice being processed, those itemized freight charges will appear in the invoice PDF.

If the invoice is an EDI invoice, the itemized freight charges will be included in the EDI 210 XML (see the Revenova TMS 7.9 EDI Specification for details of the XML transaction). Note* - if you plan to utilize this itemized freight charge format, you will need to contact your EDI VAN (e.g., Kleinschmidt) to ensure they have the configuration and mapping set up to process the additional elements.

Rerate/Rebill

Users can be notified of changes in loads that require requoting or re-invoicing. This capability is turned on by Mode by setting the Rerate Notification field.

Three fields on the load table manage this information:

• Carrier Rerate Notification – “true” if a change has occurred requiring rerating.
• Customer Rerate Notification – “true” if a change has occurred requiring rerating.
• Rerate Fingerprint – stores the most recent hash of the load configuration.

Three field sets control which fields are monitored for changes to the load “fingerprint”:

• Load TMS11
• Stop TMS5
• Line Item TMS2

The customer quote portion of the Freight Quote Assistant has new components to support rerate/rebill:

• Refresh Quote/Rerate Quote Badge – visible when a change has occurred requiring rerating.
• Rerate Button – visible when a quote can be rerated/refreshed and user has rights to this button.
• Update Invoice Button – visible when a pending invoice exists for this quote and user has rights to this button.
• Lock Button – visible if user has lock rights to this button.

The user object Rerate/Rebill Permissions field controls which users have access to these added buttons.

The carrier quote portion of the Freight Quote Assistant has new components to support rerate/rebill:

• Refresh Quotes/Rerate Quote Badge – visible when a change has occurred requiring rerating.

Note that only stored rate and marked-up quotes can be auto-rated.

A new Customer Quote field, Billing Status, can be used to auto-create the Customer Invoice by setting it from Pending to Approved and saving the Customer Quote.

Carrier Management

The carrier’s Transportation Profile record functions as the “home page” for the TMS Carrier Management function. Carrier Management capabilities include:

1. An online application carriers can use to request addition to your carrier network.
2. Storage of critical carrier information needed for quoting, tendering, and tracking loads.
3. Real-time access to FMCSA data in order to perform initial and periodic carrier certification and review.
4. A carrier “watch list” whereby any FMCSA changes to watched carriers are flagged for review on a daily basis.
5. A “Quick Carrier Review” sidebar link that allows access to FMCSA given the entry of a US DOT Number.
6. Load Board and internal truck posting retrieval/search, with the ability to quickly set up a new carrier from a load board truck posting.

Online Application

The online application allows carriers to self-register on your carrier network if you expose the URL on your web site. Please see below on how to set up this capability.

The result of a complete, submitted carrier application creates the following data in TMS:

1. An Account record.
2. One or more Contact records.
3. A Transportation Profile record.
4. One or more Insurance Policy records.
5. One or more (disabled) Carrier Service records.
6. Zero or more Carrier Equipment Type records.
7. Zero or more Bank Account records.
8. Insurance, authority, and tax form attachments.
9. An application attachment with eSignature.

Carrier Transportation Profile

Navigating to the Transportation Profile detail page for a just-captured carrier application:

Note that when a load with an Equipment Type is tendered to a carrier, a Carrier Equipment Type record is created for the carrier’s Transportation Profile if it is not there already. 

This allows the system to “learn” which carriers support which Equipment Types.

Carrier FMCSA Review

If the SaferWatch, RMIS or MyCarrierPackets API is enabled, you can click on the Review button from the Transportation Profile detail page to access the latest FMCSA data and risk categorizations for this carrier.

The user may manually override the SaferWatch-calculated or MyCarrierPackets risk fields, and enter other information related to the certification process.

If the Get Certificate button is visible in the insurance section, you may retrieve an image of the insurance certificate for this carrier (as an attachment).

Carrier Approval

Clicking the Approve button from this page performs two important tasks:

1. The Carrier Service records for this carrier are enabled.
2. Saferwatch: the carrier is added to the Watch List.  FMCSA changes to this carrier will be flagged on a daily basis.

You must click the Approve button to add a carrier to the (SaferWatch) Watch List.

You may go to the SaferWatch web site to view your Watch List or modify it outside of the TMS.  

The Monitor Carrier field on the Transportation Profile record is set to “true” for all monitored carriers.

1. MyCarrierPackets: the carrier is added to the Monitored Carriers list with the next run the batch job.