Skip to main content

Surfsight Camera Implementation

Internal Encompass implementation guide for the Surfsight camera integration: Surfsight API account, Geotab add-in, pairing cameras to GPS devices and camera rules. Needs Geotab integration and v24.11+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 24.11

Steps

Surfsight Camera Implementation INTERNAL ONLY May 22, 2023

Summary This document will guide a user through how to do setup and implement the Surfsight Integration with Encompass Purpose (if applicable) The Surfsight camera integration will allow customers to view and report on camera data in Encompass Precondition(s) The following workflow assumes you already have the Geotab integration. Both Geotab devices and Surfsight Cameras must have been purchased from Encompass. How to do create a connection to the Surfsight API Get a written consent from the customer from an email. Example: Hi [customer name], I am excited to hear about your decision to integrate Encompass with Geotab and Surfsight. In order for the camera data to import into Encompass, can you reply to this task and give Encompass access to the API via a user account and authorize Geotab and Surfsight to create a user ID for Encompass to access your Surfsight account? They can then create the account and provide the credentials to Encompass. I will forward your reply to Geotab. Let me know if you have any questions. Thank You, [Your name] Take a screenshot of your email from step 1 with the consent from the customer and send an email to: Jason Wilda, [email protected] Denise Oliver, [email protected] Jacob Gafa, [email protected] Victor Garcia, [email protected] Email Example: Hi Jason, I hope this email finds you well. I am excited to inform you that we have a new customer, [company name], that has ordered x Surfsight Cameras. Similar to how you all created the user accounts in the past, this is to request a new account for the SurfSight API for [company name]. Please create the username service-[companyname]@encompass8.com and email me the password at your convenience. I have attached a copy of the written consent from the [customer name] at [company name] Please let me know if you need anything else to get this account created. Thanks, [Your name] After getting the username as password from Jason at Geotab: Login to https://app.surfsight.net/#/login with the username/password provided by Jason Reset the password to something like Encompass8! Settings > Change my Password Add Surfsight credentials to Customer Notes on Support. Ex Customer Notes - 22998 Create a new GPS Authentications record on the customer’s Encompass site API Provider Name = Surfsight User Name = username from Geotab Password = new password Example: GPS Authentications - 2 [email protected] How to create the Surfsight Add-in on the customer’s Geotab site Login to the customer’s Goetab site Go to Administration > System… > System Setting Click on the Add-Ins tab Set Allow unsigned Add-Ins toggle button to On Click New Add-In button Clear out the content in the dialog box and replace it with the following text { "url": "https://app.geotab.com/addins/surf/surfsight/manifest.json" } Click OK Click Save When done, a new Surfsight Add-in will appear. See example below: This will also create a new Surfsight menu on the left Pairing or Adding Surfsight Cameras Pairing or Adding Surfsight Cameras in Geotab Get an Excel or CSV file from the customer with the Geotab Device’s Serial Number and the Surfsight Camera’s IMEI number. Both of these numbers can be found on the devices. Click on the Surfsight > Vehicles Menu Click on the Bulk Add Cameras button Copy and paste the the content of the Excel or CSV file Pairing or Adding Surfsight Cameras in Encompass With the same Excel or CSV file provided by the customer, create a table import (updated only) into the GPS Devices table. Link on the GPS Device and update the Camera IMEI field. NOTE: You can use Import Routine ID 526199 from any site as long as the file is formatted with two columns: 1) GPS Device Serial Number and 2) Camera IMEI. See screenshot below: Setting up Camera Rules in Geotab There are two types of “events” that can be captured by the Surfsight cameras. Events from the camera itself, such as Smoking, Food and Drink, Lane Weaving, and events from the Geotab device, such as Speeding, Harsh Cornering. Some of these rules or events may be redundant, but can be turned on/off at the devices level. Discuss with the customer what rules they would like to be turned on All rules are turned on or off in Geotab. When these “events” occur, data will be imported into the Vehicle Safety Events in Encompass. Updating Camera Rules The camera will have to be online or in Standby mode in order to see all the available camera rule options. The mode of the camera can be seen from the Vehicles menu. From the Surfsight > Vehicles menu, click the Camera Rules button. Unfortunately, at this time it looks like this has to be done for every camera. Updating Geotab (Video Rules) From the Surfsight > Video Rules menu, turn the rules on or off that you want the camera to capture. This will be imported into Encompass as a still image, not a video.

Did this answer your question?