The rules builder is divided into four sections:
- The command bar at the top.
- The rule editor in the middle.
- Help and diagnostics at the bottom.
- Browsers for variables etc on the right.
The Command Bar
The command bar has the following buttons:
The Rule Editor
The rule editor is where you work with a rule, you can either
type your rule directly in the rule editor, or use the function
wizards and browsers on the rule builder to insert into the
The rule is automatically colored and formatted by DriveWorks
using settings which you can modify by clicking the Settings button
on the command bar. By default, if the rule is invalid, the
background color changes to a light red, and if it is okay, then
the background changes to a light green.
Autocomplete provides all functions, constants, variables and
table names in a pop up window that is filtered as you type in the
rule editing window.
Selecting an item from the autocomplete pop up is done by
clicking on the required item using the mouse or by using the
up/down keyboard arrows to highlight the required item and hitting
return, tab or space (pl;aces a space after the selected item)
Bracket matching provides a clear indication of opening and
closing parenthesis within rules.
Place the cursor in front or behind any bracket within a rule
and bracket matching will highlight the chosen bracket and the
bracket it is paired with.
The highlighting color can be fully customized in the settings
dialog of the rule builder.
Rules insight gives clear instructions on the arguments required
for any function when manually entering the rule in the rule editor
As each argument is entered, rules insight highlights in Bold
what the next argument should be, giving examples where
When typing Functions in the Rule Builder rules insight can be closed by hitting the Escape key on the keyboard.
Rules insight will return when an argument is required, hitting Escape again will close rules insight.
Further functions are available from the right-click menu in the rule editor window.
The functions available depend on the selection made prior to the right-click:
Help and Diagnostics
There are up to six tabs on the help and diagnostics section
depending on the kind of rule being built:
When building Model or Drawing rules the help tab displays
useful information about the type of rule you are building.
This enables you to quickly see what the result of the rule
needs to be to achieve the desired outcome. For example when
building a rule for a model feature the rule needs to be "Delete"
The help tab
is not shown for control properties, variables or document
- Values tab
The values tab shows any variables and control properties
that are being used in the rule, along with their current values,
and the current result of the rule.
Shows the steps taken to evaluate the rule along with the value
of the rule at each step.
- Drill Down
The drill down tab provides the information used in the values
and steps to be analyzed by expanding the rule at each stage it
takes to get to the result.
The comments tab provides an area where notes about the rule can
The Function Wizard tab appears when a function is selected from
the Functions button.
The name of the tab changes to the name of the function
The wizard for each function provides assistance in providing
the necessary information for the function.
Functions for more information on the functions that are
There are up to six tabs on the browsers section depending on
the kind of rule being built:
Each list can be be filtered by using the filter at the top of the list.
Please see the topic How To Use Filters for more advanced filtering information.
- Controls - Shows all of the controls in the project.
You can filter to a specific form to find a control, and double
click it to use its return value in the rule. You can also single
click the control and double click one of its other properties to
use that property in the rule.
- Variables - Shows all of the variables in the
project. You can use the search box to find the variable you are
looking for, and double click it to use it in the rule.
Variable categories in the rule builder remain persistent when opening and closing the Rule Builder.
When building rules it is common to reference variables from the same category.
The Rule Builder will retain the last used view for Variables when it is reopened.
- Constants - Shows all constants in the project.
- Messages - Displays all messages created in the
Messages stage, for use within a rule.
- Components - Only shown for model file name rules,
for more information see
How To: Replace a
Component With a Static or Driven Replacement Model.
- Replacements - Only shown for model file name rules, shows any models that have been captured as Replacement Models.