Table of Contents

Page Tree

Related Pages


Overview

Displays key performance indicators in a variety ways.  It allows users to create displays containing simple numbers to a complex table.  It has various charting, text, graphics and numerical views that can be combined to create a single view of numerous KPIs.  Extremely useful when creating dashboards enabling users to see at a single glance what's happening. 

How to use the KPI. Using the KPI is very strait forward. There are several options located in the top bar which we will go over.

Once you've added a KPI you'll need to customising it.

There a many different types of content you can add to to your KPI

  • Datatag
  • Asset
  • Text
  • Scale
  • Data table
  • Chart
  • New Channel

Examples 

Click on an Image to see in Full size


KPI Tools

Edit Mode Switch

  • Toggle the edit button to edit the contents of your KPI


Live mode Switch

  • Toggle between live view and historic view. When entering historic view (live mode off) the latest value will be shown indefinitely

Offset Live Mode ON

  • Offset mode when live mode is activated will offset the live data in the past by a set period. For example, -5h would offset the data display to 5 hours ago

Offset Live Mode OFF

  • Offset mode when live mode is deactivated. Will anchor the time to a set time frame

Save and Revert

  • After you have made changes to a KPI, you will have the option to save it or revert to the last saved version of this KPI

Note - If you're not logged in or don't have permissions to change the content you will still able to change the KPI, but won't be able to save it and will loose your work

Share Page

Create Page

Global setting

  • First row Heading makes the first row bold text
  • Hide grid lines hides the grid lines
  • padding allows you define the margins of each KPI element
  • Reset weights will brings the weights of KPI elements back to 1. (ie if one is merged into 3 cells goes to 1)
  • Refresh Rate is how often the KPI updates its data

Once edit mode is on you have two ways to configure you KPI environment:

1. Grid Format

  • If you tick Use grid it will bring up a grid format where you can display data in a tabled format

2. No Grid 

  • If you untick Use grid you can freely place and move around your KPI objects
  • Use add button to add elements to your KPI
  • With the no grid format you can import images and back ground images (e.g. svg diagrams, technical drawings etc)  to go behind it and place your data on top of it like so

Edit Variables

Variables in a KPI allow a user to enter a value in one place and have it used by all the KPIs in the frame

KPI Variables

Edit Config

This were you can view and edit the configuration code of the KPI.

  • You can copy this code from one KPI and paste into to another to easily copy a whole KPI
  • Copy and paste into a text editor to perform search and replace and make changes


Edit Tags

Don't Prompt on 'Live Mode' toggle

Seamless Mode

  • This Takes away the Tools menu from your KPI and just displays the content on the screen

Delete Icon

  • Removes a row or column

Move Column or Row

  • This button is located at the top of column or side of a row
  • Click and hold then drag onto another start of a column or row to swap the row or column

Transpose

  • Transpose flips the Rows with the respected Columns
  • Transpose of a Matrix - A matrix which is formed by turning all the rows of a given matrix into columns and vice-versa

Column

  • Adds another column to you KPI macro when grid is enables under Global settings

Row

  • Adds another Row to you KPI macro when grid is enables under Global settings

Configure

  • KPI Component Configuration
  • This is where you come to configure content with in your KPI
  • Table cells can be dragged around within the widget to swap places

Z key

Use the 'z' key to copy configured elements with in your KPI

  • Hold the Z key
  • Drag a configured element onto another Configure Box to copy the content across