How do Metrikus Rules Work?

Created by Lewis Bailey, Modified on Tue, 3 Oct, 2023 at 12:17 PM by Lewis Bailey

An overview of the three parts of a Rule

Rules allow you to create if-then logic within the platform to create alerts and other indicators that notify you when assets change.

 

What are the main parts of a rule? 

Rules allow you to create if-then logic within the platform to create alerts and other indicators that notify you when assets change. 

 

A rule is made up of three things:

  • A state: A representation of the current status of the asset

  • A condition: Something that will trigger the rule based on the underlying data

  • An action: What should happen when the condition is met

Rules are associated with a state, and when they trigger, they change the state of the asset. You can have two types of rules: 

  • Asset Type Rules: Rules that apply to every asset of that type

  • Unique Asset Rules: Rules that apply only to that particular asset

By default, all rules created will affect every asset.

 

Managing States

A state represents the status of the underlying asset. Rules define how an asset moves from one state to the next. A state is defined as the different rule alert types that an asset can be in.

  • The default state types are Offline, Normal and Alert.

  • Additional states can be created to allow for more complex rules where an asset goes in between states before reaching its alert state, or they can be used to replace the default states if required.

Where to find states:

Go to the “map” view. Click on the “tools” icon on the top right of your page.

This will bring up the tools options.

Click on “States management”. The state window will pop up.

 

Creating a new state:

Click “New state” to bring up the state creation window.

Give your new state a name and select the sensor name you wish the state to apply to.

The colour provided will change the colour of the asset icon on the map.

  • Click save to confirm

Configuring your Rule

You can view and edit the rules associated with an asset on the ‘Live’ tab. To edit the rule, select the ‘pencil’ icon.

 

 

This will bring you to the configuration tab, where you can edit the existing rule.

 

From here, you can change any of the characteristics of the rule by altering any of the following fields:

  • Name: Rule Name

  • Active: The ability to Enable/ Disable the rule

  • Status from/ to Which state the rule is going from and to

  • Feature: This is defined by the asset type, and a drop-down option will show all the available features to choose from

  • Condition: See below for an explanation of conditions

  • Confirm Parameter: The value that the rule will look for to initiate a trigger

  • Select Action: See below for an explanation of actions

 

What are conditions

You use rule conditions to state when to carry out the rule actions by selecting from the predefined drop-down options. You define conditions in the if part of a rule. A rule condition triggers an alert based on the parameters set. The parameters available are dependent on the data feeds from that asset type.

  • Below are the set of conditions that can be selected for your rules.

 

What are Actions

An action rule defines the specific actions to take when certain conditions are met. A basic action rule uses an if-then statement to associate a condition ( if ) with an action ( then ). Example action triggers are to send an email or send an alert to any existing systems via HTTP post/get.

  • Below are the actions that can be taken for each rule created.

 


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article