Retrieving Route Information  

After a routing solution has been completed, the resulting route information and statistics can be exported from the database to the OMS/ERP for processing.  This section of the document describes the different methods customers have to export that information.

 

Options for Exporting Routes 

The primary methods used to retrieve data from DirectRoute and/or DRTrack are:

  • Web Services Retrieval – Automatically pull route and account information in near real-time, or in a daily batch process.
  • XML File Export (Database) – Exported with route and account detail for consumption by the ERP or anywhere else .XML files can be read.
  • DirectRoute – .UPL, .CSV, .TXT, or .XML file passed back to the ERP/WMS/OMS.

 


Web Services Retrieval

The benefits of using web services to retrieve routing data include:

  • Seamless data integration with no user interaction.
  • The ability for near real-time data exchange.
  • The ability to pull fields captured by the mobile device including pictures, signatures, etc. (device-specific).

We have a full set of web service APIs for data regarding orders, accounts, and routes.

 

Description Language (WSDL)

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 access the WSDL (click to follow) at http://integration.appiangps.com/tracking.

 

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


.XML File Export (Database)

Some of the benefits of using an .XML File Export are:

  • Simple file integration.
  • It contains the most common routing fields used

We can create an .XML File Export that contains all the route information you may need.  This allows the passing of pertinent information in an easy to consume format.  The URP Field Names Table contains fields and attributes used in this process.

 

DirectRoute Export

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.