FS 322073 EPOD WEBFLEET Interface - Basic

From Calidus HUB
Revision as of 12:05, 15 April 2015 by Anw (talk | contribs) (v0.1 - Initial draft.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)





Aptean Logo.png







OBS Logistics

WEBFLEET Interface - Basic

CALIDUS EPOD

15th April 2015 - 0.1
Reference: FS 322073











































Functional Overview

Client Requirement

CALIDUS EPOD needs to get the Mobile Application to trigger the TomTom Nav App with the address of the job the driver is travelling to.


Solution Overview

The TomTom Nav App on the device does not allow this kind of triggering with an ad-hoc address - it must work through triggering WEBFLEET orders.

The only way to trigger the start/arrive/complete of WEBFLEET orders is:

  • Through the device's Pro.CONNECT interface (device-side)
  • Through WEBFLEET.CONNECT webservices (server-side)

In order for either of these methods to work, there is a pre-requirement to create the orders in WEBFLEET.

In order for this to work, there is a pre-requirement for all addresses to have a Lat/Long.

The Pro.CONNECT interface is proving too difficult to implement at this time, so the design will fall back on:

  • Triggering the display of the webfleet app through Android (which will just display the app, not trigger the start of the job.

Additionally, TomTom state that the requests that are currently being made through TomTom Webservices are not being counted towards OBS Logistics use, as the OBS API Key is not included in current requests. Any solution put in place at this time will ensure this key is utilised.


This change covers:

  • Basic implementation of an interface mechanism for WEBFLEET messages.
  • Geocoding addresses in CALIDUS EPOD
  • Triggering the display of the TomTom Nav App on TomTom PRO devices only.

All other functionality relating to WEBFLEET interfaces will be completed in other specifications, referenced in Appendix A.


Scope

  • This change affects the latest version of the CALIDUS EPOD application only.
  • The existing CTMS-TomTom interfaces also need to be modified to use an API key, which will be provided by Matt Turner. This functionality is not part of the scope of this change.


Set-up

Pre-requisites

A working CALIDUS EPOD implementation.


Menu Structure

None


Data

EPOD_XF_CONFIG:

  • EPL_XF_ID - New ID types for TomTom:
    • "TO" - TomTom Orders
    • "TG" - TomTom Geocoder
  • User - EPL_WEB_USER - admin
  • Password - EPL_WEB_PASSWORD - Matt3221
  • Account - EPL_XF_RECIPIENT - logistics-obs
  • URL - EPL_XF_DESTINATION - http://connect.webfleet.tomtomwork.com/extern
  • API Key - EPL_WEB_PARAMETER - 000fcb2a-6631-477a-b00e-de0505e7c7e3
  • Warning Warning: Other items here


Functional Description

Database/DAL

EPOD_XF_CONTROL

  • EXC_ID - unique numeric ID
  • EXC_EXTERNAL_SYSTEM - string e.g. "TOMTOM"
  • EXC_ACTION - D - Delete, A - Add/Amend, allowed to be null
  • EXC_STATUS - P - Pending, I - In Progress, C - Complete, E/X - Error
  • EXC_TYPE - J - Job, L - Load, JA - Job Address, C - Customer
  • EXC_SITE_ID - nvarchar(10)
  • EXC_LOAD_ID - nvarchar(20)
  • EXC_JOB_ID - nvarchar(10)
  • EXC_JOB_TYPE - nvarchar(2)
  • EXC_CUSTOMER_CODE - nvarchar(20)
  • EXC_CREATED_DATE - int, 8 digit number format YYYYMMDD
  • EXC_CREATED_TIME - int, 8 digit number format HHMMSSNN

Indexes:

  • PK_EXC: EXC_ID
  • IX_EXC_TYPE: EXC_STATUS, EXC_EXTERNAL_SYSTEM, EXC_ACTION
  • IX_EXC_LOAD: EXC_STATUS, EXC_SITE_ID, EXC_LOAD_ID
  • IX_EXC_JOB: EXC_STATUS, EXC_SITE_ID, EXC_JOB_ID, EXC_ADDRESS_TYPE
  • IX_EXC_CUST: EXC_STATUS, EXC_SITE_ID, EXC_CUSTOMER_CODE


EPOD_JOB_ADDRESS

  • EPL_LAT - float
  • EPL_LONG - float
  • Trigger write of type "JA" to EPOD_INT_CONTROL if TomTom Geocoder enabled for the Site when adding Job Address


EPOD_CUSTOMER

  • EPL_LAT - float
  • EPL_LONG - float
  • Trigger write of type "C" to EPOD_INT_CONTROL if TomTom Geocoder enabled for the Site when adding a customer


EPOD_VEHICLE

  • EPL_EXT_REF - nvarchar(10)


AutoExport

New procedure to send messages from EPOD_INT_CONTROL:

  • Store Site XF_CONFIG settings (or get them as part of the message retrieval)
  • New TOMTOM process to find only messages EXC_STATUS = "P", order by EXC_ID
  • Change message status to "I" - Progress - any failure from this point to change status to "E" and log error.
  • Check EXC_EXTERNAL_SYSTEM and EXC_ACTION: For TOMTOM:
  • Build URL to geocoder from parameters in EPOD_XF_CONFIG:
    • EPL_XF_DESTINATION +
    • ?account=EPL_XF_RECIPIENT
    • &username=EPL_WEB_USER
    • &password=EPL_WEB_PASSWORD
    • &apikey=EPL_WEB_PARAMETER
  • Depending on EPOD_XF_CONFIG.EPL_XF_ID of "TG", add specific geocoder parameters:
    • &lang=en&action=geocodeAddress&outputformat=json&addrcountry=GB&provider=2&freetext=
  • Build address into a string, from NAME, ADDRESS_1/2/3/4, POSTCODE, delimited by space.
  • Make address string HTMLsafe and add to URL
  • Send message
  • Process Response:
    • Parse result as JSON. Take result of first object that matches the first part of the postcode, or the first result.
    • Store objResult[0].latitude/1000000 in EPL_LAT and objResult[obj].longitude/1000000 in EPL_LONG
    • Failure - update status of message to "E" and audit.
    • Success - update record indicated by EXC_XF_TYPE and mark status of message to "C":
  • Update EPOD Audit records as normal for success or failure.


Admin

XF Config

  • New ID types for TomTom:
    • TO - TomTom Orders
    • TG - TomTom Geocoder
  • XF Type - POST - does this work as http webservice?


Vehicles

  • Add Ext Ref to table and pop-up for edit/add.


Customer

  • Add Lat/Long to pop-up for edit/add
  • FUTURE: Add button to look up address with TomTom geocoder webservice
  • FUTURE: Add show on map - link to http://www.google.co.uk/maps/place/<lat>,<long>


Job Address

  • Add Lat/Long to pop-up for edit/add, when entering Job Address
  • FUTURE: Add button to look up address with TomTom geocoder webservice
  • FUTURE: Add show on map - link to http://www.google.co.uk/maps/place/<lat>,<long>


Mobile Device

Job Detail

  • Switch to NAV app through a basic intent (com.tomtom.navpad.navapp / NavPadNavAppActivity) if app running on TomTom PRO device and configured for this.


Appendix A: Quote & Document References

Cost Details
Activity No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0 £0.00
Change Request Evaluation 0.00 0 £0.00
Functional Specification 2.00 0 £0.00
Technical Specification 2.00 0 £0.00
Development 10.25 0 £0.00
Testing and Release 2.00 0 £0.00
Implementation 0.50 0 £0.00
Project Management 1.25 0 £0.00
 
TOTAL 18.00   £0.00
Estimate excludes training, release to live and go live support.

A.1 References

Ref NoDocument Title & IDVersionDate
1FS 322073 EPOD WEBFLEET Interface - Orders0.116/04/2015


A.2 Glossary

Term Definition
EPOD Electronic Proof of Delivery. The OBS EPOD system is CALIDUS ePOD.
CALIDUS eSERV The OBS mobile system to complete Service functionality in the field. This is part of the CALIDUS ePOD system.
PDA The mobile device on which the C-ePOD system will run in the field. This can be a Phone, EDA or industrial PDA, running Android.
DAL Data Access Layer. A mechanism for accessing data by the system that is removed from the application, allowing for simplified access and providing protection to the data, as only approved DAL methods can be used to modify it.
GPS Global Positioning System. A mechanism of retrieving accurate positioning information in the form of Latitude and Longitude (Lat-Long) co-ordinates from a device.
GPRS, 3G, HSDPA, Data Service All terms referring to mobile device network connectivity, and the speed at which the device connects to the internet.


A.3 Authorised By


Matt Turner
OBS CALIDUS EPOD Product Manager		_____________________________

Murray Middleton
OBS CALIDUS EPOD Development Manager		_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=FS_322073_EPOD_WEBFLEET_Interface_-_Basic&oldid=1862’