Templates Dialogue

Templates Dialogue

The Templates dialogue allows you to manage application templates defined in the system configuration:

  • import a template from an XML file;
  • export a template to an XML file;
  • edit, rename and copy a template;
  • configure a template monitors list;
  • set how a template is applied during discovery;
  • delete a template;
  • upgrade a template applications to the latest version

You can find a detailed description of the templates framework here.

Templates Dialogue

Templates list

The left pane lists all the application templates defined in the system configuration along with their short descriptions. The system and user-defined templates are marked by different colors.

All the standard templates are divided into categories by their target applications, services or resources. You can add your custom template into any category.

Templates list

The right pane shows the application template parameters:

  • Name, short description and version:

    Templates

    The template name must be unique within the monitoring system.

  • Template Monitors section allows to enable or disable the monitors. The disabled monitors are not created if the template is applied to a host manually (via New Monitor Wizard). You can configure how to process disabled monitors during discovery in the Discovery Settings section. By default, only few monitors are enabled for each standard (predefined) template. You can review the predefined templates in this dialogue and configure them at any time.

    Templates Monitors section

    • Find field allows to filter the monitors list by a keyword.
    • Enable all checkbox allows to enable/disable the entire list.
    • Create or reuse PING monitor on the host checkbox allows to create an additional PING monitor on the host (if there is no one) or reuse the existing PING, and set the application monitors dependency to this PING monitor.

    Note that not all the parameters of a predefined template can be configured. In the sample above the parameter Create or reuse PING monitor on the host can not be configured. All the parameters of a user-defined template can be configured at any time.

  • Discovery Settings section allows to configure how the discovery process should find and apply the template.

    Discovery Settings section

    • Template can be used in network discovery checkbox allows to set if the template will be used in the automatic network discovery.
    • Match monitor drop-down list allows to select the specific monitor that the discovery process uses to determine if this template should be applied to the host. By default, the discovery process tries to create the match monitor on the host, and if the monitor switches to OK state, the discovery process applies the template to the host. This parameter can’t be configured for the standard (predefined) templates.
    • Discover application when: radiobutton area allows to specify when the template should be applied to the host during discovery.
    • Mutually exclusive group checkbox/drop-down list allows you to select (or define) a template group that limits the discovery process: if one template from the group is already discovered on a host, then all other templates from this group will be skipped.
    • Create monitors not detected by discovery checkbox/radiobutton area specifies what to do with the template monitors that are not discovered.

Dialogue toolbar

Templates Dialogue toolbar

The dialogue toolbar provides the following functions:

  • Import template button allows to add a template defined in an XML document to the system configuration. By default, the Open File dialogue opens in the ‘%ProgramData%\IPHost Network Monitor\templates\’ directory if you click this button:

    Open file

    You will receive an error message if the XML document is invalid:

    XML error

    A correct template is added to the system configuration and can be modified and applied. Note that all the user-defined template parameters are available for configuration.

    Template added

    You can create a template with a name that matches the name of a standard template. In this case your template will be marked by a ‘(custom)’ keyword in the templates list:

    Template (custom)

  • Export Template button allows to save an existing template to an XML document. The ‘%ProgramData%\IPHost Network Monitor\templates\’ directory is used to save an XML file by default.
  • Edit XML allows you to edit a user-defined template in a simple text editor. Note that you can’t edit a standard (predefined) template.

    Template editor

    For example, you can create a new templates category by editing the <Category> value in the template XML file before importing the template into the system configuration. The new category will be added into the templates list and you will be able to add templates in the category.

  • Rename button allows you to rename a user-defined template.
  • Copy button allows you to copy any template:

    Copy template

    You should specify a unique name and can modify the new template description.

  • Delete button allows you to delete a used-defined template. Note that you can’t delete a template that is applied to a host, and you can’t delete a standard template. In order to completely remove a user-defined template that is applied to a host you need to remove an application (with all its monitors) first. Close the dialogue, switch to the Tree view, select the application in the tree and click Delete button on the program toolbar. You can delete the template only after all the applications created from the template have been removed.
  • Upgrade Applications link allows to upgrade all the legacy applications to the latest version.

    upgradeButton

    After the “Upgrade Applications” link is clicked a menu with 3 items opens:

    • upgrade the chosen template application
    • upgrade all the applications based on the templates in the selected group
    • upgrade all the applications

    After the action is selected a dialog window appears, it allows to select the applications to upgrade.

    UpgradeDialog

    You can select which applications you want to upgrade.

    You can learn more about procedure of application upgrading here: Upgrade Application.

Template versions

You can’t create two templates with the same name and version number. However, if you need to update an existing user-defined template, for example, to add new monitors to it, you can modify the original template XML file (add new monitors) and increase the template version number: ‘<Version>2</Version>’. After that you can import the template from this modified XML file and get the template with two versions:

Template version

Only the latest version of the template is used in the discovery process and can be applied to a host manually. However, if an application has been created from the older version, it remains as is. The monitoring service removes old unused templates from the system automatically.