Skip to main content

Graphics Builder - Adding a Data Source for a Widget

  • Updated

How do Widgets will pull data in Graphic Viewer mode

Graphics are reviewed in Graphic Viewer mode (a module on Customer / Site / Equipment Page where a Graphic is linked to.

 
graphic-viewer-mode-customer-page.png
Graphic Viewer mode (Customer page)
 
graphic-viewer-mode-site-page.png
Graphic Viewer mode (Site page)

graphic-viewer-mode-equipment-page.png
Graphic Viewer mode (Equipment page)
 
 

The context of a Graphic and Widget’s Data Source linking define how a Widget pulls data.

The context is the entity a Graphic is linked to, can be either of the following: Customer, Site, Equipment. It defines the scope of data available for the Widget:

 

data-scope-pulled-by-widget.jpeg

Data Scope pulled by a Widget

 

 

Widget’s Data Source linking (Specify Link By) defines precise Points to pull the data:

 
linking-a-point-to-widget.png
Linking a Point to a Widget
 

For instance, if a Graphic is linked to a Customer via Point Name/Tag, a widget will pull all Points with that Name/Tag across all Sites and Equipment units of this Customer (linking to a Site or Equipment just limits the scope of the available points to be pulled). So, the scope of data pulled by a widget may change depending on the Graphic’s context. Linking a Point by URI will always pull the same data as the context is ‘hardcoded’ (Site>Equipment>Point).

Data Sources Overview

Data Sources define what data and in which way should be fetched to use this data with the widgets.

Examples of compatible data include:

  1. Current Value of a Point

  2. Historical Value(s) of a Point

  3. Point Value(s) sourced to or processed by another Widget having already configured Data Source and Data Pipeline

Adding a Data Source for a Widget

# Step Details Screenshot

1

Put a widget on the canvas

Widget must support a data source: e.g. Chart, Table, Value will work.
adding-data-source.png
Adding a Data Source for a widget

 

2

Select the widget

3

Go to ‘Properties’ tab

4

Click on ‘Add Data Source’ button

5

Specify a Source

Defines which Point value(s) will be used as Widget' input:

  1. Current Value of a Point - the latest known Value of a Point will be pulled
  2. Historical Point Value - all the available Values of a Point within the selected period in the past will be pulled.
  3. Another Widget’s Data - Point Value sourced to or processed by another Widget will be pulled:
    1. Original data (the original data that was passed to the source widget before passing through the data pipeline.)
    2. Original data processed by pipeline (filters the original data of the source widget based on the output of its data pipeline)
    3. Processed data from Pipeline ( the data output by the source widget's data pipeline)
selecting-source.png
Selecting Source
 
source-current-value.png
Source = Current Value

 

source-history.png
Source = History
source-widget.png
Source = Widget

6

Specify Link By
  1. Name
    1. A Widget will retrieve a Point by Point Name from the current context where Graphic is being attached to (Customer, Site, Equipment)
    2. A precise case-sensitive Point Name must be specified: ‘Energy Sum’ will find a Point, but ‘energy sum’ won’t.
  2. Tag - references a Point by Point’s Tag(s)
    1. A Widget will retrieve a Point by Point Tag(s) from the current context where Graphic is being attached to (Customer, Site, Equipment)
    2. A precise case-sensitive Point Tag must be specified: ‘Energy Sum’ will find a Point, but ‘energy sum’ won’t.
    3. Can specify multiple Tags (AND clause will be applied).
  3. URI
    1. Widget will retrieve a Point(s) by a pre-defined Point path (Site > Equpment > Point)
    2. Must Specify Site > Equipments > Points Path (multiple selection is available at each level)
    3. NOTE: linking by URI will result in ‘hardcoded’ Graphic: it will always show the same Point(s) disregarding the current context being attached to (Customer, Site, Equipment). URI must be avoided if it’s planned to reuse the Graphic across different Customers, should use Point Name or Tag instead.

selecting-by-link.png

Selecting Link By

 

link-by-name.png

Link By = Name

 

 

link-by-tag.png

Link By = Tag

 

link-by-uri.png

Link by = URI

 

 

Related articles