IN THIS ARTICLE
Retrieving Route Information
After a routing solution has been completed, the resulting route info and statistics can be exported from the database to an ERP/WMS/OMS. This article describes the different methods customers can use to export that information.
Options for Exporting Routes
The primary methods used to retrieve and export data from DirectRoute and/or DRTrack are:
- Web Services Retrieval: Automatic extract of route and account info in near real-time, or in a daily batch process.
- File Export (Database): XML file export with route and account detail for consumption by an ERP/WMS/OMS.
- File Export (DirectRoute): UPL/CSV/TXT/XML file export with route and account detail for consumption by an ERP/WMS/OMS.
Web Services Retrieval
The benefits of using web services to retrieve routing data include seamless data integration without user interaction, ability for near real-time data exchange, and ability to pull fields captured by mobile devices, including pictures and signatures (device-specific). We have a full set of web service APIs for data regarding orders, accounts, and routes.
The following Request Methods Table describes some, but not all, of the export methods available via web services and the expected return response. You can view the full WSDL table here.
Name | Description |
ExportAccounts | Exports Accounts by branches |
GetAccountDetailsByBranch | Returns Account details for each account attached to a single branch. |
GetAccountDetailsByModifiedDateAndBranch | Returns Account details for each account attached to the Branch that have been modified within a date range. |
GetBranches | Returns a list of all Branches |
GetForms | Returns a list of forms. |
GetMasterRoutes | Returns a list of Master Routes |
GetMaxRouteDetailByBranchAndDispatchDate | Returns Route details by Branch for all routes dispatched within a date range. |
GetOrderDetailByDate | Returns order details from a specific Branch within a date range. |
GetOrderDetailByModifiedDate | Returns order details from a specific Branch that have been modified within a date range. |
GetOrderDetailsAndEventsByOrderIDs | Returns order details from a specific Branch within a |
GetOrderDetailsByOrderIds | Returns order details from a specific Branch |
GetOrderEventsByTypeAndDate | Returns orders by events and date |
GetRouteDetailByDateRange | Returns route details for each route within a Branch during a particular date range. |
GetRouteDetailByModifiedDate | Returns route details for each modified route within a Branch during a particular date range. |
GetRouteDetailByPlannedStartDate | Returns route details for each route within a Branch based on the planned start date. |
GetRouteSummaryByPlannedStartDate | Returns a summary of all routes within a Branch based on the planned start date. |
GetTruckProfiles | Returns truck details from a specific Branch |
File Export (Database)
An XML File exported from the DRTrack database contains the most common routing fields used by most individuals and is a simple file to create and integrate in an easy to consume format. It can be customized to contain only the information fields you need, omitting unnecessary miscellaneous data. The URP Field Names Table contains the most common fields and attributes used in the export file.
File Export (DirectRoute)
We can generate an Upload File (.upl, .txt or .xml) to be exported from DirectRoute. This enables the selection of specific data fields to be included in the file that is passed back to the ERP/WMS/OMS.
If planning to create and use an Upload File, then the Preferences in DirectRoute will need to be updated to specify the Upload File Name and Upload File Path, as well as other pertinent upload options. Creating a customized Upload File allows you to select the data fields passed, and omit any fields not wanted. Each field represents one piece of data from the routing project. Refer to the URP Field Names Table for all available fields that can be used to export data in an Upload File.