When you create and configure KPIs in Visual KPI Designer, the new KPI data is uploaded immediately to the KPI database and appears live on your site.
You can define attributes for new KPIs in Visual KPI Designer by entering data directly into the cells in the KPI worksheet or by copying and pasting an existing KPI row into a new KPI row.
Using Visual KPI Designer, you can also return data for you KPIs via connected interfaces. You can add functions and formulas, including relative time functions, that allow you to capture and display data in almost any way you can imagine. Learn more about the types of information and data limits of each field and all KPI attributes.
Create a New KPI
Open Visual KPI Designer and connect to the appropriate site.
Select the KPIs tab and click the New KPI icon ( ).
Enter a name for the KPI.
Note: If you have a worksheet with KPIs open and want to remove all KPIs from the current KPI worksheet, select the Replace worksheet contents checkbox (any unsaved changes are lost). This will also remove the existing KPIs from your site.
Add the new KPI using one of these options:
- Click Apply to add the new KPI and its default settings to the KPIs worksheet and continue adding KPIs.
- Click OK to add the new KPI and its default settings to the KPIs worksheet and close the dialogue.
- Click Cancel to cancel the creation of the new KPI. Once you have clicked the Apply button, the KPI(s) already added to the KPIs worksheet will not be removed.
Define KPI Attributes
Keep it simple or get really complex. Either way, use the attribute fields (columns) to define your KPI.
To save a KPI, place an “x” in the first column and click the Save icon ( ) in the open KPI tab of the Objects Toolbar. It is important to note that ALL KPIs with an “x” in the (x) column will be saved. You can remove the “x” for any KPI you do not want to save or update.
Here are a few basic attributes you may want to define. See a full list of all possible KPI attributes in the KPI Attributes & Keyword Reference.
Define Display Order
In the KPIs worksheet, enter the KPI’s Display Order. This is the order in which the KPI will be listed on the KPIs screen on your Visual KPI site.
Note: KPIs with an assigned Display Order are listed at the top of the page, in Display Order. KPIs that do not have an assigned Display Order, are displayed in alphabetical order, following the KPIs with a Display Order.
Add Text to Display on the Visual KPI Site
In the Description column, enter text that will display on the KPI page on your Visual KPI site. The text can be a description of the KPI, a URL to any Web page, a tag name used to retrieve data from an external system, or an attribute formula or function.
Set Up an Interface Connection
To retrieve the value from an external system, specify a tag name in the Actual column, and specify the interface name in the Actual Interface column. Learn more about adding Attributes Formulas & Functions to KPIs.
Learn more about configuring Interface connections.
Display on Website
If you want this KPI to be displayed on the Visual KPI site, select TRUE from the Show column list, otherwise, select FALSE.
If you want Visual KPI to determine at run-time if the KPI should be displayed, use a tag name or an attribute calculation instead of True/False. If you use a tag name for the Show attribute, you must specify the interface in the Show Interface column. Any non-zero value for Show indicates the KPI will be displayed on your Visual KPI site.
Add to Groups
If the KPI should only be included in a single Group, select the Group Name from the list of Groups already defined. Assigning a value to Group Name should be reserved for testing purposes only. If you prefer that KPIs in Groups should be determined at run-time, it’s best to build a query to create a Dynamic Group. The “–Home –“ group is the Home page for Visual KPI.
Note: Don’t forget to place an “x” in the first column to save your new KPI settings.
KPI Attributes & Keywords Reference Guide
Configure KPI Status Parameters, Colors and Icons