Prerequisite : This feature is available for users with a Functional Administrator role.
Log in to Io-base and click the button at the top right of your screen, highlighted below :
The Io-base administration page opens.
Go to the Referentials/Functional trees menu.
The functional trees management screen is displayed.
Select the desired functional tree, then go to the Types tab.
A dropdown list is available for you to select the type of your choice.
Select the type for which you want to create a metric template.
In our example, we select the "Equipment" type.
Next, click on the "Add a Metric template" button.
The following window opens :
You have several fields to fill in :
Template naming parameters
Generic Name : this is the name of the metric model, in our case, we choose to name it "documentation"
Metadata Type : select "Metric"
Display Options : metric display setting in the hierarchy, you can choose to display metrics using their name, their description, or the generic name of the template
Expression of the Metric template
This part will allow you to associate the metric template with the Indaba metrics stored in the database.
Start by indicating the database where the Indaba metrics you want to generate with the template are contained.
Then, define the desired metric template.
To define a metric template, you must use the naming characteristics of your Indaba metrics.
In our example, here are the metrics measuring electricity consumption of equipment in Indaba :
All these metrics have the prefix "cip_int_", so start the expression of your metric template with: cip_int_
Then, use the properties of your functional tree to complete your model.
In our case, we created a “CodeCip” property, which is associated to the “Equipment” type.
In our functional tree, we entered a value for the "codecip" property for all the “Equipment” type items.
You can then complete the expression of your metric template by adding the "Codecip" property as a parameter.
To add a property in the expression, you must respect the following syntax: {property name}
In our example : cip_int_{codecip}
Note : to help you in entering your metric model, an input wizard is available.
Click on "Input wizard".
All the properties of the elements contained in the functional tree are at your disposal.
For instance, if you click on "codecip", it appears in the input field.
Once your metric template is completed, click on "Save metric template".
Your metric template is now created :