This article gives an introduction to the Ruleset Manager in Solibri Office. While Solibri Offices comes with more than 50 out-of-the-box rulesets that you can use to check your model, at some point you will want to create your own custom ruleset. This can be done in the Ruleset Manager. In Ruleset Manager, you can create new rulesets and modify existing ones.
The article covers the following topics:
In the Ruleset Manager, you can create new rulesets and modify existing ones. You can access the Ruleset Manager by clicking File > Ruleset Manager. In addition to the Ruleset Manager layout, the Ruleset Manager has an Extension Manager layout. You can read more about the Extension Manager in Using the Extension Manager. You can add your own layouts to customize the Ruleset Manager for your personal needs.
The Ruleset Manager layout has six default views: Ruleset Folders, Libraries, Workspace, Info and Parameters.
A ruleset folder is a directory on the computer’s hard disk that contains rulesets. You can have several of these folders open at once in the Ruleset Folders view of the Ruleset Manager. You can have different folders containing differently parameterized rulesets for different purposes.
If you have rulesets open in Solibri, these are also listed in the Ruleset Manager view:
By default, the Rulesets folder in the Solibri installation directory is opened when the Ruleset Manager is first started. The folders that you open are remembered when you close the Ruleset Manager.
The Libraries view lists the rule libraries that are loaded in Solibri Office in a tree in alphabetical order. A library lists all rules that it contains. By default, Solibri Office is delivered with two libraries: solibriConstructionRules.jar, AccessibilityRules.jar. The two libraries contain the rules that are recommended to be used in Solibri Office. You can drag & drop or copy a rule in the library to a ruleset you're editing in the Workspace view.
The Info view in Ruleset Manager shows information on a selected rule or ruleset. The contents of the view depend on the selected item. The information in the view is editable only when you've selected the rule or ruleset in the Workspace view.
In the Workspace view, you can create new rulesets and modify existing rulesets. You can open rules and rulesets from the Ruleset Folders view and Libraries view for editing in the Workspace view. Alternatively, you can also use drag & drop. The Workspace view works with only one ruleset at a time.
In the Workspace view, there is a possibility to add hyperlinks to the rules and the rulesets. These hyperlinks can be saved with the rulesets. They can be included in the Issue Details view, in the Results view and also the same hyperlinks will be included with the presentation issues.
In the Workspace view, you can create new rulesets and modify existing rulesets. You can open rules and rulesets from the Ruleset Folders view and Libraries view for editing in the Workspace View.
Alternatively, you can also use drag & drop. The Workspace view works with only one ruleset at a time. In the Workspace view, there is a possibility to add hyperlinks to the rules and the rulesets.
These hyperlinks can be saved with the rulesets. They can be included in the Issue Details view, in the Results view and also the same hyperlinks will be included with the presentation issues.
The method of adding the hyperlinks is the same as described in the Hyperlink Manager view. Following snapshot shows the Workspace view and the hyperlinks to the rules or rulesets in RSM.
Toolbar commands:
-
New ruleset (
): creates a new ruleset. When the workspace is empty, you can use this button to create a new empty ruleset. When the workspace is not empty, this button creates a new nested ruleset under the currently selected ruleset in the Workspace.
-
Open ruleset for Editing (
): opens the ruleset that is currently selected in the Ruleset Folders view for editing. Use this button when you want to modify an existing ruleset.
-
Close ruleset (
): closes the ruleset that you are currently editing. This doesn't, however, save the ruleset or remove it from the computer’s memory. You can reopen the ruleset by selecting it in the Ruleset Folders view and clicking Open ruleset.
-
Save (
): saves the ruleset that is currently open in the Workspace.
-
Save As (
): saves the current ruleset with a new name.
-
Up (
): moves the selected Rule or ruleset up one row in the tree.
-
Down (
): moves the selected Rule or ruleset down one row in the tree.
Ruleset Tree Table
The ruleset Tree Table includes sub-rulesets and rules of the ruleset. The support tag and a link to the rule help is provided for all rules.
Pop-up Menu
As in the Ruleset Folders view and Libraries view, the Workspace view contains also a pop-up menu that contains shortcuts to the commands that are used to modify the ruleset structure. The pop-up menu lists also the keyboard shortcuts for these commands.
The New, Up, and Down commands are identical to the ones in the tool bar. In addition to these, the pop-up contains the following commands:
-
Copy: copies the current Rule or ruleset.
-
Paste: pastes the copied or cut Rule or ruleset to the currently selected ruleset. Note that the selected item in the tree needs to be a ruleset for this command to be active.
-
Cut: cuts the currently selected Rule or ruleset to be pasted elsewhere in the current ruleset.
-
Remove: deletes the currently selected Rule or ruleset.
Ruleset with Tasks in Workspace View:
A ruleset can have Tasks which are editable only when the ruleset is opened in the Workspace View from the ruleset Folders.
A ruleset having Tasks or has the possibility to have Tasks can be opened in the Workspace View to Add, Edit, Delete, Move Up and Move Down the Tasks.
Task List:
A task list is generated for a ruleset that is opened in the Workspace view. It lists down the number of tasks that exist to be done before the ruleset is checked in the Checking view of Solibri.
-
Edit Task (
): allows you to modify the name of the task and its description.
-
Add New Task (
): opens the tasks specified to be completed before the ruleset is set for Checking in the Checking view of Solibri.
-
Remove Task (
): removes the selected task in the List of Tasks in the Parameters view and the removed task is added back to the 'Select Tasks to Add' dialog as shown below:
-
Add Generic Tasks: allows you to add your own tasks, if needed. When you press the 'Add Generic Task' button, it gives a dialog that allows you to add the name of the task, description and do some basic formatting to it. You can associate this 'Generic Task' with a Rule(s) which will appear when the ruleset is opened in the Checking view.
-
Add User Input Tasks: allows you to add missing information about the model such as a type of a building e.g. a building can be a school, office, museum, auditorium, cinema etc. The 'User Input Task' is shown to the user in the To-Do list as 'Enumeration User Input Task':
A Ruleset Folder is a directory on the computer’s hard disk that contains rulesets. You can have several of these folders open at once in Ruleset Manager (RSM). You can have different folders containing differently parametrized rulesets for different purposes. By default, the rulesets folder in the Solibri installation directory is opened when the RSM perspective is first started. The folders that you open are remembered when you close RSM.
The default location of the 'Ruleset Folders view' is in the upper left corner of the RSM perspective.
Toolbar:
The 'Ruleset Folders' Tree Table includes ruleset folders and rulesets tree, the support tag for each rule, a link to each rule help page and also the hyperlink for each ruleset/rule.
-
Refresh (
): refreshes the tree to reflect possible changes in the loaded rulesets.
-
Open (
-
Close (
'Parameters View' in Ruleset Manager is very similar to the Parameters view in Solibri. The only difference is that it is not possible to change a rule or ruleset parameter if rule or ruleset is not opened to the Workspace view.
The 'Libraries' view lists the Rule Libraries that are loaded in Solibri in a tree. A library lists all Rules that it contains.
By default, Solibri is delivered with two libraries: solibriConstructionRules.jar, AccessibilityRules.jar. The two libraries contain the rules that are recommended to use in Solibri.
You can drag or copy a Rule in the library to the currently edited ruleset in the Workspace view.
Library Tree: The Library Tree includes libraries and rule, the support tag for each rule and a link to each rule's help page.
Pop-up Menu: The Library Tree Table has also a pop-up menu that is similar to the one in the Ruleset Folders view and Workspace view. The menu is discussed in detail in the help of the Workspace view.
'Info View' in Ruleset Manager shows information about the last selected ruleset or rule. The view contents depend on the selected item. The information in the view is editable only when the selection is done in the Workspace view.
The 'Info View' contains properties of the last selection. When a ruleset or rule is selected, following information of the selection is shown in 'Info View'.
Following ruleset or rule information can be changed in 'Info View':
-
Locking: Locking is a feature that controls ability of end user to change Rule Parameters. Locking is applicable only to root ruleset, not to rules. If a ruleset is locked all the rules inside it will get locked.
-
Name: A meaningful name for ruleset or rule.
-
Description: An explanation on what the rule or ruleset is checking.
-
Author: Creator of ruleset.
-
Version: Version number of the rule.
-
Date: The modification date of rule or ruleset.
-
File: Absolute path of the ruleset.
-
Report Template: Template form.