Smart rules collection

Cumulocity IoT includes preset global smart rule types. Each global smart rule type provides different parameters to configure.

On alarm send SMS

Functionality

If an alarm is created, an SMS is sent.

Parameters

The rule uses the following parameters:

You can select a single group or a single device (just one, not multiple). To enable it in other assets or devices you must navigate to each context and enable it there. Afterwards you’re able to see all target assets or devices in a list with the title “Active for target asset or devices” in the smart rule detail

Troubleshooting

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

On alarm send email

Functionality

If an alarm is created, an email is sent.

Parameters

The rule uses the following parameters:

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

• Check your spam folder.

On alarm escalate it

Functionality

If an alarm is created, sends email or SMS.

Parameters

The rule uses the following parameters:

Troubleshooting

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

On alarm duration increase severity

Functionality

If an alarm is active for a certain time, the severity is increased.

Parameters

The rule uses the following parameters:

Description

When a configured type of alarm is raised, it starts monitoring how long the alarm stays active.

If the alarm is still active after the specified duration, the severity will be increased one level, for example, from MINOR to MAJOR.

If the alarm has reached CRITICAL, it will stop monitoring because there is no further action possible.

On geofence create alarm

Functionality

If a geofence border is crossed, an alarm is created.

The rule can be configured for entering or leaving the geofence, or both. Existing alarms are cleared when the opposite condition is true again, for example, if a tracked car which has left the geofence area is re-entering the geofence area.

Parameters

The rule uses the following parameters:

|

Troubleshooting

• Make sure the device was inside the geofence at least once after creating/activating the rule.

• Check if the device is in maintenance mode. No new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

On geofence send email

Functionality

If a geofence border is crossed by leaving the geofence area, an email is sent.

Parameters

The rule uses the following parameters:

Troubleshooting

• Make sure the device was inside the geofence at least once after creating/activating the rule.

• Check your spam folder.

Calculate energy consumption

Functionality

Creates consumption data point based on data from an electric, gas, or water meter.

Parameters

The rule uses the following parameters:

The unit of the consumption measurement is always per hour (that means, if the measurements are in “kg” the consumption will be in “kg/h”).

The rule takes the last two measurements for a specified time, calculates the difference in value and time and then calculates the consumption per hour.

Example

The rule is configured to calculate every 20 minutes. The following measurements are coming in: 100 kg at 11:59 and 200 kg at 12:14. At 12:20 the rule is triggered, taking the last two measurements. It calculates value and time difference. The consumption measurement created at 12:20 will therefore be 400 kg/h. If no new measurement was created in the last period a measurement with consumption 0 will be created.

On missing measurements create alarm

Functionality

If no new measurement data has been received for a specified time, an alarm is created.

Parameters

The rule uses the following parameters:

On alarm execute operation

Functionality

If a certain alarm occurs, the specified operation is sent back to the device that raised the alarm.

Parameters

The rule uses the following parameters:

On measurement threshold create alarm

Functionality

If the measurement value enters or leaves the red/yellow range, an alarm is created or respectively cleared.

The severity of alarm is determined as follows:

• If the measurement value moves into the red range, then an alarm of CRITICAL severity is created. If it moves out of the red range, the CRITICAL alarm is cleared.

• If the measurement value moves into the yellow range, then an alarm of MINOR severity is created. If it moves out of the yellow range, the MINOR alarm is cleared.

The rule uses the following parameters from the device object or data point library:

• Data point library red/yellow range: Red range when the system should create CRITICAL alarms and yellow range when the system should create MINOR alarms. Note that the data point should have at least one of red or yellow range configured.

• Object red range: Range when the system should create CRITICAL alarms. These values can be edited in the data explorer for each data point. Note that these are close intervals ([red min: red max]) that contain the lowest accepted value and the highest accepted value, see also examples below.

• Object yellow range: Range when the system should create MINOR alarms. These values can be edited in the data explorer for each data point. Note that these are half-open intervals ([yellow min : yellow max)) that contain the lowest accepted value but not the highest accepted value, see also examples below.

Examples

Example 1 - Red range:

If we set the red range to “[60;90]”

• red min: 60
• red max: 90

and the measured value is between 60 - 90 (including the values 60 and 90) as a result a CRITICAL alarm (red) will be created.

Example 2 - Yellow range:

If we set the yellow range to “[30;50)”

• yellow min: 30
• yellow max: 50

and the measured value is between 30 - 49 as a result a MINOR alarm (yellow) will be created. The value 50 is out of the yellow range.

Example 3 - Red and yellow range:

As a result of the above behavior, we can set configurations like the following:

• red min: 60
• red max: 90
• yellow min: 30
• yellow max: 60

If the measured value is 60, then as a result a CRITICAL alarm (red) will be created because red includes the value 60.

Example 4 - Overlap:

The red range and the yellow range can overlap. A value in this overlap range is treated as being in the yellow range.

If we set the yellow range to “[30;60)” and the red range to “[50;90]”:

• red min: 50
• red max: 90
• yellow min: 30
• yellow max: 60

and the measured value is 55, a MINOR alarm (yellow) will be created.

Using these mechanisms, you can configure global threshold ranges in the data point library. These global values can then be overridden for specific objects on a case-by-case basis.

Parameters

The rule uses the following parameters:

Description

For each incoming measurement value, the rule performs the following steps:

• Check if the smart rule has a valid data point. If not, an alarm with MAJOR severity is sent from the rule engine (CEP) informing that the rule has an invalid configuration.

• Check if the rule is activated for the source object.

• Check if the measurement includes data for the fragment and series (configured data point’s parameter).

• The data of the red and yellow range is collected from either:

  • The data point library (control parameter).
  • The source object (the measurement). If found, ranges from the source object’s data point override are merged.

If no red/yellow ranges are defined in the merged parameters, no alarms are generated.

• Incoming value inside the red range: If there is no active alarm of CRITICAL severity of given type for the object, create a CRITICAL alarm, else do nothing.

• Incoming value inside the yellow range: If there is no active alarm of MINOR severity of given type for the object, create a MINOR alarm, else do nothing.

• Measurement outside of yellow and red range: If there is an active alarm of given type for the object, clear the CRITICAL and/or MINOR alarm.

Troubleshooting

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

• Check if an alarm was already cleared by the next scheduled measurements with resulting value in a green range.

On measurement explicit threshold create alarm

Functionality

If the measurement value enters or leaves the red range, a CRITICAL alarm is generated or cleared.

The severity of alarm is determined as follows:

• If the measurement value moves into red range, then the severity is CRITICAL.

• If the measurement value moves into GREEN range, no alarm is created.

Parameters

The rule uses the following parameters:

Troubleshooting

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• If you have configured an alarm mapping rule (see Alarm mapping) which changes the alarm severity, the alarm may have different severity than expected.

• Check if an alarm was already cleared by the next scheduled measurements with resulting value in a green range.

Smart rule variables

In certain rule parameters, various trigger fields can be used as variables. When a rule is triggered, the variables are replaced by the actual values of these trigger fields.

You can use this mechanism for example to insert device names or alarm text into various outputs (email, SMS).

Common fields to be used from all triggers (alarms, measurements, operations, events)

Fields specific for alarms

Fields specific for operations

Fields specific for measurements

Moreover, the following pattern is supported:

Example

Cumulocity IoT trigger

{
  "source":{
    "id":"10200"
  },
  "type":"TestEvent",
  "text":"sensor was triggered",
  "time":"2014-03-03T12:03:27.845Z",
  "c8y_Position":{
    "lat":2,
    "lng":2
  },
  "c8y_evtdata":{
    "data1":111,
    "date2":222,
    "evtInnerData":{
      "indate1":333,
      "indate2":444
    }
  }
}

Here we can for example define the following variables: