The BlackBerry® Threshold Analysis Tool configuration file contains parameters and values that specify how the BlackBerry Threshold Analysis Tool creates thresholds. You can save the configuration file on the computer that hosts the BlackBerry Monitoring Service, in the folder where the thresholdtool.exe file is located. By default, the location of the thresholdtool.exe file is <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server\Monitoring Service\tools. The configuration file must be a .txt file, and use ANSI® or UTF-8 encoding. To add comments to the configuration file, precede each comment with a number sign (#). You can type comments after the parameter and value on the same line, or on a new line.
In the configuration file, the term data points refers to the amount of historical data that the BlackBerry Threshold Analysis Tool
Monitoring Guide Configuring the BlackBerry Threshold Analysis Tool
Sample: Configuration file with default values new proposed rules active = false
previous proposed rules deleted = auto
number of days to keep historical proposed rules = 30 critical trigger = 0.0% #the percentage symbol is optional error trigger = 0.0%
warning trigger = 0.8%
number of days in data point window = 30
minimum number of data points required to generate rule = 1000 maximum number of data points used to generate rule = 10000 Parameters
Parameter Permitted values Description
new proposed rules active • true
• false
This parameter specifies whether the tool activates the rules it creates. To activate the rules, specify true. The tool adds
"Proposed rule" to the notes section for the rule in the BlackBerry Monitoring Service console.
If you change the value of this parameter to false after you run the tool with the parameter specified as true, new rules are active and rules that the tool created previously are inactive.
The default value is false.
This parameter specifies whether the tool deletes all of the rules that it created prior to when you run the tool. If the value is auto, the tool deletes rules it created on the day that you run the tool. If the value is true, the tool deletes all of the rules that it created prior to when you run the tool. If the value is false, the tool deactivates but does not delete rules that it created prior to when you run the tool, and the tool adds
"Historical" to the notes section for the rule in the BlackBerry Monitoring Service console for each rule that it created prior to when you run the tool.
The default value is auto.
number of days to maintain historical proposed rules
0 to 30 This parameter specifies the number of days that the tool saves rules that it created.
The default value is 30.
Monitoring Guide Configuring the BlackBerry Threshold Analysis Tool
Parameter Permitted values Description
critical trigger 0.0% to 5.0% This parameter specifies the percentage of data attribute activity that the tool uses to determine whether the activity level of a data attribute is abnormally low or abnormally high.
This tool uses the values of the highest and lowest activity levels of a data attribute to create two rules with alarm severities of critical.
For example, if you configure 0.1% as the value for the critical trigger parameter, the tool uses the lowest and highest values that total 0.1% of the total activity of the data attribute.
The default value is 0.0%.
error trigger 0.0% to 5.0% This parameter specifies the percentage of data attribute activity that the tool uses to determine whether the activity level of a data attribute is abnormally low or abnormally high.
This tool uses the values of the highest and lowest activity levels of a data attribute to create two rules with alarm severities of error.
For example, if you configure 0.3% as the value for the error trigger parameter, the tool uses the lowest and highest values that total 0.3% of the total activity of the data attribute.
The default value is 0.0%.
warning trigger 0.0% to 5.0% This parameter specifies the percentage of data attribute activity that the tool uses to determine whether the activity level of a data attribute is abnormally low or abnormally high.
This tool uses the values of the highest and lowest activity levels of a data attribute to create two rules with alarm severities of warning.
For example, if you configure 0.8% as the value for the warning
Monitoring Guide Configuring the BlackBerry Threshold Analysis Tool
Parameter Permitted values Description
If you specify the critical trigger or error trigger parameter, the default value is 0.8%. If you specify the critical trigger or error trigger parameter, the default value is 0.0%.
number of days in data point window
1 to no limit This parameter specifies the number of most recent days that the tool uses historical data from to create thresholds.
The default value is 30.
minimum number of data points required to generate rule
0 to 50,000 This parameter specifies the minimum amount of historical data that the tool uses to create thresholds.
The default value is 1000.
maximum number of data points used to generate rule
1000 to 50,000 This parameter specifies the maximum amount of historical data that the tool uses to create thresholds.
The default value is 10,000.