Discovery Rules

Scenario: You want to customize discovery rules (or create new discovery rules in order to select which rules will be used when importing objects), configure family settings, configure hierarchy settings, or create the object mapping rules associated with a family library.

 

Reference: For background information, see the reference section.

 

Workflow Diagram:

 

Prerequisites:

  • System Manager is in Engineering mode.

 

Steps:

1 – Customize Discovery Rules
  1. In System Browser, select Management View.
  1. Select Project > System Settings > Libraries > L1-Headquarter > [Discipline] > Device > [Family] > Discovery Rules Folder > Discovery Rules.
  1. Click the Discovery Rules tab.
  1. Select Customize .
  • The System Manager dialog box displays.
  1. Click OK.
  • A custom library for discovery rules is added to the L4-Project node.

 

2 – Create New Discovery Rules
  • (Optional) You want to create additional discovery rules so that you can select which rules will be used when importing objects in Discovery.
  1. In System Browser, select Management View.
  1. Select Project > System Settings > Libraries > L4-Project > [Discipline] > Device > [Family] > Discovery Rules Folder.
  1. Click the Library Configurator tab.
  1. Click Add new object .
  1. Select New BACnet Autodiscovery Library Block.
  1. In the New Object dialog box, enter a name and a description.
  1. Click OK.
  • The new library displays in the Discovery Rules folder.

 

3 – Configure Family Settings
  1. In System Browser, select Management View.
  1. Select Project > System Settings > Libraries > L4-Project > [Discipline] > Device > [Family] > Discovery Rules Folder > Discovery Rules.
  1. Click the Discovery Rules tab.
  1. Expand Family Settings.
  1. (For new discovery rules only) In the Family Name field, click the drop-down arrow and select a name. In the Sub Family Name field, enter a name of your choice.
    NOTE: the Family Name must be unique in the system.
  1. (Optional) If you want to use an optional DLL file to create a SiB-X file, check Custom SiB-X Generator, and then click Browse to locate your file in the GMS Projects > GMSMainProject > bin folder.
  1. (Optional) If you want to store device objects in a folder, check Object Folder Name, and then enter the name of the folder.
  1. (Optional) If you want this library family to support automatic detection of added and removed objects, check Supports DB Changes.
  1. (Optional) If you want to prevent the display of inconsistency alarms of your device at creation time, check Disable Consistency Alarms.
  1. (Optional) If you want to disable full discovery of your device at creation time, check Disable Full Discovery.
  1. Click Save .

 

4 – Configure Hierarchy Settings
  1. In System Browser, select Management View.
  1. Select Project > System Settings > Libraries > L4-Project > [Discipline] > Device > [Family] > Discovery Rules Folder > Discovery Rules.
  1. Click the Discovery Rules tab.
  1. Expand Hierarchy Settings.
  1. To add a level to the Logical View, click Add.
  1. To have Level 1 display the device name, select Level 1, and then check Use BACnet Device Name.
  1. Do one of the following:
  • To set the delimiter and character length for each level of the Logical View, select a level, and then check the Delimiter radio button. Enter your selections in the Delimiter, Minimum Characters, and Maximum Characters fields. You can view the results in the Preview field.
  • To set the text for each level of the Logical View, select a level, and then check the Text radio button. In the Text field, enter the desired text. You can view the results in the Preview field.
  1. Click Save .

 

5 – Create Object Mapping Rules
  1. In System Browser, select Management View.
  1. Select Project > System Settings > Libraries > L4-Project > [Discipline] > Device > [Family] > Discovery Rules Folder > Discovery Rules.
  1. Click the Discovery Rules tab.
  1. Expand Object Mapping Rules.
  1. Do one of the following:
  • To add a rule when there are existing entries, select the rule you want the new rule to come after, and then click Insert.
  • To add a rule when there are no existing entries, click Insert.
  • A new, editable row is added to the table.
  1. Complete the following fields: Vendor (ID), Object Type (ID), Property (ID), Match Strings, EO Type, Object Model Name, Function Key.
  1. To change the position of a row in the table, select a row, and then click Up or Down, keeping in mind that rules are evaluated in a top-down sequence.
  1. Click Save .