Rules

In addition to sensor rules and geofences, users can also create dwelling, detention, utilization, stock and online rules. Once created, a rule can be associated to a device (if applicable). The association means that every time a telemetry is received from the device, it will be evaluated against the rule condition. As soon as the evaluation changes (for example, from true to false), an event will be recorded and a notification will be triggered.

These rules are managed via the rules endpoint.

Dwelling and stock rules use geofence events as the basis for the rule evaluation. This means that without geofences producing events, no dwelling or stock events can be generated. Furthermore, the geofence events would be used for determining whether a dwelling or a stock rule condition was fulfilled.

Detention and utilization rule evaluation is based on detected movement of the device.

A shipment can be associated with a shipment schedule rule. A shipment schedule event is generated when a shipment deviates from the specified shipment schedule.

Dwelling rule

A device is considered to be dwelling when it has stayed inside a device-associated geofence for longer than the specified threshold duration. Users can keep track of devices ageing in geofences and get notified when a device has stayed inside a geofence for too long.

Stock rule

Users can get notified when a number of devices inside a geofence crosses the specified overstock and understock limit thresholds. Unlike other rules, stock rules cannot be associated to a device. Instead, a stock rule is associated to a geofence, which is specified in the stock rule configuration.

Detention rule

A device is in detention when it has remained stationary for longer than the specified threshold duration. Users can get notified when the device has been stationary for too long.

Utilization rule

A device is considered to be utilized when it is moving or if it has been stationary for no longer than the allowed threshold duration. Users get notified when the device was taken back into use after having been stationary.

Online rule

A device is considered to be offline if it is late for the planned ingestion schedule by more than 5 minutes. The ingestion schedule can be configured in the device desired shadow. Users can get notified when the device goes offline and when it comes back to online.

Shipment schedule rule

A shipment schedule rule is associated to a shipment when the shipment is created. A shipment schedule rule is evaluated every time an ingestion from a device associated with the shipment is received and also when shipment's segment statuses are updated explicitly via the Updates segment plan details API call of the shipments endpoint. Schedule-wise, a shipment's segment state can be early, on time or delayed, based on the active segment's device ingestion time or the segment status change time. The times are compared to the provided segment ETD/ETA times. The shipment schedule rule has before and after parameters telling how much the shipment is allowed to deviate from the planned schedule before an event gets triggered.