Creating an application class

Creating an application class involves defining how the resource is detected and monitored by PATROL. You add a new application class by using the PATROL Developer Console.

Application class property dialog boxes

When you create a new application class, the properties are defined using the application class dialog boxes in both Windows and UNIX. The following figure shows both the Windows and UNIX application class dialog boxes and the relationship between the Windows dialog box tabs and the sections of the UNIX dialog box. 

 Application class dialog boxes, Windows and UNIX 
 

Even though PATROL Console platforms have different interfaces, the properties are the same for both platforms. The application class properties are discussed in the following logical groups that correspond to the tabs of the Windows application class dialog box.

  • General
  • Help
  • Icons
  • Security
  • Pre-Discovery
  • Discovery

The tasks in the following sections show you how to add an application class to the PATROL environment using the PATROL Developer Console for Windows and UNIX. 

Application class general properties

The following table describes the general properties of an application class.

Application class general properties

Property

Required/Optional

Default

Definition

Active

Optional

Yes

This check box sets whether or not the application class is active on PATROL KM loading. If the application class is active, the PATROL Agent immediately begins application discovery when the PATROL KM is loaded.

Agent Version

Optional

No

Controls the PATROL Agent version or versions that can load this application class. You can specify one version number or a range of numbers:

  • 3.1.9 For version 3.1.9 only
  • 3.0.15-3.1.9 For versions >= 3.0.15 and <= 3.1.9
  • 3.0.15- For versions >= 3.0.15
  • -3.1.9 For versions <= 3.1.9

The Agent version field has precedence over the Allow On and Deny To fields. Therefore, if the PATROL Agent version does not match, the values of the Allow on and Deny To field are irrelevant.|

Allow On

Optional However, this must be addressed here or somewhere else in the KM code for certification.

(blank)

Controls the computer classes that can load this application class. Separate multiple entries with a comma. To specify all computer classes, type all. The Allow On field has precedence over the Deny To field. For example, if the Deny To field contains all and the Allow On field contains HP, then the application is valid for HP only. If the Allow On and Deny To fields are both empty, the PATROL KM will not load unless the Miscellaneous Preference item "Register interest in KMs that have no platform/version information" is selected. Miscellaneous Preferences appear under the Options menu of the main PATROL Console window.

Create Icon for Class

Optional

No

Sets whether PATROL automatically creates a container icon to hold all application instances of this class. This option controls whether application instances appear in the main PATROL Console window or in a container icon for the application class.

Custom Discovery Cycle

Optional

No

Sets whether a custom discovery cycle is to be used rather than the default cycle of 40 seconds. Use the associated spin boxes to set the timing of the cycle.

Deny To

Optional

(none)

Controls the computer classes that cannot load this application class. Separate multiple entries with a comma. To specify all computer classes, type all. The Allow On field has precedence over the Deny To field. For example, if the Deny To field contains all and the Allow On field contains HP, then the application is valid for HP only.For detailed information, refer to the PATROL Console for Windows Help.

Discovery (Windows) or Discovery Rules (UNIX)

Required

PSL

The type of discovery to be used by the PATROL Agent to discover application instances. It can be either PSL or Simple. PSL discovery is the discovery type used by most PATROL KMs. As this is a very complex topic, see Setting up application discovery for information on how to set up discovery.

History Level

Optional

Inherited

Sets whether the length of time historical data about the class is collected and stored is inherited from computer-level or set at the class level (Local). Because storage resources vary from machine-to-machine, history should be inherited to allow the end-user to easily control the historical data retention period.

Number of History Days

Conditional

0

If Local History Level is selected, the Number of History Days spin box sets the number of days of class historical data that is retained in the History Log.

Propagate State

Optional

Yes

Sets whether a warning or alarm state is propagated up-level to the computer instance on which the application class resides. Only the most critical applications should be set to propagate warning and alarm states up to the computer instance.

Run Global Parameters by Default

Optional

Yes

Sets whether the PATROL Agent is to automatically run all parameters defined for this class on all application instances. If this option is not selected, parameters will be created in a suspended state. This option should always be selected in production KMs.

Creating an application class on Windows

In this task, you will add a new application class to your PATROL environment and set the General tab properties of the new application class.

To create a new application class

  1. In the KM tab of the PATROL Tree View, right-click Application Classes to access the shortcut menu.
  2. Choose New from the shortcut menu.
    Th e New Application Class dialog box appears for you to name the new application class.
    See Application class names for guidelines for naming application classes.
  3. Type in the application class name and click OK.
  4. The KM file for the new application class will have the same name as the application class. For example, if you specified EXAMPLEKM in the New Application Class dialog box, the KM file is named EXAMPLEKM.km.
    The Application Properties dialog box for the new application appears with the General tab properties displayed as shown in the following figure.

To set the application class general properties

  1. Specify the application class properties that appear on the General tab.
    Application Properties box, General tab

  2. Click Applyto save the properties and the PATROL KM.

    Note

    The KM is not saved to the disk. The KM is stored in memory until you save the KM.

  3. Choose File>Save KM from the main menu bar to save the KM to a file.

Creating an application class on UNIX

In this task, you will add a new application class to your PATROL environment.

To create a new application class

  1. Choose Attributes > Application Classes from the main menu bar. The List Of Application Classes window appears as shown in the following figure. 

    List of Application Classes window 


    This window lists the application classes that are already defined in the PATROL environment. Their definitions have been loaded from an existing PATROL KM or have been created during the current user session.
  2. Choose Edit > Add from the List of Application Classes menu bar. The Application Class Name dialog box appears as shown in the following figure. 

    Application Class Name dialog box 

  3. Type in the application class name and click OK.
    See Application class names for guidelines for naming application classes.
    If the named application class already exists, a dialog box appears prompting you to either modify the existing definition or cancel the Add operation. Otherwise, the Application Definition dialog box shown in the following figure displays. Actions to perform to add an application class maps each dialog box section to the appropriate task associated with creating an application class.

To   set the application class general properties

  1. On the application definition dialog box, specify the general properties for the application class as shown in the following figure. Application class general properties defines the application class general properties. 

    Application Definition dialog box, General properties
  2. Click Apply to save the properties and the PATROL KM. The KM is not saved to the disk. The KM is stored in memory until you save the KM.
  3. Select File Save KM from the main menu bar to Save the KM to a file.

KM output-application class

When a new application class is created, a new KM file is created with the same name as the application class. As you make modifications and additions to the KM, the changes are reflected in the KM file. 
The following figure shows the output created by the PATROL Developer Console when you create a new application class. 

 KM output-application class definition 

 

The text of the KM file is not displayed through the PATROL Developer Console. However, you can view the KM file using an ASCII editor such as Microsoft WordPad.

Note

You should not make changes to the PATROL KM, other than adding comments to the header, outside of the PATROL Developer Console. Manually editing the PATROL KM file could generate unpredictable results.

What to do next

To set up the application class general properties like adding online help for the application class, see Adding an application class help and to add icons to represent the application class and its states, see Adding an application class icon.

Was this page helpful? Yes No Submitting... Thank you

Comments