Difference between revisions of "WEBFLEET"

From RouteXL
Jump to: navigation, search
(Notes)
(Added error 45)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
WEBFLEET is the professional fleet management platform of TomTom Telematics. RouteXL is connected to WEBFLEET, which allows you to import orders from the fleetmanagement platform, optimize order itinerary and send optimized itineraries to connected TomTom PRO devices.
+
WEBFLEET is the professional fleet management platform of Webfleet Solutions, before October 2019 known as TomTom Telematics. RouteXL is connected to WEBFLEET via the ''WEBFLEET.connect interface'', which allows you to import orders from the fleetmanagement platform, optimize the route and send the sorted orders back to connected TomTom PRO devices.
  
 
Read more about WEBFLEET at https://www.routexl.nl/blog/routing-for-tomtom-webfleet/
 
Read more about WEBFLEET at https://www.routexl.nl/blog/routing-for-tomtom-webfleet/
  
=== Settings ===
+
== Set up the connection ==
  
To connect you'll need to enter your WEBFLEET account credentials in the [[Options]] on the WEBFLEET tab.
+
To connect RouteXL to your WEBFLEET account, enter your WEBFLEET account credentials in the [[Options]] on the WEBFLEET tab.
  
''Hint: If connected, the icon of the Import button in the [[user interface]] changes from two rectangles (copy) to one black rectangle (paste).''
+
* The WEBFLEET user must have the "expert" profile and have external access to interface WEBFLEET.connect. Your administrator user can change these settings in the WEBFLEET application.
 +
 
 +
* If you grant external access to an existing WEBFLEET user, it may take up to 24 hours to get activated. If you’re in a hurry: you’d better create a new user with these rights.
 +
 
 +
* There should at least be one vehicle attached to the WEBFLEET user to be able to import or export orders.
 +
 
 +
* If the connection to WEBFLEET is made, the icon of the Import button in the [[user interface]] changes from two rectangles (copy) to one black rectangle (paste).
 +
 
 +
== Import orders into RouteXL ==
  
=== Import ===
+
[[File:WEBFLEET_import.png]]
  
[[File:WEBFLEET_import.png|thumbnail|right|The WEBFLEET import dialog]]Use the WEBFLEET button in the [[Import]] dialog to import orders from WEBFLEET. Orders will be imported as destination locations into RouteXL.
+
Use the WEBFLEET button in the [[Import]] dialog to import orders from WEBFLEET. Orders will be imported as destination locations into RouteXL.
  
 
The import dialog has some options:
 
The import dialog has some options:
Line 21: Line 29:
 
Warning: WEBFLEET can store more information than RouteXL can handle. Not all order details will be imported with the locations.
 
Warning: WEBFLEET can store more information than RouteXL can handle. Not all order details will be imported with the locations.
  
=== Export ===
+
== Export route to WEBFLEET ==
 +
 
 +
[[File:WEBFLEET_export.png]]
  
[[File:WEBFLEET_export.png|thumbnail|right|Export a route to a WEBFLEET device]] An optimized itinerary can be send to a connected TomTom PRO device by using the WEBFLEET button in the [[Share]] dialog. Your addresses will be converted into destination orders using the .connect interface.
+
An optimized itinerary can be send to a connected TomTom PRO device by using the WEBFLEET button in the [[Share]] and [[Download]] dialog. Your addresses will be converted into destination orders in WEBFLEET.
  
 
The export dialog has the following options:
 
The export dialog has the following options:
  
* Select device and date: TomTom satnav and day for which the orders must be created.
+
* Select device and date: TomTom device and day for which the orders must be created.
 
* Add departure: make the departure address a seperate order on the device. Only required if one needs to drive to the departure first.
 
* Add departure: make the departure address a seperate order on the device. Only required if one needs to drive to the departure first.
* Replace the current orders: will delete all currect on the device on the specified date. May be useful if orders were imported before.
+
* Replace the current orders: will delete all of the currect orders on the device on the specified date. This is useful if orders were imported from WEBFLEET before.
* Create itinerary order: adds all stops in one single order entry. Not all devices allow this.
+
* Create itinerary order: adds all stops in one single order entry. The result is one order with numerous stops. Not all devices allow this feature.
 
* With order text: comments in the route planner will be added to orders.
 
* With order text: comments in the route planner will be added to orders.
 
* Add arrival times: arrival times in the route planner will be added to orders.
 
* Add arrival times: arrival times in the route planner will be added to orders.
 +
* Ordertype: the type of order - delivery, pickup or service.
 +
* Notify leadtime: triggers the notification in WEBFLEET and sets the time interval.
 +
 +
Warning: WEBFLEET does not allow more than 100 orders on one device.
 +
 +
=== Order numbers ===
 +
 +
When exporting orders RouteXL will generate unique order numbers for WEBFLEET. However, you may require your own order numbers to appear in WEBFLEET. To add your own order number to a order, [[edit location]] and put it between straight brackets [ ] in the comments of a location before your create the route and export to WEBFLEET.
 +
 +
RouteXL also allows you to [[import]] your own order numbers with your addresses. To import order numbers that must appear in WEBFLEET, add the order number between [ ] to the comments between { }. For example if you [[import]] this text:
 +
 +
Kennemerstraatweg 464, Heiloo, The Netherlands {[ordernumber1]}
 +
 +
This will import '''[ordernumber1]''' with your address as comment. When exporting the route to WEBFLEET '''ordernumber1''' will appear as order number.
 +
 +
Note: WEBFLEET requires unique order numbers. If your order numbers are not unique, the orders will not be accepted.
 +
 +
== Error messages ==
 +
 +
The errors that are generated by WEBFLEET.connect are shown in the RouteXL interface. Here are some common errors and their solution:
 +
 +
'''Access denied [ERROR 45]'''
 +
 +
You have insufficient permissions to perform this function. Do you have a valid WEBFLEET account? Double check your credentials in [[Options|Options > WEBFLEET]]. Re-enter them and save.
 +
 +
'''User does not exist [ERROR 1101]'''
 +
 +
This error may have various reasons:
 +
* The WEBFLEET username is not correct. Check if the user is available in WEBFLEET. Try to log in at WEBFLEET with the username.
 +
* You used special characters like &?#! in your WEBFLEET password. Go to WEBFLEET and change the password.
 +
* You removed the Expert profile from the user in WEBFLEET. Go to WEBFLEET and add the Expert profile.
 +
 +
'''Account blocked [ERROR 1130]'''
 +
 +
There is an issue with your account at WEBFLEET. Contact Webfleet Solutions support to solve the problem.
  
== Hints and tips ==
+
'''The user is not valid anymore [ERROR 1140]'''
  
* The WEBFLEET user must have the "expert" profile and have external access to interface WEBFLEET.connect. Your administrator user can change these settings in the WEBFLEET application.
+
There is an issue with the user at WEBFLEET. Check the settings of the user in WEBFLEET, or contact Webfleet Solutions support to solve the problem.
 +
 
 +
'''Order already exists [ERROR 2515]'''
 +
 
 +
WEBFLEET requires unique id's to identify orders. If you assign id's that are not unique, WEBFLEET will not accept the order. Remove orders from WEBFLEET or change the id's.
 +
 
 +
'''Itinerary orders are not supported for this unit [ERROR 2615]'''
 +
 
 +
This error indicates your TomTom device does not accept itinerary orders. An itinerary order is a single order that consists of many route points, e.g. for snow clearing vehicles. If you're not aware of itinerary orders, you probably don't need it. Disable this option when exporting a route to WEBFLEET.
 +
 
 +
'''Request quota reached [ERROR 8011]'''
 +
 
 +
This error is given when you have made too many requests in a short time period. If this happens too often, contact Webfleet Solutions support to increase the request quota for your WEBFLEET account.
  
* If you grant external access to an existing WEBFLEET user, it may take up to 24 hours to get activated. If you’re in a hurry: you’d better create a new user with these rights.
+
'''External request not allowed [ERROR 8014]'''
  
* '''External request not allowed [ERROR 8014]''' indicates that your WEBFLEET user is not correctly configured.
+
This error indicates that your WEBFLEET user is not correctly configured. Go to the WEBFLEET interface and check if the user has the ''Expert'' profile and external access to the WEBFLEET.connect interface.
  
* Special characters like &?#! in your WEBFLEET password may incorrectly result in error message '''User does not exist [ERROR 1101]'''
+
'''HTTP Status 0'''
  
* '''Itinerary orders are not supported for this unit [ERROR 2615]''' indicates your TomTom device does not accept an itinerary order. Disable the option when exporting a route to WEBFLEET.
+
The WEBFLEET.connect server is not responding to your request to import/export orders. Their server is having technical issues, is offline or too busy handling other requests. Get a cup of coffee and try again later. If the problem persists, contact Webfleet Solutions support.

Latest revision as of 14:29, 13 January 2022

WEBFLEET is the professional fleet management platform of Webfleet Solutions, before October 2019 known as TomTom Telematics. RouteXL is connected to WEBFLEET via the WEBFLEET.connect interface, which allows you to import orders from the fleetmanagement platform, optimize the route and send the sorted orders back to connected TomTom PRO devices.

Read more about WEBFLEET at https://www.routexl.nl/blog/routing-for-tomtom-webfleet/

Set up the connection

To connect RouteXL to your WEBFLEET account, enter your WEBFLEET account credentials in the Options on the WEBFLEET tab.

  • The WEBFLEET user must have the "expert" profile and have external access to interface WEBFLEET.connect. Your administrator user can change these settings in the WEBFLEET application.
  • If you grant external access to an existing WEBFLEET user, it may take up to 24 hours to get activated. If you’re in a hurry: you’d better create a new user with these rights.
  • There should at least be one vehicle attached to the WEBFLEET user to be able to import or export orders.
  • If the connection to WEBFLEET is made, the icon of the Import button in the user interface changes from two rectangles (copy) to one black rectangle (paste).

Import orders into RouteXL

WEBFLEET import.png

Use the WEBFLEET button in the Import dialog to import orders from WEBFLEET. Orders will be imported as destination locations into RouteXL.

The import dialog has some options:

  • Select device and date: the TomTom PRO device and day of which orders should be imported.
  • Add latest position as departure: the latest GPS position of the device will be added as departure location on the map. This can be used to plan orders from the current position of the driver, e.g. when on the road.
  • Keep order ID: required if you need which to keep the order IDs in WEBFLEET.

Warning: WEBFLEET can store more information than RouteXL can handle. Not all order details will be imported with the locations.

Export route to WEBFLEET

WEBFLEET export.png

An optimized itinerary can be send to a connected TomTom PRO device by using the WEBFLEET button in the Share and Download dialog. Your addresses will be converted into destination orders in WEBFLEET.

The export dialog has the following options:

  • Select device and date: TomTom device and day for which the orders must be created.
  • Add departure: make the departure address a seperate order on the device. Only required if one needs to drive to the departure first.
  • Replace the current orders: will delete all of the currect orders on the device on the specified date. This is useful if orders were imported from WEBFLEET before.
  • Create itinerary order: adds all stops in one single order entry. The result is one order with numerous stops. Not all devices allow this feature.
  • With order text: comments in the route planner will be added to orders.
  • Add arrival times: arrival times in the route planner will be added to orders.
  • Ordertype: the type of order - delivery, pickup or service.
  • Notify leadtime: triggers the notification in WEBFLEET and sets the time interval.

Warning: WEBFLEET does not allow more than 100 orders on one device.

Order numbers

When exporting orders RouteXL will generate unique order numbers for WEBFLEET. However, you may require your own order numbers to appear in WEBFLEET. To add your own order number to a order, edit location and put it between straight brackets [ ] in the comments of a location before your create the route and export to WEBFLEET.

RouteXL also allows you to import your own order numbers with your addresses. To import order numbers that must appear in WEBFLEET, add the order number between [ ] to the comments between { }. For example if you import this text:

Kennemerstraatweg 464, Heiloo, The Netherlands {[ordernumber1]}

This will import [ordernumber1] with your address as comment. When exporting the route to WEBFLEET ordernumber1 will appear as order number.

Note: WEBFLEET requires unique order numbers. If your order numbers are not unique, the orders will not be accepted.

Error messages

The errors that are generated by WEBFLEET.connect are shown in the RouteXL interface. Here are some common errors and their solution:

Access denied [ERROR 45]

You have insufficient permissions to perform this function. Do you have a valid WEBFLEET account? Double check your credentials in Options > WEBFLEET. Re-enter them and save.

User does not exist [ERROR 1101]

This error may have various reasons:

  • The WEBFLEET username is not correct. Check if the user is available in WEBFLEET. Try to log in at WEBFLEET with the username.
  • You used special characters like &?#! in your WEBFLEET password. Go to WEBFLEET and change the password.
  • You removed the Expert profile from the user in WEBFLEET. Go to WEBFLEET and add the Expert profile.

Account blocked [ERROR 1130]

There is an issue with your account at WEBFLEET. Contact Webfleet Solutions support to solve the problem.

The user is not valid anymore [ERROR 1140]

There is an issue with the user at WEBFLEET. Check the settings of the user in WEBFLEET, or contact Webfleet Solutions support to solve the problem.

Order already exists [ERROR 2515]

WEBFLEET requires unique id's to identify orders. If you assign id's that are not unique, WEBFLEET will not accept the order. Remove orders from WEBFLEET or change the id's.

Itinerary orders are not supported for this unit [ERROR 2615]

This error indicates your TomTom device does not accept itinerary orders. An itinerary order is a single order that consists of many route points, e.g. for snow clearing vehicles. If you're not aware of itinerary orders, you probably don't need it. Disable this option when exporting a route to WEBFLEET.

Request quota reached [ERROR 8011]

This error is given when you have made too many requests in a short time period. If this happens too often, contact Webfleet Solutions support to increase the request quota for your WEBFLEET account.

External request not allowed [ERROR 8014]

This error indicates that your WEBFLEET user is not correctly configured. Go to the WEBFLEET interface and check if the user has the Expert profile and external access to the WEBFLEET.connect interface.

HTTP Status 0

The WEBFLEET.connect server is not responding to your request to import/export orders. Their server is having technical issues, is offline or too busy handling other requests. Get a cup of coffee and try again later. If the problem persists, contact Webfleet Solutions support.