Overview
Attribute aliases let you tell Virtual Facility (VF) how to classify alarms that contain a specific string of text. When an incoming alarm's text contains an alias string, VF sets the attribute fields you choose to the values you define.
Aliases make alarm data cleanup much easier. Client admin users and the VF Client Success team can correct how alarms are identified directly, without waiting on a development request.
How Aliases Work
Each alias can belong to one or more integration and has two parts:
- Alias string — the exact text VF looks for in an alarm's text.
- Attribute values — one or more attribute fields, and the value each should be set to when the string is found.
Every alarm whose text contains the alias string receives the same attribute values. When you save an alias, a reparse can be triggered so alarms already in VF are updated, not just new ones.
For example, an alias string of FBK could set the Condition attribute to Status Mismatch for all alarms containing that string.
Create An Alias
- Navigate to the Settings page.
- Under the Configuration group in the navigation panel, select Alarm Attributes.
- Click on the Aliases tab, then click on Create Alias.
- Define a Name for the alias that is short but descriptive.
- Enter the alias string exactly as it appears in the alarm text into the Pattern field. The alias string is not case sensitive.
- Add a Description, if desired, to further explain the alias.
- Define the Scope. By default, the Scope will be set to Global. This means the alias affects all integrations for this organization.
- If External System is selected, you must select a specific integration from the drop-down list that becomes active. The alias will only apply to that specific integrated system. For example, if ALC - Dormitories is selected, only alarms from this server will have this alias applied.
- If Schema is selected, you must select a type of alarm source system from the drop-down list that becomes active. All integrated systems that match that type will have this alias applied to them. For example, if ALC WebCTRL is selected, the alarms from all integrated ALC WebCTRL servers will have this alias applied.
- Select each attribute the alias should set, and enter the value for it. At least one attribute must be selected and defined. Multiple attributes can be defined under a single alias by clicking on Add Row.
- Save the alias by clicking Create Alias at the bottom right.
- Trigger a reparse if you want existing alarms updated based upon the new alias. Otherwise, the alias will only be applied to new alarms when they are received by VF.
- Check a few affected alarms to confirm the attributes now show the expected values.
Manage Existing Aliases
The alias list shows every user-defined alias for the organization. From the list you can:
- Edit an alias to change its string, the attributes it sets, or their values.
- Delete an alias that is no longer needed.
To edit or delete an alias, select the corresponding row on the table, then click on either Edit Selected or Delete Selected. As with a new alias, reparse after editing or deleting so existing alarms reflect the change.
To review and/or restore a deleted alias, click on the Deleted Aliases button. To restore a deleted alias, select the corresponding row on the table, then click on either Restore Selected. As with a new alias, reparse after editing or deleting so existing alarms reflect the change.
Best Practices
-
Use specific strings. A short or common string, such as
AHU, can match alarms you did not intend to change. Include enough of the identifier to make it unique. - Check for overlap first. Review the existing aliases before adding one. If two aliases, or an alias and VF's built-in parsing, set the same attribute on the same alarm, the result may not be what you expect.
- Escalate complex patterns. Aliases match fixed text only. If an alarm can't be classified with a string match, contact VF Support.