Prerequisites
From the io-base portal, connect to IndaBoard.
Through the menu My Dashboards, view a dashboard from the list.
The components
A dashboard is a set of components, arranged on a grid.
Several types of components are available:
chart
stacked chart
piechart
XY chart
gauge
table
metric
text
integral
To add a component, click on the icon at the top right.
The list of available components is displayed. Choose the component you want to create.
Creating a Graphic component
Properties
To create a graphic component, you must first enter the general information of the component:
a title
a description (optional)
the period of the data involved
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
Curves
Once the general information is entered, you can select the tags to be used, by clicking on the Metric Search button.
The usual io-base metric search window opens. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metrics, click on the button to add them. The metrics appear in the table on the right.
You can delete the metrics from the right table by using the delete icon.
Note : for a graphic component, it is possible to add several metrics.
To validate the selection, click on Save.
A preview of the chart is displayed on the right.
You can set several details on the charts:
the name of the curve (which will change in the caption)
To do so, go to the Actions column, then click on the button enlightened below :
The ‘Options’ section becomes visible, and contains the ‘Display name’ field. Here you can enter the name you want :
the type of graph (bar, line or scatter)
You can also indicate whether you want the curves to appear in a staircase (straight lines from value to value) or interpolated.
Each curve can be duplicated.To do so, go to the Actions column, and click on the boxed button below :
Scales
From the Scales table, you can enter minimum and maximum values for the visibility of your graph, as well as the pitch to be applied for the graduations. Each time you make a change, the graph updates on the right side to show the changes.
Thresholds
Finally, it is possible to define one or several thresholds (horizontal or vertical, with legend, color, and if it should appear as a continuous or dotted line).
Finally, it is possible to define one or more thresholds (horizontal or vertical), with a label, color, and whether it should appear as a solid or dashed line.
To do this, click on the 'New Threshold' button :
Configuration fields will appear to allow you to define the new threshold.
Start by selecting the axis for which you want to create a threshold.
Name your threshold :
Then, specify the position where you want the threshold label to appear on your chart :
- at the beginning :
- in the middle :
- at the end :
You can then configure the definition of your threshold by clicking on the button representing the threshold :
Specify :
- line or dotted line :
- position of the threshold : horizontal or vertical
- threshold value : the value where the threshold line will be drawn
For example, with the value '30':
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creation of a gauge component
Properties
To create a gauge component, you must first enter the general information of the component :
a title
a description (optional)
a minimum value (start value of the gauge) and a maximum value (end value of the gauge)
the time interval of the data involved
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
the number of decimal places to display on the gauge
Metric
Once the general information is entered, you can select the metrics to be used, by clicking on the Metric search button.
The usual io-base metric search window opens. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metric, click on the button to add it. The metric appears on the right.
You can delete the metric from the right table by using the delete icon.
Note : for a gauge component, it is only possible to add a single metric.
To validate the selection, click on Save.
A preview of the component is displayed on the right.
You can set several details on the gauge :
the type of aggregation used
the color used
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creation of a table component
Properties
To create a table component, you must first enter the general information of the component:
a title
a description (optional)
the time interval of the data involved
the number of decimal places of the displayed values
the number of elements that will appear per page in the table (number of rows in the table)
Note : The Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
Metrics
Once the general information is entered, you can select the metrics to be used, by clicking on the Search metric button.
The usual io-base metric search window opens. Several tabs allow a search either from the tree structure, or by meta-data, or by tag name. When you have found the right metrics, click on the button to add them. The metrics appear in the table on the right.
You can delete the metrics from the right table by using the delete icon.
Note : for a table component, it is possible to add several metrics.
To validate the selection, click on Save.
A preview of the table is displayed on the right.
You can set several details on the table :
Each line can be duplicated.
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creating a Metric component
Properties
To create a metric component, you must first enter the general information of the component:
a title
a description (optional)
the time interval of the date involved
the number of decimal places of the displayed values
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
Metrics
Once the general information is entered, you can select the metrics to be used, by clicking on the Search metric button.
The usual io-base metric search window. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metric, click on the button to add it. The metrics appear in the table on the right.
You can delete the metric from the right table by using the delete icon.
Note : for a metric component, it is only possible to add a single metric.
To validate the selection, click on Save.
A preview of the table is displayed on the right.
You can set several details on the table :
the type of aggregation used
the color used
You can also replace the selected metric using the ‘Replace’ button in the Actions column :
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creation of a stacked chart component
Configuration
To create a component, you must start by entering the general information of the component :
a title
a description (optional)
the period of the relevant data :
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
the type of stacked chart : stacked bars or stacked areas
the aggregation to apply to the graphics and the reference duration :
For example, if we want to get the average of the values every hour, we select the aggregation 'AVG' and indicate 1h as the duration :
Metric
Once the general information is entered, you can select the metrics to use by clicking on the 'Add a metric' button.
The usual io-base metric search window. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metric, click on the button to add it. The metrics appear in the table on the right.
You can delete the metric from the right table by using the delete icon.
Note : for a stacked chart component, it is possible to add several metrics.
To confirm the selection, click on Save.
A preview of the component will appear on the right.
You can configure the color used for displaying the graphs :
Each curve can be duplicated. To do so, in the Actions column, click on the button outlined below :
You can also enter minimum and maximum visibility values for your graphic, as well as the interval to apply for the graduations. With each change, the graphic updates on the right side to visualize the changes.
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creation of a pie chart component
Configuration
To create a pie chart component, you must start by entering the general information of the component:
a title
a description (optional)
the period of the relevant data
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
the aggregation to apply to the values :
For example, if we want to get the average of the values of a metric, we select the aggregation 'AVG' :
Metric
Once the general information is entered, you can select the metrics to use by clicking on the 'Search metric' button.
The usual io-base metric search window. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metric, click on the button to add it. The metrics appear in the table on the right.
You can delete the metric from the right table by using the delete icon.
Note : for a pie chart component, it is possible to add several metrics.
To confirm the selection, click on Save.
A preview of the component will appear on the right.
You can configure the color used for displaying the pie charts :
Each metric can be duplicated. To do so, in the Actions column, click on the boxed button below :
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creation of an X/Y chart component
Configuration
To create an X/Y graphic component, you must start by entering the general information of the component:
a title
a description (optional)
the period of the relevant data
Note : the Lock box allows you to force the application of the selected period for this component, in case a period is chosen for the whole dashboard.
data filter :
scatter plot
latest value
Metric
Once the general information is entered, you can select the metrics to use by clicking on the 'Search metric' button.
The usual io-base metric search window. Several tabs allow a search either from the tree structure, or by meta-data, or by metric name. When you have found the right metric, click on the button to add it. The metrics appear in the table on the right.
You can delete the metric from the right table by using the delete icon.
Note : for a XY chart component, you have to add two metrics.
To confirm the selection, click on Save.
A preview of the component will appear on the right.
You can configure several elements in the graphic :
the size of the displayed points :
For example, if we specify size 5, the points of the component will look be :
And with size 10 :
Then, for each metric, you can also enter minimum and maximum visibility values for your graphic, as well as the interval to apply for the graduations. With each change, the graphic updates on the right side to visualize the changes.
You can reverse the metrics on the y-axis / x-axis in the graphic; to do this, click on the button outlined below :
Abacus
This feature allows you to represent a specific process through a mathematical line or curve on your chart. By using a variable that represents the x-axis values, you can model relationships and easily visualize trends unique to your processes.
To add an abacus, click on "New abacus."
Various configuration fields will appear.
Start by entering the equation for the line you wish to display on the chart.
To construct your equation, you must use a variable.
Syntax : to indicate the variable representing the x-axis values, enter "x".
For example, the equation can be 2+(x^2).
Provide a label for your variable :
Next, click on the icon representing your line to configure it :
You can then set up :
The line style : line or dotted
The minimum and maximum values that your variable "x" should take (x-axis values). For example, if you enter min = 0 and max = 10, the curve for 2*x will be plotted for the interval x [0;10].
The curve thickness : allows you to define the line's thickness on the chart.
The curve color :
The area style : you can choose whether to display the area under the curve, either upwards or downwards.
Once these parameters are set, the equation’s curve will appear :
Once all the settings are complete, you can click on Save to save and make your component appear in the dashboard.
Creating a Text Component
You can create a "text" component to add text or links to your dashboard.
Structuring Your Text
Apply a heading Style
Choose from three text styles :
Heading 1 : Main title
Heading 2 : Subtitle
Normal : Regular text
Select the text you want to style and choose the appropriate option from the toolbar.
The text will automatically update based on the selected style.
Creating Lists
You can create two types of lists using the toolbar :
Numbered list :
Bulleted list :
Text Formatting
You have several options for formatting your text :
bold text :
italic :
Underline :
Strikethrough :
change the text color :
Add a link
To add a link, follow the procedure below.
Select the part of the text where you want the link to appear.
Click the link button in the toolbar.
Enter the URL in the input field and click "Save".
Your link is created :
Preview Your Component
A preview of your component will appear on the right.
Once you are satisfied with the result, click "Save" in the top-right corner to add it to your dashboard.
Removing Formatting
To remove formatting, click the clear formatting button in the toolbar.
The text will return to the default style.
Creation of an Integral Component
The "Integral" component allows you to calculate and visualize the cumulative values of a metric, such as consumption or flow, over a given period.
To illustrate how it works, let’s take the example of real-time electrical consumption. We want to calculate the daily electrical consumption and then convert it into euros to determine the cost.
General Information
Start by providing the necessary general information to configure the component:
Title : Give a title to your component.
Description (optional) : Add details to clarify the context of the component.
Data Period : Define the period over which the cumulative total will be calculated.
Note : The "Lock" checkbox ensures that the selected period applies only to this component, even if a different period is defined for the entire dashboard.
Choice of Display Mode
Determine how the cumulative data will be displayed:
A single value representing the cumulative total for the selected period.
A histogram to visualize the cumulative evolution over the selected period.
To do this, move the slider to select either "Value" or "Histogram":
Choice of Metric
You can now select the metric to be used by clicking on the "Search for a Metric" button.
The usual metric search window of io-base will open.
Several tabs allow you to search by hierarchy, metadata, or metric name. Once the desired metric is found, click the button to add it. The selected metrics will appear in the table on the right.
You can remove metrics from the right-hand table using the delete icon.
Note : For an integral component, only one metric can be added.
To confirm your selection, click "Select".
A preview of the graph will appear on the right.
To confirm your selection, click "Select".
A preview of the component will appear on the right.
Integration time unit
Next, you need to define the time unit for integration.
This parameter sets the interval over which the data will be aggregated or integrated to produce a cumulative measure. It is essential because it determines how raw data is grouped and used to calculate totals or volumes over a specific period.
For example, if you enter “1h”, the integration will calculate the cumulative total for hourly intervals. This means each cumulative value is based on data collected over the course of an hour.
Add a Coefficient
A coefficient can be applied to the result to obtain an adjusted cumulative total based on your needs.
Using our example : If you want to convert the consumption into euros, you can apply a coefficient corresponding to the unit price of electricity per kWh (e.g., 0.15 €/kWh).
You can specify the coefficient in two ways:
Fixed value: For example, a constant price of 0.15 €/kWh.
Metric: A conversion metric can be used if the price changes over time.
Note : The selected multiplier value will be the average of the values returned by the metric during the selected period.
Modify the Unit
You can modify the unit displayed on the graph.
In our example, we want to express the data in euros.
To do this, simply go to the "Unit" field and enter your desired unit.
Once all the fields are configured, click on "Save":
Your component will appear in the dashboard :
You can modify the selected period to update your component :
Note : Here’s how the display looks in histogram form :