Rules Engine Overview
Learn about the Rules Engine, its purpose, and how to navigate the main interface to view, create, clone, and archive rules.
What is the Rules Engine?
The Rules Engine is a powerful administration tool that allows you to create custom automation within the platform. You can define rules that automatically create or update records when specific triggers and conditions are met. This helps streamline workflows, ensure data consistency, and reduce manual data entry.
A rule is composed of four key parts:
- Details: The primary goal of the rule (e.g., create a new record, update the current record).
- Trigger: The event that initiates the rule (e.g., a record's workflow status changes).
- Conditions: The specific criteria that must be met for the rule to run.
- Actions: The specific operations the rule will perform (e.g., set a field's value, change a workflow step).
Accessing the Rules Engine
To access the Rules Engine, navigate to the Administration zone and click on the RULES tab.
The Rules Engine Interface
The main screen of the Rules Engine displays a list of all existing rules.
- Module Selector: Use the dropdown menu at the top left (e.g., showing 'Inspections' in the image) to filter the list and view rules associated with a specific module.
- Rules List: This table shows all configured rules for the selected module, with columns detailing the Rule Name, Rule Type, and Source/Target forms.
- + NEW RULE: Click this button to open the Rule Editor and begin creating a new rule.
- ARCHIVE RULE: Select a rule from the list and click this button to deactivate it. Archived rules are no longer active but are not permanently deleted.
- CLONE RULE: Select a rule from the list and click this button to create a new rule as a copy of the selected one. This is useful for creating a new, similar rule without starting from scratch.
Version: 1
Field Types
Provides a comprehensive reference for all available field types in form design, detailing each field's purpose, specific configuration options, behavior, and typical use cases.
Creating a New Rule: Defining the Details
Understand how to create a new rule and configure its core details, which determine the primary action the rule will perform on records.