Configuring the Fleet Monitoring plugin role - Security Center Fleet Monitoring 2.3

Security Center Fleet Monitoring Plugin Guide 2.3

series
Security Center Fleet Monitoring 2.3
revised_modified
2021-07-19
category_custom
Guides > Plugin and extension guides
prodname_custom
City applications > Security Center Fleet Monitoring
vrm_version
2.3

Before you can use the Fleet Monitoring plugin to monitor and offload from your vehicle system, you must define your default, general, and automatic offload settings.

Before you begin

What you should know

You can choose the default type of information to offload: all data, or a subset to reduce the bandwidth and storage needed by your offload archivers.

To handle the video load in a large system deployment, multiple archiver roles can be used to offload data. To avoid overloading a single server, AVL units need to point to specific archiver roles on a per unit basis.

Procedure

  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 Default offload settings section, configure the following:
    Destination archiver
    Default archiver for video archiver transfer. This should be dedicated for long-term video storage.
    Offload video data on
    Offload video for all events, or for specific types of events. You can also specify the duration, in seconds, of video preceding and following the events to offload.
    Automatic offload on
    Enable automatic offloads for the following:
    • WiFi connected: If your vehicle system uses a WiFi adapter, start an automatic offload when your vehicle system connects to WiFi.
    • GPS unit online: Start an automatic offload when a GPS unit goes online.
    • GPS unit alarm: Start an automatic offload when a GPS unit in an alarm state.
    • Custom event: Select a custom event to trigger an automatic offload.
    • Automatic offload areas: If you are using geofences to offload, select the geofenced areas that you want to trigger automatic offloads when a vehicle enters the area.
    Raise event on
    Trigger an event on the following:
    • Automatic offload requested: Receive events when automatic offloads are requested.
    • Automatic offload started: Receive events when automatic offloads start.
    • Automatic offload finished: Receive events when automatic offloads finish.
    • Automatic offload gap: Receive events when there is a gap between automatic offloads.
    • Offload fail: Receive events when automatic offloads fail.
    Maximum items in progress per AVL unit
    Maximum number of items that can offload data at the same time during a transfer, depending on the bandwidth available for offloading.
    Require WiFi connection
    If your vehicle system uses a WiFi adapter, only offload data using WiFi.
    Require recent location data
    Only offload data if the location data of the AVL unit is recent.
    NOTE: To set a time after which data is no longer considered recent, you can modify the Stale location age setting in the properties tab of the associated GPS unit.
  4. In the General offload settings section, configure the following:
    Prioritize manual offloads
    Send manual data offloads to the top of the queue.
    Chunk size
    Maximum video duration, in hours, that can be transferred before dividing it into smaller chunks to optimize transfers.
    Best Practice: Larger chunks more likely to fail mid-transfer and have to be re-tried. The recommended chunk size is four hours.
    Max AVL units in progress
    Number of active transfers allowed simultaneously.
    Offload monitoring interval
    The update interval for data offloads in the AVL data offload status task.
    Status page update interval
    The refresh interval, in seconds, for the AVL data offload status task.
    Completed status timeout
    The duration, in minutes, before completed offloads are cleared from the AVL data offload status task.
    Video offload pending timeout
    The duration, in minutes, before a pending video offload is canceled.
    Video offload in progress timeout
    The duration, in seconds, before an in-progress offload that is not sending status updates is canceled.
    Video offload ignore no other archiver errors
    Offloads for which the target is the same as the source are marked as completed instead of generating an error.
    Offload incident titles
    You can define Security Center incidents that are automatically generated during offload. This can make it easier to search and investigate offloaded data.
  5. In the Automatic offload settings section, configure the following:
    Offload
    Choose to offload AVL data, video, or both.
    Look back time
    Sets how far back to search for video to offload.
    Maximum offload
    Maximum duration of data to offload.
    Minimum offload
    Minimum duration of data to offload.
    Overlap
    Ensures that there are no gaps between offloaded video.
    Offload order
    Set the order in which data is offloaded.
    Create incident
    Create an incident on automatic data offloads. If selected, set an Incident title.
  6. In the Manual offload settings section, configure the following:
    Default retries
    Define how many retries of a failed offload are permitted.
    Default retry interval
    Define a time period after which a retry of a failed offload occurs automatically.
  7. In the Map settings section, set the Stale data threshold. The stale data threshold is the duration, in seconds, before the icon of an inactive AVL unit changes to stale.
  8. In the Recent alarms section, configure the following:
    Max age
    Define a time period after which an alarm is no longer considered recent.
    Max alarms
    Define a maximum number of alarms that can be considered recent.
  9. In the Fleet health settings section, set the Stale data threshold. The stale data threshold is the duration, in seconds, after which fleet health data is considered stale and possibly inaccurate.
  10. Click Apply.