Avatar
Andreea
  • Updated

Sound Alarm plugin

This guide explains how to enable the sound alarm plugin on GpsGate Server. The plugin will play an alert sound in the browser on each incoming alarm, therefore the sound will be repeated until all the alarms are closed.

How to install or upgrade the plugin

  1. Log in to Site Admin (Legacy)
  2. Go to the Plugins tab.
  3. Go to Get More Plugins.
  4. Download and install the Sound Alarm plugin.
  5. In VehicleTracker, go to Main Menu > Platform Settings > Manage Applications and select the application you want to enable the Sound Alarm plugin for.
  6. Open Privileges & Plugins, enable SoundAlarm for the application and click Save.

Enabling the Sound Alarm on the Event Rules

After installing the plugin and enabling it for the application that you are interested in, you need to enable it for the event rules you want to use it.

  1. In VehicleTracker, go to Main Menu > Events > Manage Event Rules and open the event rule you want.
  2. Go to Details and make sure Visible in application is on.
  3. Switch Sound alarm on and choose the sound from the list. Use the play button to preview the sound.
  4. Click Save.

If you use the legacy event rule editor, go to step 6 called Presentation, check the box next to Sound and choose the sound. The setting is shared: a sound chosen in one editor also works in the other.

Event presentation settings interface

Please note that these steps enable the Sound Alarm for one Event Rule in one application and they need to be repeated for each Event Rule and application on which you want to use the Sound Alarm plugin.

Mute

Once a sound alert is triggered it can be muted by clicking the button in the bottom right corner of the Workspace. The sound will stop until the next alert comes in.

mute.png

Troubleshooting

If you cannot see the Sound alarm setting in an event rule, make sure the Sound Alarm plugin is installed and enabled for the application, and that the current user has the SoundAlarm privilege enabled.

In VehicleTracker, go to Main Menu > Users & Access > Roles & Privileges. Select the Role for your user, check the box next to SoundAlarm under Privileges and click Save.

Role privileges settings interface

Related articles