Next, users must create a tag bundle to use with the Alarm Config. Below is an example we're using. We have built in alarm tag bundles if you want to use those for references as well.
- The user would now need to open DB Builder and open the Tag Bundles tree to create a new tag bundle
- To learn more about the Tag Bundles Tree See ___.
- Once there, the user will click on the
towards the top right to create a new tag bundle.
- Once selected, the will be displayed with a popup window called Add Tag Bundle.
- When filled out, the user can select the Apply button to create a tag bundle.
Name (required) - this would be a name for the tag bundle Description (optional) - this is where the user can specify a description of what this tag bundle is for Allow Filter (optional) - this is where the user can specify which records this will run against and apply/remove the tags Tags to Add (optional) - this is where the user can specify what tags to apply to the point records Tags to Remove (optional) - this where the user can specify what tags to remove on the point records if any Config Type (required for Alarm Config) - this is where the user can specify what type of bundle this would be for. In our case, we choose Alarm in order for it to appear in the Alarm Config app. Once Alarm is selected, the user will get another option below it to pick the Point Kind (required) - this is where the user will pick for which type of point this bundle is for (this will make the bundle only appear for appropriate type in the Alarm Config app) Track Bundle (optional) - this is where the user can specify if they want to track the bundle or not. What this does is adds a tag depending on what was chosen above on Config Type. In this case, Alarm was chosen, so it would add an "alarmConfig" tag on the point record and list the name of tag bundle(s) being used by that particular point. If none was selected for Config Type, the tag would be "bundles" and if History was selected, it would by historyConfig, etc. |
Sample:
Name
we chose "Boolean Alarms" for the tag bundle name.
Description
we chose "Trigger alarm if bool is true."
Allow Filter
we chose "point and kind=="Bool"" for the allow filter. This means we can only apply this to points that are boolean types.
Tags to Add
we chose to add the below tags as examples of what the user can do, but the user can choose anything they want. Only one required is the "allowProgram":
allowProgram (marker - required) - this tag is needed in order to allow a program to run on points, without it, the program cannot run on it only equips.
alarmPoint (marker - personal preference) - this is a tag to categorize this point as an alarm point. So instead of using "alarm", we recommend using "alarmPoint" because "alarm" is a system tag that is reserved for the alarms app.
alarmEnable (boolean - personal preference) - this is a boolean tag that we can use to remove a point from being "alarmable" if we needed to without removing it completely from the alarm configurations as we'll show you later on.
boolAlarm (boolean - personal preference) - this is to label the point as "boolAlarm" so that we can distinguish it between different programs in the event multiple different programs on running on it for different types of alarms. We'll be using this in the programOn so that the program only runs on these types of points.
alarmText (string - personal preference) - this is to add a dynamic alarmText instead of making a generic one in the alarmBlock when creating the alarms in the program. We'll be showing you how this is linked in the program later on. "bool" would be the variable name inside the program and the '$' before it is to grab the value of that variable and use it in the alarmText field. For example, if the bool variable returns the point navName, it will inject that navName in the alarmText field and say something like "Fan is true" for example.
Config Type
we chose Alarm since this is an example of how the Alarm Config works
Point Kind
we chose Boolean since we'll be created boolean alarms.
Track Bundle
we enabled this to show you what would happen when applied