Configuring the Vehicle Monitoring plugin role headend - Vehicle Monitoring 2.3.18.0

Before you can use the Security Center Vehicle Monitoring plugin, also known as the GPS plugin, at the headend located in your fleet office to monitor and offload from your vehicle system, you must define your default, general, and automatic offload settings at the headend level.

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. (Optional) In the General settings section, configure the following:

   Installation type

   Select headend (wayside).

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 are using a headend only deployment, with no vehicles running the plugin and a third party system submitting all of the data through a data source. You can then 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. (Optional) In the Automatic GPS unit creation and deletion section, configure the following:
   NOTE: Activate these settings if you are using a headend only deployment.

   Automatically add GPS units

   Select this option and configure the following:

   Add GPS units to area

   Click Edit () to add automatically created GPS units to an area of your choosing.

   NOTE: It is recommended that you create a dedicated area for your automatically added GPS units.

   GPS unit for configuration

   Click Edit () and select a GPS unit whose configurations are copied when a new GPS unit is automatically added.

   Trigger message type

   GPS units can be automatically created when any data, or only metadata, is received from new vehicles that GPS units have not been created for yet.

   NOTE: If you wish to use different configurations based on metadata key and value pairs for the automatically added GPS units, you must select "only metadata" in the trigger message type.

   Automatically delete GPS units

   Select this option and configure the following:

   Auto-delete inactivity age

   The time period after which GPS units that provide no data are automatically deleted from the system.

6. 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.

7. 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.

8. 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 due to a lack of wifi.

   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.

9. Click Apply.