Versions Compared

Key

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

...

English us

Create dashboard


Info
titleDashboard

Note that a dashboard is always related to a DATAmaestro Analytics project.

To create a dashboard:

  1. Enter on DATAmaestro Analytics project. On the vertical menu bar, click on the first icon , click on View.

  2. Enter a Dashboard Name.

  3. Click on Create

  4. Put the New dashboard name.

  5. Click Create.

  6. Click on Add widget

  7. If you don't want to save the changes, click on Stop Icon 

  8. Click Save

  9. Click on Clone in More Actions to clone the dashboard. 

  10. Click on View Full Screen to display the dashboard in full screen. 

There are two types of widgets available in DmD:

  1. Static DATAmaestro Analytics widgets: Select from existing visualization tasks in the corresponding DmA project.

  2. Real-time widgets: Visualize real-time data directly from DM Lake (DmL) on new tasks or combine existing models from DM Analytics with real-time data.

DATAmaestro Analytics Widgets:

Add Widgets to your Dashboard

  1. Click + Add Widget beside the dashboard name.

  2. Select a widget in Viewer.
  3. Enter a Title for this widget.

  4. Position tab, click on Width and Height to enter manually the width and height of the widget.

  5. Enter a value for X and Y to position manually the widget. 

Add Data table

This widget inserts a data table based on an existing task in the corresponding DmA project.

  1. Select in Viewer Data table

  2. Enter a Title for this widget.

  3. Select a Task.  The list contains existing tasks (data sources, function variables and variable sets).  

  4. Click OK.

  5. Click on Previous or Next buttons to go through the data table. 

Add Histogram

This widget inserts an existing histogram from the DmA project.

  1. Select in Viewer Histogram.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all histograms created in the DmA project.

  4. Click OK.

Add Scatter plot

This widget inserts an existing scatter plot from the DmA project.  

  1. Select in Viewer Scatter plot.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all scatter plots created in the DmA project.

  4. Click OK.

Add Trends

This widget inserts an existing Trend from the DmA project.  

  1. Select in Viewer Trends.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all Trends created in the DmA project.

  4. Click OK.

Add Record set summary

This widget inserts the rules for an existing record set from the DmA project.

  1. Select in Viewer Record set summary.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all record sets created in the DmA project.

  4. Click OK.

Add Data report

This widget inserts an existing data report from the DmA project and allows the user to customize the variables to be displayed.  

  1. Select in Viewer Data report.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all data exports created in the DmA project. For more information refer to the DATAmaestro Users’ Guide).

  4. Select Mode. There are three options: All variables, Selected Variables and Custom.

  5. Click OK

Mode 

Description

All variables

All variables in the existing Data Export will be displayed. Note: All variables, in this case, refers only to variables contained in the Data Export, not all variables in the project.

Selected variables

Select the variables to be displayed from the current Data Export variables list.

To add variables:

  1. Click on the + Add row.

  2. Define the label to be displayed on the dashboard for each variable.

  3. Repeat for the selected number of variables.

Custom 

For advanced users: A selection of variables can be defined using JAVAscript.

Example: The following example provides JavaScript for one variable “Tag1” with the label “temperature” and headers activated. Not showing all variables (showAll = false) .


Code Block
languagejs
titleExample Custom selection of variables
linenumberstrue
collapsetrue
{
    "rows": [
        [
            {
                "header": true,
                "label": "temperature"
            },
            {
                "variableName": "Tag1"
            }
        ]
    ],
    "showAll": false
}


Add Summary Chart 

This widget inserts an existing summary chart created in the DmA project.

  1. Select in Viewer Summary Chart.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all summary charts created in the DmA project.

  4. Click OK.

Add Summary Chart Table

This widget inserts an existing summary chart table created in the DmA project.

  1. Select in Viewer Summary Chart Table.
  2. Enter a Title for this widget.

  3. Select Task. The list contains all summary charts created in the DmA project.

  4. Click OK.

Add Decision tree

This widget inserts an existing Decision Tree from the DmA project.

  1. Select in Viewer Decision tree.
  2. Assign a Title to this widget.

  3. Select Task. The list contains all decision trees created in the DmA project.

  4. Click OK.

Control View of the decision tree: 

Menu item 

Name

Description

Reset

Reset zoom to the original level

Zoom 

Activate Zoom in or out 

Legend

Legend containing information of the decision tree: symbols and related colors, learning and test sets success rates. 

Add PRIM analysis results

This widget inserts the existing PRIM analysis result table (Rules tab) from the DmA project.

  1. Select in Viewer PRIM analysis.
  2. Assign a Title to this widget.

  3. Select Task. The list contains all PRIM models created in the DmA project.

  4. Click OK.

Add Pareto for tree-based models 

This widget inserts any existing Tree-based model (Decision Tree, Extra Trees, etc) from the corresponding DATAmaestro Analytics project.

  1. Select in Viewer Pareto for Tree model.
  2. Assign a Title to this widget.

  3. Select Task. The list contains all decision trees created in the DmA project.

  4. Click OK.

Real-time Widgets:

Add Real time trends

This widget allows the user to customise real-time trends with variables and data from DATAmaestro Lake.

  1. Select in Viewer Trends.
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the trend will be refreshed and new data will be displayed. Values can vary from 1 second to more than 24 hours.  If No interval the trend is not refreshed. 

  4. Select Time Range. This is the window of time displayed on the trend. This windows runs backwards from the current time (on the dashboard) back the given time range. 

  5. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets below). Specify the Url, User name and Password for the dataset. Click OK

    Info
    titleExternal Lake

    Enter a Datasource, if connecting to a remote Lake.


  6. To add variables, click on +Add trend.

    1. Select Folder.

    2. Select a Tag.

    3. Select Color from a color palette (optional).

    4. Select a Minimum and Maximum Y axis value (optional). If it is not determined the range of the Y axis is defined automatically.

    5. Check the box to Display data points on trends (optional). 

    6. Check the box to Link data points (optional). 

    7. Check box Fill to fill below the curve (optional).

    8. Check box Hidden to hide the curve (optional).

    9. Define Label to assign a label to a curve (optional). If not defined the tag name (Folder/Tag Name) is assigned.

    10. Repeat to select all required variables (variables may be selected from different folders).

  7. Click OK.

For Refresh Period and Time Range the following units are supported: 

Letter

Description

d

Day

Hour

min

Minute 

s

Second 

ms

Milliseconds 


Info
titleDatasources for Dashboard widgets

Important remark: When two (or more) servers are working with Single Sign On, do NOT enter the Username and Password in Dashboard widgets. For Dashboard widgets, it is the browser that carries the authentification and it is capable of identifying the current DM Analytics user to access the DM Lake. Applying a different user and password in Dashboard widgets changes the current user and can cause errors.

Add ISHM model result

This widget inserts an existing ISHM model from the DmA project and calculates the current performance based on real-time data from DATAmaestro Lake.  

  1. Select in Viewer ISHM.
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the trend will be refreshed and new data will be displayed. Values can vary from 1 second to more than 24 hours.  If No interval the trend is not refreshed. 

  4. Select Time Range. This is the window of time displayed on the trend. This windows runs backwards from the current time (on the dashboard) back the given time range. 

  5. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK

  6. Select ISHM path. The path in the lake that contains the ISHM computed variables

  7. Select Data Path. The path in the lake that contains the tags referenced by the ISHM causes. This defaults to the same value as the ISHM path. 

  8. Enter a Tag Prefix. The prefix that will be used to build tag names from ISHM cause values. Defaults to ISHM task name.

  9. In Trend, select the tags e.g. ISHM global distance and Cumulative sum of the ISHM_Distance. 
    1. Choose a Color from the palette. 

    2. Display data points on trends. 

    3. Link data points. 

    4. Fill below the curve. 

  10. Click OK.


Info
titleValue checker for ISHM Distance

Add to the ISHM curve a Value Checker using the ISHM-distance. Add two thresholds with Type Value to check the ISHM distance. 


Add Ranges Checker

This widget inserts a range checker which verifies if a given variable currently lies within a predetermined range.  

  1. Select in Viewer Ranges Checker.
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours. If No Interval the range checker is not refreshed. 

  4. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

  5. To define the variable to monitor: 

    1. Select Folder.

    2. Select a Tag.

    3. Enter a Title, if required. 

    4. Enter a Unit, if required. 

    5. Click on + Edit Thresholds

    6. Select a Type in Edit Range checker bound:

      1. None: No value is displayed (blank).

      2. Value: Enter a numerical value (>=). Choose a Color from the palette. 

      3. Task: Add Tasks refer to DATAmaestro analytics tasks (predictive models and function variables). Once a Task has been selected  the input parameters used for the model are automatically detected. However, it is necessary to select the corresponding data in DATAmaestro Lake by indicating for each variable the respective Folder and the Tag Name of the ParameterChoose a Color from the palette. 

      4. Tag: Select a tag from DATAlake. Select a Folder. Select a TagChoose a Color from the palette. 

      5. Click on Clear Thresholds to remove all thresholds defined. Click on trash icon beside each threshold to delete one at the time. 

    7. Define a Label to assign a label to the variable. If not determined the tag name (Folder/Tag Name) is assigned.

    8. Enter a Unit, if required. 

    9. Click on Delete a Tag, if required.

  6. Repeat to select all required variables to monitor (variables may be selected from different folders).

  7. Click OK.

Add Value Checker

This widget inserts a value checker which verifies if a given variable currently lies within a predetermined range.  

  1. Select in Viewer Value Checker
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours. If No Interval the range checker is not refreshed. 

  4. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

  5. Select a Folder

  6. Select a Tag

  7. Enter Unit, if required. 

  8. Enter Font size, if required. Example: 15pt. 

  9. Click on + Add Threshold

  10. Enter a numerical Value (>=). 

  11. Select a Color from the palette. 

  12. Select a Background Color from the palette, if required.  

  13. Click on Clear All to clear all values. 

  14. Click OK

Add Gauge Checker

This widget inserts a gauge checker which verifies if a given variable currently lies within a predetermined range.  

  1. Select in Viewer Gauge Checker
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours. If No Interval the range checker is not refreshed. 

  4. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

  5. Select a Folder

  6. Select a Tag

  7. Enter Minimum Value

  8. Enter Maximum Value

  9. Enter Unit, of required. 

  10. Click on + Add Threshold

  11. Select a Type

    1. None: No value is displayed (blank).

    2. Value: Enter a numerical value (>=). Choose a Color from the palette. Select a Background Color from the palette, if required. 

    3. Task: Add Tasks refer to DATAmaestro analytics tasks (predictive models and function variables). Once a Task has been selected  the input parameters used for the model are automatically detected. However, it is necessary to select the corresponding data in DATAmaestro Lake by indicating for each variable the respective Folder and the Tag Name of the ParameterChoose a Color from the palette. Select a Background Color from the palette, if required.

    4. Tag: Select a tag from DATAlake. Select a Folder. Select a TagChoose a Color from the palette. Select a Background Color from the palette, if required.

    5. Click on Clear Thresholds to remove all thresholds defined. Click on trash icon beside each threshold to delete one at the time. 

  12. Select Link Dashboard (Optional), this will help when creating several levels of Dashboards. 
    1. Select Project and Dashboard to create link.
  13. Click OK.

Info
titleLast value date

Display the last value date on the gauge and Link Dashboards. 



Add Real time Decision tree

This widget inserts an existing Decision Tree from the DmA project and calculates the current performance based on real-time data from DATAmaestro Lake.  

  1. Select in Viewer Real Time / Decision tree.
  2. Assign a Title to this widget.

  3. Select Task. The list contains all decision trees created in the DmA project. Once a Task has been selected the input parameters used for the model are automatically detected. However, it is necessary to select the corresponding data in DATAmaestro Lake by indicating for each variable the Folder and the Tag Name of the Parameter.

  4. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours.  If No interval the decision tree is not refreshed. 

  5. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

  6. Click OK.

Add Custom Table 

This widget inserts a custom table.  

  1. Select in Viewer Custom Table
  2. Assign a Title to this widget.

  3. Enter number of Rows

  4. Enter number of Columns

  5. Enter Font size, if required. Example: 15pt. 

  6. On the table, click on the selection icon 

  7. Select a Type of a cell:

    1. Text: enter a Value. Choose a Color from the palette. 

    2. Value: Enter a numerical value, a task or a tag .  

      1. Select a Value:

        1. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

        2. Choose a Tag

        3. Click on the checkbox Display Tag Name? , if the Tag Name should be displayed. 

        4. Click on the checkbox Display Value Date? , if the last value date should be displayed. 
        5. Enter tag Unit, if required. You can also click on Fetch unit from Lake metadata

        6. Enter tag Label, if required. You can also click on Fetch label from Lake metadata
        7. Click + Add Threshold

        8. Select Type

          1. None: No value is displayed (blank).

          2. Value: Enter a numerical value (>=). Choose a Color from the palette. 

          3. Task: Add Tasks refer to DATAmaestro analytics tasks (predictive models and function variables). Once a Task has been selected  the input parameters used for the model are automatically detected. However, it is necessary to select the corresponding data in DATAmaestro Lake by indicating for each variable the respective Folder and the Tag Name of the ParameterChoose a Color from the palette. 

          4. Tag: Select a tag from DATAlake. Select a Folder. Select a TagChoose a Color from the palette. If the tag is symbolic, select Edit symbols mapping.

          5. Click on Clear Thresholds to remove all thresholds defined. Click on trash icon beside each threshold to delete one at the time.

    3. Metadata: Add Metadata corresponding data in DATAmaestro Lake

      1. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours.  If No interval the decision tree is not refreshed. 

      2. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

      3. Select a Folder

      4. Choose a Tag

      5. Click on the checkbox Display Tag Name? , if the Tag Name should be displayed. 

      6. Click on the checkbox Display Tag Title? , if the Tag Title should be displayed. 

      7. Click on the checkbox Display Tag Unit? , if the Tag Unit should be displayed.

      8. Click + Add Threshold

      9. Select Type

        1. None: No value is displayed (blank).

        2. Value: Enter a numerical value (>=). Choose a Color from the palette. 

        3. Task: Add Tasks refer to DATAmaestro analytics tasks (predictive models and function variables). Once a Task has been selected  the input parameters used for the model are automatically detected. However, it is necessary to select the corresponding data in DATAmaestro Lake by indicating for each variable the respective Folder and the Tag Name of the ParameterChoose a Color from the palette. 

        4. Tag: Select a tag from DATAlake. Select a Folder. Select a TagChoose a Color from the palette. 

        5. Click on Clear Thresholds to remove all thresholds defined. Click on trash icon beside each threshold to delete one at the time.

  8. Select Link Dashboard (Optional), this will help when creating several levels of Dashboards. 
    1. Select Project and Dashboard to create link.
  9. Click OK.

Info
titleValue date & replace Symbol

Display the last value update date on Custom Tables.

Replace Symbols or Tag Names by Titles.

Add SPC Trends 

This widget inserts a Statistical Process Control (SPC) real time trend. 

  1. Select in Viewer SPC Trend
  2. Assign a Title to this widget.

  3. Select Refresh Period. This defines the interval at which the new data is displayed. Values can vary from 1 second to more than 24 hours. If No Interval the range checker is not refreshed. 

  4. Choose a Datasource, if required (See additional information on Datasources for Dashboard widgets above). Specify the Url, User name and Password for the dataset. Click OK.

  5. Select a Time Range

  6. In SPC Parameters, select the Trend tag

    1.  Choose a Color from the palette. 

    2. Enter mininum Y value in Min Y

    3. Enter maximum Y value in Max Y

    4. Check the box to Display data points on trends. 

    5. Check the box to Link data points

    6. Check the box to Fill below the curve. 

    7. Enter a Label.  

  7. Enter Upper Limit

    1. Enter the Type. There are two options : Tag or Value

    2. Choose a Color from the palette. 

    3. Select Style, dashed line or solid line. 

  8. Enter Upper Limit

    1. Enter the Type. There are two options : Tag or Value

    2. Choose a Color from the palette. 

    3. Select Style, dashed line or solid line. 

  9. Enter Central Line

    1. Choose a Color from the palette. 

    2. Select Style, dashed line or solid line.

  10. In Moving Range, check + Add Moving Range Chart.  The Moving Range is a trend calculated on the SPC Trend with the formula : mrY = |yi - y(i-1)| with mrY the Moving Range point and yi the SPC Trend point. The Moving Range will have the same violations rules as the SPC Trend.

  11. Add SPC additional rules

    1. Click + Add a Rule.

    2. Select a Rule. Check the table below to understand the options available. 

  12. Click OK

The SPC Violation rules, a point is highlighted when:

Rule 

Description

Outside a Limit

The point is outside a control limit (UCL or LCL)

Above the Mean

x points in a row are above the central line

Below the Mean

x points in a row are below the central line

An Upwards Trend

x points in a row are following an upwards trend

A Downwards Trend

x points in a row are following a downwards trend

Alternating Up and Down

x points in a row are alternating up and down

Zone A or Beyond 

x out of y points in a row are in zone A or beyond

Zone B or Beyond

x out of y points in a row are in zone B or beyond

In Zone C

x points in a row are in zone C only

Not in Zone C

x points in a row are in not in zone C

To calculate the Zone, the UCL and LCL are considered 3 sigma from the central line. 

Rule Description
Zone Afrom a control limit to 2 sigma: [2σ - UCL] & [LCL - -2σ]
Zone Bfrom 2 sigma to 1 sigma: [1σ - 2σ] & [-2σ - -1σ]
Zone C from 1 sigma to the central line: [0σ - 1σ] & [-1σ - 0σ]


Add Load Curve 

The custom Load Curve widget draws a polynomial curve, shows the last data point and colours the last data point as a function of the position with respect to the polynomial curve. This is a particularly interesting curve for Energy performance monitoring. 

  1. Select in Viewer Load Curve
  2. Assign a Title to this widget.

  3. Write in the script area. An script example is shown here below. Some properties that can be added to the script:  

    1. Under viewer, enter “loadCurve.html"  
    2. drawThresholdLimits: true or false
    3. Xrange: Defines min and max values for X axis
    4. xTag: Enter the full tag path
    5. yTag: Enter the full tag path
    6. Coefficients: This are the coefficients for a polynomial equation in ascending order (x0, x1, x2, x3, x4, …)
    7. Interval: Frequency of widget refresh (ms)
    8. Threshold: Defines limit for red, orange or green data point
      1. Above the curve defined by the “coefficients” the point will be red.

      2. Below the curve, until the « warning limit » the point will be orange.

      3. Beyond that, the point will be green.

    9. yLabel: Title for y axis
    10. xLable: Title for x axis
    11. yRange: Defines min and max values for X axis
    12. goal: "maximize", "minimize" or "target". 
  4. Click OK
Code Block
titleLoad Curve widget
linenumberstrue
collapsetrue
threshold remplaces warningLimit
goal: "maximize" or "minimize" or "target"
drawThresholdLimits: true or false

{
"drawThresholdLimits": true
"xRange": {
"min": -2,
"max": 2
},
"goal": "maximize",
"xTag": "/demo/test1",       
"yTag": "/demo/test2",
"coefficients": [
0,
-1
],
"interval": 1000,
"threshold": 0.5,
"yLabel": "y",
"xLabel": "x",
"yRange": {
"min": -2,
"max": 2
},
"goal": "maximize"
}



Add Moving CUSUM 

The custom Cusum widget calculates the cumulative sum of any tag starting from zero. 

  1. Select in Viewer Moving Cusum
  2. Assign a Title to this widget.

  3. Write in the script area. An script example is shown here below. Some properties that can be added to the script. All parameters are options exception to that is Tag. Period and interval are in milliseconds. 

    1. Under viewer, enter “movingCusum.html”
    2. Period: Time window of the cumulative sum (ms)
    3. Interval: Frequency of widget refresh (ms)
    4. Tag: it is the tag to be summed and displayed on the graph
    5. Factor: Multiplication factor of the tag.
      1. This can be helpful to account for units as the widget calculates the integral on a second basis.
      2. Eg. If the tag units are T per hour: Tag T / h * 1h / 3600s to calculate the correct T value (1/3600 = 0.00027777778)
    6. yLabel: Title for y axis
  4. Click OK
Code Block
titleMoving Cusum widget
linenumberstrue
collapsetrue
{
   "period": 86400000,
   "interval": 3600000, 
   "tag": "client/site/area/computed/GAP_KPI-Steam-Spec-Def",
   "factor": 0.00027777778,
   "yLabel": "Cumulated Gains or losses (Euros)",
   "xLabel": "Date"
}


Edit Widgets

Click on arrow on top right of the widget. 

  1. Click on Edit.
  2. Make changes.
  3. Click on OK button to save it.
  4. Delete an existing Widget
  5. Click on arrow on top right of the widget. 
  6. Click on Delete (Trash Icon)

To Edit a dashboard:

  1. Enter on DATAmaestro Analytics project.
  2. On the vertical menu bar, click on the first icon , click on View.
  3. If there is only one dashboard, click on Edit.
  4.  If there are several ones, select the dashboard to be edited using View then, click on Edit. Otherwise, on the vertical menu bar click on Edit icon. 


Info
titleIf you don't want to Save the changes in dashboard

If you don't want to save the changes you've made in the dashboard just click on stop icon 


To Delete a dashboard:

  1. Enter on DATAmaestro Analytics project. On the vertical menu bar, click on the first icon , click on View.
  2. If there is only one dashboard, click on Edit
  3. If there are several ones, select the dashboard to be edited using View then, click on Edit. Click on the trash icon to delete the dashboard. Otherwise, on the vertical menu bar click on Delete icon. 


To expand widgets on dashboards:


            


To change date to view dashboard in the past:

  1. Enter on DATAmaestro Analytics project. On the vertical menu bar, click on the first icon , click on View.
  2. Use the calendar or magic wand to select a date (in the past) or manually edit the date you wish to see. 



Info
titleHome

In full-screen mode, use the “Home” button to change between dashboards




Info
titleLink Dashboard

Create several levels of Dashboards and drill-down using linked DATAmaestro Dashboards. 


  1. Select Link Dashboard on Gauges or Custom Tables. 
  2. Select Project & Dashboard to create link.


Info
titlePlay and Pause

You can now play and pause real time dashboards.


...