diff --git a/configuration/rules-dsl.md b/configuration/rules-dsl.md index f749bfff44..f447bfeadd 100644 --- a/configuration/rules-dsl.md +++ b/configuration/rules-dsl.md @@ -104,7 +104,7 @@ The **Rules** section contains a list of rules. Each rule has the following syntax: ```java -rule "" +rule "" [uid = ""] ['[' [, [, ...]] ']'] when [or [or ...]] then @@ -112,7 +112,9 @@ then end ``` -- `` - Each rule must have a unique name (given within quotes). It is recommended that you choose a name that has meaning when spoken. +- `` - A rule name (given within quotes) which constitutes the "title" of the rule. It is recommended that you choose a name that has meaning when spoken. This will be the name under which the rule is shown in MainUI and is the primary field used for search and sorting. +- `` - Each rule must have a unique identifier. A valid identifier can't contain '/', '\\' or have leading or trailing whitespace. You can provide this identifier, within quotes in case it contains whitespace or non ASCII characters. If not provided, it will be built automatically using the file name (containing the rule) and the position of the rule in this file, e.g. "demo-2" for the second rule in the demo.rules file. +- `` - A tag to set to the rule. This is a way to group several rules and you can then filter rules by tag in MainUI. You can provide several tags separated by commas, all enclosed in square brackets [ and ]. - `` - The triggering event upon which the rule logic is executed. A rule is executed in reaction to one or more trigger conditions. Multiple conditions are separated by the keyword `or`. Please see below for different possible triggers. - `` - Contains the logic that should be executed when a trigger condition is met, see the [script](#scripts) section for details on its syntax.