PC*MILER|Connect User Guide
Total Page:16
File Type:pdf, Size:1020Kb
Connect User Guide www.pcmiler.com pcmiler.com/support ALL RIGHTS RESERVED You may print one (1) copy of this document for your personal use. Otherwise, no part of this document may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language, in any form or by any means electronic, mechanical, magnetic, optical, or otherwise, without prior written permission from ALK Technologies, Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and other countries. IBM is a registered trademark of International Business Machines Corporation. PC*MILER®, CoPilot® Truck™, ALK®, RouteSync®, and TripDirect® are registered trademarks of ALK Technologies, Inc. Truck Stop location data © Copyright 2016 Comdata Inc, 5301 Maryland Way, Brentwood, TN 37027. All Rights Reserved. Traffic information provided by INRIX © 2016. All Rights Reserved by INRIX, Inc. SPLC data used in PC*MILER products is owned, maintained and copyrighted by the National Motor Freight Traffic Association, Inc. Canadian Postal Codes data based on Computer File(s) licensed from Statistics Canada. © Copyright, HER MAJESTY THE QUEEN IN RIGHT OF CANADA, as represented by the Minister of Industry, Statistics Canada 2003-2016. This does not constitute an endorsement by Statistics Canada of this product. Contains information licensed under the Open Government License – Canada. http://open.canada.ca/en/open-government-licence-canada Xceed Software – The Software is Copyright © 1994-2016 Xceed Software Inc., All Rights Reserved. The Software is protected by Canadian and United States copyright laws, international treaties and other applicable national or international laws. United Kingdom full postal code data supplied by Ordnance Survey Data © Crown copyright and database right 2016. OS OpenData™ is covered by either Crown Copyright, Crown Database copyright, or has been licensed to the Crown. Certain Points of Interest (POI) data by Infogroup © Copyright 2016. All Rights Reserved. Geographic feature POI data compiled by the U.S. Geological Survey. Oil and Gas field content provided by GeoTrac Systems Inc.© Copyright 2016. All Rights Reserved. Cartographic data provided by multiple sources including lnstituto Nacional de Estadistica y Geografia, U.S. Geological Survey, Natural Earth and © Department of Natural Resources Canada. All Rights Reserved. Copyright HERE Data © 2016 – All Rights Reserved. HERE Data © is subject to the terms set forth at http://corporate.navteq.com/supplier_terms.html. Source of map data for Mexico provided by Instituto Nacional de Estadistica y Geografia. All Retail Prices for Pilot Flying J locations are subject to change and are subject to Pilot Flying J’s disclaimer set forth at http://www.pilotflyingj.com/disclaimer . National Elevation Data produced by the U.S. Geological Survey. Satellite Imagery © Digital Globe, Inc. All Rights Reserved. Weather data provided by Environment Canada (EC), U.S. National Weather Services (NWS), U.S. National Oceanic and Atmospheric Administration (NOAA), and AerisWeather. © Copyright 2016. All Rights Reserved. Copyright SanGIS 2009. All Rights Reserved. Data provided by permission of King County, Washington. ALK Data © 2016 – All Rights Reserved. ALK Technologies, Inc. reserves the right to make changes or improvements to its programs and documentation materials at any time and without prior notice. © Copyright 1994-2016 ALK Technologies, Inc. • www.alk.com Table of Contents ® PC*MILER Product Line END-USER LICENSE AGREEMENT ............................. iv Chapter 1: Introduction .......................................................................................................1 1.1 Requirements .................................................................................................2 1.2 Installing PC*MILER|Connect ......................................................................3 1.3 Technical Support ..........................................................................................3 1.4 Accessing User Guides for PC*MILER Products .........................................4 1.5 Licensing ........................................................................................................4 1.6 Applications That Use PC*MILER|Connect .................................................4 1.7 About This Manual ........................................................................................5 1.8 What’s New in PC*MILER|Connect Version 30? ........................................5 Chapter 2: Overview and Basic Concepts ..........................................................................8 2.1 PC*MILER|Connect Server Engine and Trips ..............................................8 2.2 Steps for Simple Distance Calculations .........................................................9 2.3 Sample Sequence for Building a Trip ............................................................9 2.4 Tips for Using the API’s ..............................................................................10 2.5 Stops .............................................................................................................11 2.6 Specifying Street Addresses ........................................................................11 2.7 Specifying a Non-U.S. Country ...................................................................12 2.8 Entering Latitude/Longitude Points As Stops..............................................13 2.9 Reports .........................................................................................................14 2.10 Trip Options ...............................................................................................15 2.11 Query for Version Number and Network Connections .............................16 Chapter 3: Using the PC*MILER|Connect API’s ...........................................................18 3.1 Initialization and Cleanup ............................................................................18 3.2 Building a Trip .............................................................................................20 3.3 Simple Distance Calculation ........................................................................21 3.4 Getting Toll Costs ........................................................................................25 3.4.1 Toll Calculation With Custom Vehicle Dimensions ..........................28 3.5 Currency Conversion ...................................................................................31 3.6 Managing Stops ...........................................................................................31 3.7 Validating City Names .................................................................................35 3.8 Validating Street Addresses .........................................................................39 3.9 Functions for Converting Special Characters ..............................................39 3.10 Setting and Getting the Default Region .....................................................41 3.11 Switching the Data Set ...............................................................................42 3.12 Country Code Format Options ...................................................................42 3.13 Using Mexican Postal Codes .....................................................................42 3.14 Setting the ‘NL’ Abbreviation Preference .................................................43 3.15 State/Country Lists.....................................................................................44 3.16 Translating Between Latitude/Longitudes and Places ...............................44 PC*MILER|Connect User’s Guide i 3.17 SPLCs As Stops .........................................................................................46 3.18 Route Options and Setting Defaults ...........................................................47 3.19 Routing With Custom Vehicle Dimensions ...............................................56 3.20 Using Route Profiles ..................................................................................58 3.21 Using ETA/ETD and Traffic Data .............................................................59 3.22 Least Cost Routing Options .......................................................................65 3.23 Getting Location Information ....................................................................66 3.24 Location Radius Search Functionality .......................................................67 3.25 Report Generation and Retrieval ...............................................................68 3.26 Getting Trip Leg Information ....................................................................72 3.27 Optimizing the Stop Sequence ...................................................................73 3.28 Hub Routing ...............................................................................................74 3.29 Calculating Air Distance ............................................................................74 3.30 Designating Stops As Waypoints ...............................................................74 3.31 Tracking Equipment On Roads ..................................................................75 3.32 Using Custom Routing ...............................................................................75 3.33 Avoid, Favor, and Override Roads From Within Connect ........................76 3.34 Geofence Functions ...................................................................................77