Prerequisites: it is necessary to have the role of Functional Administrator to access this functionality.
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/Storage rules menu.
The list of existing storage rules appears.
Click on the "Add a rule" button.
The window for entering the rule properties is displayed. It contains the following fields :
Name (to identify the rule)
Deadband
Validity period (s)
Decimal digits
To confirm the creation, you must at least have entered a name and a validity period. Once it is done, click on Add.
To apply a storage rule to a metric, go to the Referentials/Metrics management menu.
Instruction and validity period of the deadband
By default, the data sent to the Indaba API is written directly in the database. In order to lighten the database and improve performance, it is advisable to define a deadband.
When a new value is sent to the database, it is saved even if it is equal to the previous value. Defining a deadband allows to give a delta, below which the new value will not be saved if it does not differ enough from the previous one.
For example :
Deadband = 0.5
Last value in the base = 3.5
New value = 3.8
The delta between 3.8 and 3.5 < the deadband, so the new value is not recorded.
Note : To disable the deadband filter, enter '0'.
Value stored in the database :
Value not stored in the database :
The validity period is the number of seconds during which a value is not written back to the base, if it has not changed. In the case where a deadband is entered, the value is considered not to have changed if the delta with the old value is less than the deadband value.
Note : To disable the deadband validity period, enter '0'.
If the new value is inside the rectangle drawn above, it will not be stored in the database.
If it is outside the rectangle, it is stored in the database and becomes the new current value of the corresponding metric.
User Assistance
To guide you in creating or modifying a storage rule, a message will indicate the filtering that will be applied to your data.
If 'deadband' > 0 and 'validity period' > 0
The data will be saved if the difference between two consecutive values is greater than X (deadband value) or if more than Y seconds (validity period) have elapsed since the last write.
Example :
If 'deadband' = 0 and 'validity period' > 0
The data will be saved if more than Y seconds (validity period) have elapsed since the last write.
Example :
If 'deadband' > 0 and 'validity period' = 0 :
The data will be recorded if the difference between two consecutive values is greater than X (deadband value).
Example :
If 'deadband' = 0 and 'validity period' = 0 :
Data filtering disabled.
Example :
Number of decimal places
The number of decimal places of the stored data will be deducted from the value entered for the deadband. For example, if this value is 0.02, then the values of the affected metrics will be stored with a precision of 3 decimal places.
When the deadband is disabled (deadband = 0), the 'decimal places' field becomes active :
Then specify the number of decimal places you want :
Note : If you enter '0', only integer numbers will be saved.
Note : You can enter up to 6 decimal places.
Default values
If no storage rule is defined, the default values are as follows :
deadband : 0.1
decimal digits : 0.01
validity period : 10 minutes
If you wish to modify this default storage rule, contact the Io-base support.
You can view your default storage rule by clicking the button
in the Actions column :