This document refers to rules, the rule catalogue and rule sets throughout. It is important to understand the distinction between them to avoid confusion.
A rule is a fundamental building block created by a Java programmer. Rules can be dynamically added to the system by downloading them from the TomorrowX website or other sources. In-house programmers can also add them.
Analysts generally do not create rules; they use them to build rule sets.
Examples of rules are: If Condition, History Recorder and Name Splitter.
In the rules editor, all of the rules installed are represented in the rule catalogue. It is a tree of all the rules that are available for an analyst to use. Rules are grouped into functional areas.
There is a different type of rule used to break down elements of a given network protocol. Protocol rules can only be managed by an Administrator. Protocol rules use a different rule catalogue than the standard rules.
A protocol rule is specified against any new supported protocol as well as against the response supplied from a proxied protocol request.
Rule sets are combinations of rules put together to perform a given task or strategy. They are created using the rules editor and are typically a combination of rules and other rule sets. Rule sets created by analysts show up in the rule catalogue in the rule sets section.
When a rule set is completed, it is considered a rule by itself.
A rule set mode is the rule set being executed when a data set hits the X Engine. By default, there is only one mode, but additional ones can be created to deal with specific situations (such as stand-in, promotion etc.). Modes can be changed without redeploying rules.