Introduction
The KPI module is designed to help you track the performance of your assets based on the key performance indicators chosen by you. You can create multiple KPIs, edit them, view, or delete them through this module.
You can only edit and delete the custom KPIs your organization has created. Default KPIs available in Farsight® cannot be modified or deleted.
Steps
1. Click KPIs from the left-hand side bar
2. Start creating a new KPI by clicking on the + Create KPI button
From the Technology dropdown, you can select which industry you want your KPI to target, either Wind or Solar. This will appear on the KPIs index page under the Technology column, so you can easily distinguish between the different KPIs you have created.
3. Check Examples to learn more
4. Choose an Output Unit from the dropdown list
5. Select a Name for your KPI. The name must be unique
6. Select the desired Target. Choices are between the asset level and the site level
7. Give your expression a name. This will help you identify it later on
8. Choose a desired Time Aggregation i.e. daily, weekly, monthly, yearly. You will need to declare an aggregation function that will aggregate data over the desired time period. See the following Glossary chapter for more info
9 Add an optional Description. This is useful for quickly differentiating existing KPIs
10. Choose a Condition from the predefined dropdown list
11. Add an Expression for the KPI. If you get a warning regarding a "Missing Aggregation Function," you must encapsulate your expression in brackets () and prefix it with SUM, AVG, MIN, MAX, or COUNT, depending on what you need it to do
12. Read more about the expressions from the Glossary. The different tabs explain how to construct your new KPI i.e., the Aggregation Functions tab explains how to create them and avoid preview errors
13. Choose an Asset
14. Select a timeframe from the Time filter
15. Click the Preview KPI button to have a preview in the right panel
16. Change between Table, Chart, and All to select the view of the Preview Area
17. Save the KPI if you are happy with the input
Glossary
Switch between different tabs to learn more
1. The Attribute Reference tab shows you the context variables that are automatically injected from asset metadata or data point context
2. The Functions tab shows you the built-in functions used to manipulate data types, perform calculations, and handle dates
3. The Aggregation Functions tab explains how to generate aggregates. These functions are commonly used in KPIs that aggregate data over time periods or across assets in the same site
4. The Operators tab shows you the logical and comparison operators you can use to build complex expressions
5. The Signals tab shows different signals based on the manufacturer
6. The KPIs tab shows you all the existing KPIs available for your organization
7. You can filter your Signals and KPIs
8. In the KPIs tab you can see your existing KPIs details in the table
