Skip to main content

Rules

Subscription access level

This section describes all operations that a *Subscription access level * user can perform with Caluclations (Rules).

What are rules in Inimco.facts

Real-time rules​ are user-defined rules, executed on any new telemetry message coming from an IoT device. The output of these rules could be a newly calculated value or a custom event. The rules are described as one or more formulas inside an Excel file. For instance, the formula "=A2+B2" may calculate a new custom telemetry value from two other telemetry values from the same IoT device. Currently, real-time rules are executed within the same IoT device telemetry values in real-time or periodically.

What can we do with the rules in Inimco.facts?

Real-Time Rule Creation and Management: Set up rules that apply calculations to real-time data, including:

  • Creating real-time rules based on predefined templates.

  • Editing rules to refine their logic or parameters.

  • Deleting rules that are no longer necessary.

  • Testing rules to ensure they work as expected before publishing.

  • Publishing rules to apply them to live data streams.

Procedures

Create a Real-Time Rule

  1. Log in to Inimco Facts. This will direct you to the Home screen.
  2. Navigate to the Calculations section.
  3. Click the + symbol located in the top right corner.
  4. Enter the desired rule name into the Name field.
  5. Provide a description for the rule in the Description field.
  6. Select the appropriate device from the Device dropdown menu.
  7. Choose the triggering type from the Triggering Type dropdown menu. The options include real-time or time-triggered. If you select time-triggered, you'll need to specify the cron expression of the trigger time in the Cron Expression field. For instance, if you want to execute it every hour.
  8. Select the inbound capabilities from the Inbound Capabilities dropdown menu. This refers to the incoming data that will be used for calculation. You can select as many capabilities as you need.
  9. Choose the outbound capabilities from the Outbound Capabilities dropdown menu. You're free to select as many outbound capabilities as necessary.
  10. If necessary, select Outbound events, which function as triggers to initiate specific actions. For example, every time a machine stops, select an inbound capability that signifies the machine has stopped. Ensure you check the checkbox beside This rule produces an event.
  11. Click Download sample beside the Excel file containing rules.
  12. In the downloaded Excel sheet, calculate the outbound capabilities based on the inbound capabilities.
  13. Click Upload Excel beside the Excel file with rules.
  14. Select the Excel file and confirm the upload.
  15. Click Test Rule. This will display all input data.
  16. Click Test. The output data will be displayed.
  17. Click Create rule. The newly created rule will appear as a draft in the Rules overview.
  18. Right-click the ellipsis (...) beside the new rule.
  19. Select Publish.
  20. Confirm your action.

Edit a Rule or a Metric

  1. Log in to Inimco Facts. This will direct you to the Home screen.
  2. Navigate to the Calculations section.
  3. Click the Real-time tab or the Metrics tab, depending on the type of rule you need to edit.
  4. Click the ellipsis (...) in the row of the rule you want to amend.
  5. Click Edit rule.
  6. Amend the rule as required.
  7. Click UPDATE RULE.

Delete a Rule or a Metric

  1. Log in to Inimco Facts. This will direct you to the Home screen.
  2. Navigate to the Calculations section.
  3. Click the Real-time tab or the Metrics tab, depending on the type of rule you need to edit.
  4. Click the ellipsis (...) in the row of the rule you want to delete.
  5. Click Delete rule.
  6. Confirm deletion.