Add Configuration Parameters to an Equipment Type

Configuration Parameters are used to represent specific information about a physical piece of equipment, such as a set point or delay setting.

You can use Equipment Editor to add parameters to an equipment type as part of a created group, or you can add them individually as ungrouped parameters.

Note: When you access the Equipment Types tab, a dialog may appear asking if you want to migrate version 1 equipment types and instances. If this occurs, see Migrate Custom Parameters to the Configuration Parameters Database.

Add an ungrouped parameter to an equipment type:

1. Open Equipment Editor and select the Equipment Types tab.

2. Open the Equipment Type to which you would like to add a parameter.

3. Select the Configuration Parameters tab.

4. In the Ungrouped Parameters panel, click the Add New Parameter button.

   A new entry is added to the list of ungrouped parameters.

   

5. Enter a Name for the parameter.

   The name needs to be unique among the ungrouped parameters. If this is not the case, the Name field will display a red border. This indicates that you need to enter a different name.

6. If required, enter a Default Value for the parameter.

7. To save your changes, select Save from the File menu, or use the Ctrl+S keyboard shortcut.

To delete a configuration parameter, click on the button marked with an "x" within the parameter row.

Add a parameter to a parameter group:

8. Open Equipment Editor and select the Equipment Types tab.

9. Open the Equipment Type to which you would like to add a parameter.

10. On the Configuration Parameters tab, click the Add New Group button.

    A new parameter group will appear with the name "NewGroup" highlighted, allowing you to enter a name. Each parameter group requires a unique name.

    

11. To add a parameter to the group, click the Add New Parameter button within the group you have created. A new entry is added to the parameters group.

12. Enter a Name for the parameter.

    The name needs to be unique among the parameters in the group. If this is not the case, the Name field will display a red border. This indicates that you need to enter a different name.

13. If required, enter a Default Value for the parameter.

14. To save your changes, select Save from the File menu, or use the Ctrl+S keyboard shortcut.

To delete a configuration parameter group, click on the button marked with an "x" next to the group name.

Note: If you delete a configuration parameter (either directly, or by deleting its parent parameter group), any fields that reference the parameter will also be cleared.

See Also

Equipment Property Referencing