User Manual

Bazefield Dashboard

TABLE OF CONTENTS

• 1    INTRODUCTION
• 2    PREREQUISITES
• 3    DASHBOARD TEMPLATES
  • 3.1    CREATE A DASHBOARD TEMPLATE
  • 3.2    LAYOUT STRUCTURE
  • 3.3    ADDING WIDGETS
  • 3.4    PARAMETERS IN WIDGET CONFIGURATION
• 4    LINKED DASHBOARDS
• 5    ADD TO MENU
  • 5.1    MENU URL PARAMETERS
• 6    WIDGETS
  • 6.1    TIME SERIES CHART
    •   6.1.1    CONFIGURATION             
  • 6.2    GAUGE
    • 6.2.1    CONFIGURATION
  • 6.3    SITE BAR CHART
    • 6.3.1    CONFIGURATION
  • 6.4    HTML COMPOSER
  • 6.5    PROCESS SCREEN
  • 6.6    REPORT
  • 6.7    SITE COLUMN RANGE CHART
    • 6.7.1    CONFIGURATION
  • 6.8    WIND ROSE
    • 6.8.1    CONFIGURATION
  • 6.9    ENERGY ROSE
    • 6.9.1    CONFIGURATION
  • 6.10    CUSTOM CHART
    • 6.10.1    SETTINGS PARAMETER
    • Title 
  • 6.11    XY PLOT
    • 6.11.1    CONFIGURATION
  • 6.12    CUSTOM LOG
  • 6.13    MAP
    • 6.13.1    CONFIGURATION
  • 6.14    HEAT MAP
    • 6.14.1    CONFIGURATION
    • 6.14.2    HTML
  • 6.15    MEASUREMENT GRID
    • 6.15.1    CONFIGURATION

1    INTRODUCTION

Bazefield Dashboards is a framework for creating dashboards in the Bazefield Portal. The dashboard framework is used to create the monitoring dashboards. See example monitoring dashboard below.

2    PREREQUISITES

To be able to add and edit dashboard and linked dashboards, the user needs access to the Dashboard templates app and the Linked Dashboards app in the portal. The user also needs the EditDashboard privilege. This privilege can be added for a role or user on the Assigned Permissions tab in the Edit Role or Edit user view of the User Manager. For more info see the Bazefield Portal User Manual(BF-01-UM-001). 

3    DASHBOARD TEMPLATES

Dashboard templates are templates for dashboards that can be placed in the menu with different parameters. Instances of the dashboard template display data based on the parameters set.

3.1    CREATE A DASHBOARD TEMPLATE

Creating dashboards is done in the Dashboard Templates app. The Dashboard Template app can be found in the portal under Administration > Configuration > Dashboard Templates. To create a new dashboard, press the “Add dashboard” button in the toolbar. The Add Dashboard Template dialog will then appear below.

3.2    LAYOUT STRUCTURE

The layout structure of dashboards is based on a 12-column grid. Each row can have a maximum of 12 columns. To create a dashboard with 3 rows like the screenshot below the following would be entered into the structure textbox 8-4,4-4-4,6-6. Columns are separated by hyphen and rows are separated by a comma. 

3.3    ADDING WIDGETS

After the dashboard is created, it can be opened by clicking on the dashboard name in the dashboard list as seen below. 

To add a widget, the dashboard needs to be in edit mode. To enable edit mode, click the Edit button in the top right corner of the dashboard. In edit mode the button Add widget is displayed. To add a widget, press this button and click on the widget you want to add in the Add widget dialog box that appears. 

After adding a widget you can move it to the correct row and column with the move handle in the header of the widget. 

To edit the settings of each widget, press the cogwheel in the header of the widget to get a dialog window with settings. 

3.4    PARAMETERS IN WIDGET CONFIGURATION

Use the following syntax ${ParameterName} in the widget configuration to specify parameters. For example, set ${Site} in the widget configuration to specify Site as a parameter. 

4    LINKED DASHBOARDS

Linked dashboards are used to link together dashboard templates so one can navigate between them via the navigation links in the toolbar of the linked dashboard and the content of the dashboard template is displayed

Creating linked dashboards is done in the Linked Dashboards app. The Linked Dashboards app can be found in the portal under Administration > Configuration > Linked Dashboards. To create a new linked dashboard, press the Add linked dashboard button in the toolbar. The Add Dashboard Template dialog will then appear below.

To add a dashboard template to the linked dashboard use the drop down and press the Add link button. 

To change the order of the links use the up down arrows on the left of the links. 

5    ADD TO MENU

To add a dashboard to the menu one first navigates to either the Dashboard template app or the Linked dashboard app in the portal. Then use the arrow in the menu to navigate to the folder where you want to add the dashboard and press the Add menu button for that dashboard.

5.1    MENU URL PARAMETERS

After a dashboard has been added to the menu, add the parameters used in the dashboard templates to the menu URL. See how to add parameters to the template in chapter Parameters in Widget configuration. This is done by pressing the Edit button on the bottom of the menu. After that press the edit icon on the dashboard to display the properties for this dashboard instance. See example for an instance of the Turbine dashboard below. The format is the same as the standard query string parameter format. 

6    WIDGETS

This chapter will explain how to configure each of the different dashboard widgets. 

6.1    TIME SERIES CHART

  6.1.1    CONFIGURATION            
 

6.2    GAUGE

6.2.1    CONFIGURATION

6.3    SITE BAR CHART

The site bar chart displays real-time data for assets or sites. 

6.3.1    CONFIGURATION

6.4    HTML COMPOSER

This widget can be used to display custom HTML that you want to display. Here you can use Bootstrap components and all other standard HTML elements.  

The HTML is defined in the Template text box. See example code below.

6.5    PROCESS SCREEN

Process screen widget can display a process view in an IFRAME. Process screen name textbox is the name of the process screen. Height text box is the height of the IFRAME that displays the process screen. In the Query parameters textbox are the query parameters to send to the process screen. 

6.6    REPORT

Report widget can display Excel (Classic) reports or HTML (New) reports. The Classic reports are located and managed in the Report Templates application and the HTML reports (new in Bazefield 7) are located and managed in the Report Management application. See separate documentation on how to configure reports.

6.7    SITE COLUMN RANGE CHART

The site column range chart displays the variations of a specified tag measurement for all assets on a site. 

6.7.1    CONFIGURATION

6.8    WIND ROSE

The wind rose widget typically displays the distribution of wind speed and direction. 

6.8.1    CONFIGURATION

6.9    ENERGY ROSE

The energy rose widget typically displays the distribution of power produced by wind direction. 

6.9.1    CONFIGURATION

6.10    CUSTOM CHART

The Chart widget is a custom tool that enables creation of various charts. Both the parameters are in JSON format. Our charts use the HighCharts JavaScript component, and examples of various charts with configurations are found here: http://www.highcharts.com/demo  

Note: Syntax errors in settings or configuration parameters will result in removal of the inputting settings once saved. 

6.10.1    SETTINGS PARAMETER

The settings parameter contains the tags, aggregates, from, to, interval and title parameters. 

Example: 

  { 
    "from": "*-1M", 
    "to": "*", 
    "tags": [ 
      { 
        "aggregate": 1, 
        "name": "TUR-WTG001-PI-ProducedMWh.AM.SUM" 
      }, 
      { 
        "aggregate": 1, 
        "name": "TUR-WTG002-PI-ProducedMWh.AM.SUM" 
      } 
    ], 
    "interval": "1d", 
    "title": "Turbines", 
    "showNow": "true" 
  } 

From and To 

These may be specified as dates (ex 2017-01-01) or you could use the relative dates where * means now. Examples on relative dates are:

Interval 

This is the sampling interval for the data, and is specified in milliseconds or with short codes as (10m, 1d, 1M etc) 

Title 

This is the chart title, and will be displayed on top of the chart, if specified. Specific Time Range 

Example:

  { 
    "from": "2018-01-03", 
    "to": "2018-01-023", 
    "tags": [ 

The configuration parameter may include all other available options in Highcharts configurations, except the ones described in chapter 8.10.1. Please see the Highcharts option reference for more info at http://api.highcharts.com/highcharts 

Example: 

  { 
    "options": { 
      "chart": { 
        "type": "line" 
      }, 
      "tooltip": { 
        "pointFormat": "{series.name}: <b>{point.y:.1f}</b><br/>", 
        "shared": true 
      } 
    }, 
    "series": [ 
      { 
        "name": "Turbine 01" 
      }, 
      { 
        "name": "Turbine 02" 
      } 
    ] 
  } 

6.11    XY PLOT

The XY plot displays scatter charts based on two tags for a selected interval. 

6.11.1    CONFIGURATION

6.12    CUSTOM LOG

See custom log manual for details on how to add custom log widget.

6.13    MAP

The Bazefield Map application provides real-time data from assets presented on the map to give an immediate overview of assets on sites.

6.13.1    CONFIGURATION

6.14    HEAT MAP

The heat map is graphical representation of tag data where the individual values contained in a matrix are represented with color-intensity. 

6.14.1    CONFIGURATION

6.14.2    HTML

Directive that may be used in reports. See Configuration chapter for settings. 

<baze-heatmap asset-ids="" tag-shortnames="" title="" height="" color="" decimals="" minvalues="" max-values="" friendly-names="" realtime="" from="" to="" aggregate="" showunits=""></baze-heatmap> 

Note that when realtime is set to true, the from, to and aggregate properties are ignored.  

6.15    MEASUREMENT GRID

The measurement grid is a widget where one can setup a grid of measurements for assets or sites. 

6.15.1    CONFIGURATION

In the configuration dialog setup either sites or assets and then fill in the property / tag suffix for the measurement to be shown in the grid. Select the aggregate to use for fetching data and the number of decimals to display per measurement n the property table. The Interval setting is how long the interval aggregates measurement data over and Refresh is how often data refreshes. The Measurement grid widget does not yet support using the filter to specify time.