Creating a KPI Card
About KPI Cards
KPI (Key Performance Indicator) cards are smaller than other cards and can track a point in a particular device or track a metric. Metrics are, for example, the BTU rate or electric power for an entire floor, zone, building, or site, based on the topology set up in Network Explorer > Site Explorer. KPI metrics are based on area. Edit Properties in Site Explorer provides fields to enter area values and units (see Editing a Node's Properties (Area)).
Creating the KPI Card
Access the KPI Card Staging Area
-
With the dashboard that you want to add the card to displayed, select Add Instance.
-
Select Card, which opens the card staging area.
-
Select KPI card from the card type options at the left.
Select a Point
-
Select +, which makes the Device list and Point Selector appear.
-
Locate and choose the point.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device's profile (see Editing a Device Profile). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Add Status Colors
See Adding Status Colors for details.
Add Text Slots (Optional)
-
Select Select Point.
Note: The Device and Point Selector appear, because the Point Slot tab is selected by default.
-
Select Text Slot, which switches to a text editor tab.
-
Type and format text and/or hyper-linked text, as you would in a simple word processor.
-
Select Save.
Title and Size
-
Enter a Card title.
-
Choose a default Size Type from the dropdown menu.
Add to the Dashboard
-
Select Add.
-
Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Adding Status Colors
When status colors are configured, a color-coded status bar displays on the left edge of the card's point slot. You can configure the status color to change depending on point's current value.
Using Premade Color Sets
-
Select Add colors (on the point slot's left), which makes a window appear.
-
Choose a Color Set from the dropdown menu.
-
Enter the Min value and Max value.
Note: See the preview of the color spectrum that will be applied to the entered range of values.
-
If you want this color configuration to apply to the text as well, select the Apply color to text checkbox.
-
Select Save to apply the status color configuration to the point.
Using a Custom Color Set
-
Select Add colors (on the point slot's left), which makes a window appear.
-
From the Color Set dropdown menu, select Custom.
-
Enter the Min value and Max value.
Note: To add intermediate values, select the + (Add intermediate value). Then enter the new Intermediate value.
-
Select the thumbnails below the color spectrum, which opens a color palette.
-
Do one of the following to choose a color:
-
Use the color slider and move the selection circle.
-
Enter the HEX color code.
-
Select a previously used color and opacity setting from the rectangular swatches at the bottom of the palette.
-
-
Do one of the following to change the opacity:
-
Use the opacity slider.
-
Change the seventh and eighth digits of the HEX code.
-
Select a previously used color and opacity setting from the rectangular swatches at the bottom of the palette.
-
-
If you want this color configuration to apply to the text as well, select the Apply color to text checkbox.
-
Select Close.
Note: See the preview of the color spectrum that will be applied to the entered range of values.
-
Select Save to apply the status color configuration to the point.