Event Rules wizard, a step-by-step guide
This guide details the Event Rule wizard and its different options. Below is a step-by-step guide of how to use this tool.
Creating a new rule
To create a new rule, go to Admin > Event Rules
then select + Event Rule button
Now follow the Event Rule wizard:
1. Rule name and description
The first step is to name your rule. We recommend using a name that describes what the rule will do, in short.
- Enabled: Yes/No - This option sets the event rule to active or inactive for live events, more info about live or buffered data here.
2. Who this rule applies to
Select which user tags you want this rule to work for. If you don't select any tags in this step, the event rule will apply to all your units in the application.
3. Schedule rule activity
If you select Activate on schedule, you can set this event rule to be triggered only under the specified dates/time. Otherwise, the rule is active at all times.
The expressions define which conditions trigger the event rule. There are many conditions that could be used and you can add more than one at the same time.
|Analog Expression||Suitable for evaluating analog signals (e.g. Speed, Temperature, etc.)||-|
|Digital Expression||Suitable for evaluating digital signals (e.g. SOS, Ignition, Door open, etc.)||-|
|Driver ID in Tag||Suitable for evaluating if a Driver ID is included in a specific tag||link|
|Driver ID Login||Suitable for evaluating Driver ID events||link|
|Geofence Expression||Suitable for evaluating geofence related activity||link|
|Http Expression||Suitable for generating HTTP events to an external system||link|
|Offline expression||Suitable for evaluating when a unit goes offline||link|
|Points Of Interest||Suitable for evaluating POI-related activity||link|
|Rendezvous||Suitable for evaluating if a vehicle is near another||link|
|Script Expression||Suitable for evaluating complex scenarios using scripting||link|
|Speeding Expression||Suitable for evaluating over-speeding||link|
|String compare||Suitable for evaluating strings upon received messages||-|
- Show advanced options: sets a value that will end the initial expression. This is best when you want to use a different ending condition than the initial expression that triggers the rule.
- Delayed event: you can specify the number of minutes before an event triggers. This is useful for avoiding to have many notifications at once if an expression is met repeatedly in a short period of time.
- Automatically trigger event after the delay specified above: as the events are triggered on incoming data only, this option forces triggering the alert after a specific number of minutes despite not receiving new data. For instance, if you have a 3-minute delay set, and the messages from the device are sent in 5-minute intervals, it will take up to five minutes before the condition is fulfilled and a notification is generated. Use this option only if strictly necessary.
Notifications define how you want to get notified when the expression/s in step 4, have been met. You can add more than one notification method for each event rule.
|Driver ID||Generates a notification when a Driver ID event is detected||link|
|Argument||Generates a notification of the type argument. Argument could be used to visualize variables in certain areas of the workspace and some panels in the application.||-|
|Command||Generates a notification of the type command to be sent to devices||link|
|Generates a notification via email||link|
|Email Self||Generates a notification to the associated email of the user that generated it.||-|
|Flag||Generates a notification of the type flag||deprecated|
|SMS||Generates a notification of the type SMS||link|
|SMS Self||Generates a notification to the associated email of the vehicle that generated the event||-|
|Icon||Generates a notification as icon on the vehicle tracker interface||link|
|Text||Generates a notification as text on the vehicle tracker interface||link|
|Report Argument||Generates a notification as a report argument to be used in reports||link|
|Maintenance Reminder Alert||Generates a notification when a vehicle maintenance is about to be due. To be used with Maintenance plugin.||link|
|Tag Notifier||Generates a notification as a Tag notifier||link|
|RabbitMQ||Generates a notification to be used with RabbitMQ plugin||link|
|Variable||Generates a notification of the type variable||link|
|Fleet app||Generates a push notification to be used with the mobile Fleet app||link|
Within Presentation settings, you can configure how the alert is made visible, either on the map or in the Events panel.
- Show in map view: enable to display the event rule on the map and in panels (e.g. Events, Tracks, etc.)
- Close behavior: chose whether an alert is manually or automatically closed in the event panel. The alert closes automatically when the 4. Expression is no longer true.
- Comment on close: controls whether or not you have to add a comment before manually closing the event in the event panel. More info about comments here.
- Sound: enable to generate a sound when the alert is triggered. This option requires the Sound plugin. More info about sound alert here.