Time on Site Report setup
This guide shows how to setup a Time on Site report. It includes report plugin installation, Point of Interest import and report configuration.
Time on Site reports measure how much time vehicles have spent at different Points of Interest (POI’s).
These reports can show how much time is spent at customer sites, in distribution centrals or in the company parking lot. You can also see how many times different POI’s have been visited and if some POI’s have been missed completely.
Time on Site reports answer questions like:
- How much time do we spend at our customers per week?
- How many customer visits do we make per day?
- How many times did we visit our warehouses last month?
- What customers have not been visited at all this month?
In this guide we will setup a Time on Site report that lists customer visits for our vehicles.
The setup process is a one-time task where you can configure the reports to your needs.
Follow these steps to install the reports on your server:
- Login to your SiteAdmin application
- Install (or update) Time On Site Report from the menu Plugins.
Note: you may also need to update to the latest version of the plugins Core, Reporting and PointsOfInterest
- Click on the tab Applications and select the application you want to enable the report for
- Scroll down to the section Enable/Disable features and expand the Plugins/Reporting/_CreateReport folder
- Mark the checkbox for each Time on Site report you want to activate
- Scroll down to the bottom of the page and click Save to save your updated settings
Note: You can find more information in the guide Activate Reports in GpsGate Server 3.0
Import a list of customers
Time on Site reports work with Points of Interest (POI’s), POI’s are positions with a description. You can import a list of POI’s in CSV or KML format. A sample CSV file is shown below:
Follow these steps to import a POI list of customers:
- Login to your SiteAdmin application
- Go to the tab Import and select Points of Interest. You can import POI lists in CSV or KML format. The Help section at the bottom of the page shows the supported formats.
- Import a list of your customer POI’s in the above format into the category Customer
- Go back to the Applications tab and click on the application you want to enable the POI list in.
- Enable the POI category Customer in “Enable/Disable features - Plugins - PointsOfInterest - _EditLocationCategory”
- Enable the POI category Customer in “Enable/Disable features - Plugins - PointsOfInterest - _ReadLocationCategory”
- Save the application settings
Note: You can import multiple POI lists to different categories like “Customer” and “Warehouse” for different reports.
Create an Event Rule
You need to create an event rule for your POI’s. Event rules are used to detect when vehicles enter a POI. It is recommended to create one event rule per POI category. This helps to avoid potential confusion when POI’s in different categories overlap each other.
Note: Other options in the event rules can be used to define when to trigger a Time on Site Event, you can for example set a minimum time for a visit to be valid so that vehicles just passing a POI are ignored.
Below we create an event rule that checks if a vehicle has been at a customer site, defined by the list of imported POI’s.
- Log in to your VehicleTracker application with a user that is allowed to edit event rules
- Go to the menu Admin / Event Rules and click on Add new Event Rule
- In “1. Rule name and description”, give the event rule a suitable name, like Customer visit. The name is used in the Time on Site reports and should describe the included POI category. You should also select Analyze only, as we only use the event rule for reporting and do not want real time alerts in the map view
- Click Next in step 2 and 3 (keep the default settings)
- In “4. Expressions”, add a Points of Interest expression. Select the POI category Customer for the rule to trigger on. You can also optionally select the event to be a Delayed event, requiring that a vehicle is at the POI for a specified amount of minutes before triggering the event
- In “5. Notifications”, click the “Add notification” drop down list and select the Report Argument. Give the argument a descriptive Name like “POI id” and only enter [POI_ID] in the Value field and click OK. For TS1010, TS1011 and TS1012 see this.
Note: it is IMPORTANT that the Value textbox only contains [POI_ID]. Do not add multiple Report Arguments for this rule used by the Time on Site reports.
- Click Next and Save the event rule
Configure the report
Follow these steps to create a Time on Site report with the Customer visits event rule.
- Start from the main Map view in your VehicleTracker application (with a user that is allowed to create reports)
- Go to the menu Reports / Manage Reports and select the report definition TS1003 Time on Site (Vehicle) and click Open
- Give the report the name “Customer visits”
- Select the suitable reporting period Daily
- Select the EventRule Customer visit
- Select the Tag Show on map, or another tag that includes your vehicles
- Save your report
View your report
Now you can look at your report directly by selecting Customer visits in the Reports menu. The image below shows the result: