Configuring the Vehicle Monitoring plugin role on vehicles - Vehicle Monitoring 2.3.18.0

Before you can use the Security Center Vehicle Monitoring plugin, also known as the GPS plugin, on board your fleet of vehicles to monitor your vehicle system, you must configure the plugin role on your vehicles.

1. From the Config Tool home page, open the Plugins task.
2. In the Plugins task, select the plugin role from the entity browser, and click the Properties tab.
3. In the General settings section, configure the following:

   Installation type

   Select In vehicle.

   NOTE: Select In vehicle if the plugin is installed in a vehicle with only one GPS unit entity.

   Automatically populate local archiver for GPS units:

   Select the local archiver as a local entity to be monitored when a GPS unit is added.

   Correlation engine support enabled:

   Choose to add capabilities for correlation engine support.

   (Optional) Fault detection guard duration:

   Define the amount of time after startup that fault detection is delayed. This gives your cameras and archivers time to come online and prevent faults from being improperly detected during startup.

   Best Practice: You must install the correlation engine to use the fault detection guard.

4. In the Data logging section, configure the following:

   Log GPS data to database

   Define if location data from the GPS plugin is saved to your database.

   Log metadata to database

   Define if metadata from the GPS plugin is saved to your database.

   NOTE: Activate these settings if you need to offload this data later and play it back with the AVL route playback task.

   Log GPS and metadata to files

   If you need to use these files with an external system, activate this setting and configure the following:

   Data log base directory

   Click Edit () to save the GPS data and metadata to a file folder of your choosing.

   Data log file maximum length

   Use the setting to define a maximum log file length. If a file reaches the maximum size, a new log file is created.

   Log health metadata

   Activate this setting to log health metadata generated by this plugin.

   NOTE: This setting should be deactivated unless your organization needs to be able to offload and playback this data.

5. In the Geofence monitoring section, configure the following:

   Monitor geofences

   Activate this setting to monitor a geo-fenced area.

   Provider type

   Select a provider type:

   • KML file
   • REST provider

   NOTE: The KML file option requires that geofences be defined in a KML file. The REST provider option retrieves geofences from the specified service.

   KML file

   KML file path

   Enter the KML file path of the geo-fenced area that you want to use or click Browse () to search for the KML file you require.

   NOTE: The MKL file path is only required when the provider type is KML file.

   REST provider

   Geofence polling interval

   The time interval after which the Vehicle Monitoring polls for geofence changes from the headend.

   headend API host

   The host address where the headend API listens for requests.

   headend API port

   The port where the headend API listens for requests.

   headend API URI base

   The base path of the headend API URI.

   Accept self-signed certificates

   Activate this setting if you want to accept self-signed certificates from the headend.

   User name

   The user name used to authenticate with Security Center at the headend.

   Password

   The password used to authenticate with Security Center at the headend.

6. In the ALPR read events section, configure the following:

   ALPR read events

   When this setting is activated, the plugin detects ALPR read events, sends them as metadata, and bookmarks video with that metadata.

   Only process when in geofence

   When this setting is activated, ALPR read events are only processed when the GPS unit is within a geofence.

7. In the REST API section, configure the following:
   NOTE: The REST API provides ingestion endpoints so that GPS and metadata can be submitted to the system. Other endpoints are available to support plugin features, such as auto config. For more information about the REST API, refer to the API documentation link.

   REST API

   Activate this setting to use the REST API service.

   API path name prefix

   The common path used for all paths served by the REST API.

   REST port

   The port that receives REST requests.

   Web SDK host

   The host used for Security Center authentication.

   Web SDK port

   The port used for Security Center authentication.

   Web SDK allow self-signed certificate

   Permit the connection to the web SDK to accept a self-signed certificate instead of requiring a valid certificate signed by a certificate authority.

   TAIP source time zone

   The time zone that the REST API uses for data from a TAIP source.

   NMEA vehicle ID position

   Where the vehicle ID is situated in the NMEA sentence.

   API documentation

   The location of documentation where details related to the REST API can be found.

8. In the Automatic shutdown section, configure the following:

   Trigger shutdown using metadata

   Activate this setting to allow Windows shutdown using a metadata key and value pair.

   Metadata key

   The metadata key that must be matched for a Windows shutdown to be automatically initiated.

   Metadata value

   The value that must be matched for a Windows shutdown to be automatically initiated.

9. In the Database cleanup section, configure the following:

   Continuous cleanup

   Activate this setting to institute continuous database cleanup to ensure that cleanup is never missed.

   Batch size

   The batch size used when applying the data retention policy.

   NOTE: A larger batch size is more efficient, but can cause timeouts on systems with fewer resources.

   Batch delay

   The amount of time between cleanup batch deletions.

10. Click Apply.