Adding A New Test Type

Each test configured in Traverse is assigned a type and sub-type. The test type and sub-type combination serves as the key for global default information that is read from various configuration files. If Traverse is unable to locate the configuration information for a particular test type and sub-type, it is ignored and an error message logged. Such configuration information is loaded from $TRAVERSE_HOME/etc/TestTypes.xml and other plugin configuration files, which are described in the sections that follow.

When creating new (plugin) monitors, you will need to create a unique test type and sub-type for that monitor and provide various default values and other parameters. The entries in $TRAVERSE_HOME/etc/TestTypes.xml or other directories should not be edited (unless you are instructed to edit them by Kaseya Support as it may adversely affect or cause failure of Traverse components. Any changes made to these directories may also be lost when a new version of Traverse is installed. All user customizations are expected to placed in $TRAVERSE_HOME/plugin and its subdirectories.

Sample [TestTypes].xml Entry

<testtype>

		<displayName>Current Temperature</displayName>

		<displayCategory>application</displayCategory>

		<subType>temperature</subType>

		<units>degrees C</units>

		<severityAscendsWithValue>true</severityAscendsWithValue>

		<defaultWarningThreshold>100</defaultWarningThreshold>

		<defaultCriticalThreshold>120</defaultCriticalThreshold>

		<shadowWarningThreshold>100</shadowWarningThreshold>

		<shadowCriticalThreshold>120</shadowCriticalThreshold>

		<slaThreshold>120</slaThreshold>

		<testInterval>180</testInterval>

		<showAsGroup>true</showAsGroup>

		<testField>

			<fieldName>city</fieldName>

			<fieldDisplayName>City</fieldDisplayName>

			<isRequired>true</isRequired>

			<isPassword>false</isPassword>

			<defaultValue>Muskogee</defaultValue>

		</testField>

		<testField>

			<fieldName>state</fieldName>

			<fieldDisplayName>State/Province</fieldDisplayName>

			<isRequired>true</isRequired>

			<isPassword>false</isPassword>

			<defaultValue>OK</defaultValue>

		</testField>

		<testField>

			<fieldName>country</fieldName>

			<fieldDisplayName>Country</fieldDisplayName>

			<isRequired>true</isRequired>

			<isPassword>false</isPassword>

			<defaultValue>US</defaultValue>

		</testField>

</testtype>

The testtype element includes the following child elements:

XML Testtype Child Elements

Child Element	Description
displayName	A user-friendly name that is used when creating a report or referring to a specific testtype
displayCategory	This setting defines the column that the test result should be in on the summary pages in the Web application. Valid values are network, system, and application.
subType	This is a string that uniquely identifies the testtype to the Traverse software. You can choose whatever string you want, with some restrictions. The subtype must be unique to the monitor that the test is running on, and can only contain alphanumeric characters.
units	The units for the test measurement. This will be used in reports and event and summary displays. If the particular test does not have a suitable unit, use a space as the unit.
severityAscendsWithValue	This is used to indicate a severity direction for test values, and has the following possible values: true false or static If the value is true, then the status being tested becomes more critical as the test value rises. When the value is static, you can set discrete threshold values for warning and critical.
defaultWarningThreshold	This is the default end user warning threshold for this test type. If the severityAscendsWithValue is `static', then you can specify a comma separated set of numbers using the following syntax:1,3,5,8-20
defaultCriticalThreshold	This is the default end user critical threshold for this test type.
showAsGroup	Group tests of the same sub-type together in the Web application during autoDiscovery of SNMP tests for a device.
shadowWarningThreshold	The default admin warning threshold for this test type. Typically this value will be same as defaultWarningThreshold.
shadowCriticalThreshold	The default admin critical threshold for this test type. Typically this value will be same as defaultCriticalThreshold.
slaThreshold	The default SLA threshold for this test type.
testInterval	The default interval, in seconds, for running this test.
testField	This element defines a specific attribute for the test. A testtype can have 0 or more test fields. Each testfield should have the following child elements:fieldName - This will be used as key for the field value when it's passed to the test.fieldDisplayName - A user friendly name for the field that will be used by the Web application when creating or updating tests.isRequired - This element indicates whether or not the a value is required to be given for the field when creating or updating the test.isPassword - This indicates whether or not the field is a password field. The Web application will ask for verification of password fields when creating or updating a test.defaultValue - A default value that will be presented to a user when creating the test.

Post Processing for Plugin Monitors

Unlike built-in monitors, post-processing directives are not allowed for plugin monitors. The monitors are supposed to do all the processing and return the final result.