Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents

Page Tree

Page Tree
rootEigen Ingenuity Components


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 ways to configure different types of content you can add to to your KPI

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

Examples 

Info

Click on an Image to see in Full size


Image AddedImage ModifiedImage ModifiedImage ModifiedImage AddedImage AddedImage Modified
Image RemovedImage RemovedImage Removed

KPI Tools

Image Modified

Image Modified

Edit Mode Switch

  • Toggle the edit button to edit the contents of your KPI
You need to toggle this in


Image Modified

Live

mode on

mode Switch

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

Image Modified

Offset Live Mode ON

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

Image Modified

Offset Live Mode OFF

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

Image Modified

Save and Revert

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

Note - If

your

you're not logged in or don't have permissions to change the content you will still able to change the KPI, but

wont

won't be able to save it and will loose your work

Image Modified

Share Page

  • This will Create a page in the Eigen Temporary space as a as a shared page
.

Image Modified

Create Page

  • This will Create a page in the Eigen Temporary space using a KPI Template
.

Image Modified

Image Modified

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

Image AddedImage Added

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

Image Added

Image Added

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.

Tip
  • 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

Image Modified


Edit Tags

Don't Prompt on 'Live Mode' toggle

Image Modified

Seamless Mode

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

Image Modified

Delete Icon

  • Removes a row or column

Image Modified

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

Image Modified

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
.

Image Modified

Column

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

Image Modified

Row

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

Image Modified

Table of Contents

Table of Contents

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

KPI Tools

Edit

Step 1 

  • First you'll need to take the KPI out of seamless mode if it is not all ready buy clicking the two arrows in circled in red.

Step 2

  • Then toggle edit mode on

Configure KPI Environment

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

  1. Grid Format
  2. No Grid Format

select the setting cog

Select Global Settings on the menu

Image Removed

Image Removed

Image Removed

Grid Format

-Select Global Settings

So here we have a number of settings if

so here are the two styles use grid and don't use grid

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

-row button adds a row bellow the bottom row

-column button adds a column to the end of the far right column

-transpose swaps the rows with the columns (inverts it)

Image Removed

Image Removed

No Grid 

If you untick 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 (ie svg diagrams, technical drawings etc)  to go behind it and place you data on top of it like so

To save your work Click save and if you are not happy with what you have done you can click revert to go back to its last save

Image Removed

Image Removed

Image Removed

Share and Create Page

If you click the share or page icon it creates a page in the temporary space with this KPI on it - Eigen Temporary Space

Image Removed

Offset KPI

Image Removed

Edit Variables

Image Removed

Edit Config

Image Removed

Edit Tags

Image Removed

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

Image Added

Image Added

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
Image Removed