Updating custom KMs

This section provides detailed steps to make your custom Knowledge Modules (KMs) compliant to BMC ProactiveNet Performance Management or TrueSight Infrastructure Management.

Before you begin

Ensure that you have upgraded your Classic Console to version 3.6.00.01 of BMC PATROL Console for Windows.

To update a custom KM

1. Update all KM files with release and revision number. For details, see KM-directives.
2. Update all the Knowledge Module List of files with meta data information. For details, see Creating a Knowledge Module List.
3. Load your custom KM in PATROL Developer Console.
4. For all applicable Application Classes:
   1. Click the KM tab in the Developer Console.
   2. Expand Application Classes to view all the loaded application classes.
   3. Right-click on the application class name and click on Properties.
   4. Click the Metadata tab.

   5. Ensure you provide all the following details:

      Items	Description	Sample
      Display Name	The name of the instance as displayed on the BPPM Operations UI.	NT_OS application class is named Windows Operating System.
      Monitor Type	This defines the behavior of the application class.	MONITOR, CONTAINER, etc.
      Monitor Category	BMC ProactiveNet Performance Management or TrueSight Infrastructure Management uses the Monitor category specification for categorization.	System, Database, Application, etc.
      CDM Class Name	The name of the CDM class that corresponds to an application class.	BMC_FileSystem, BMC_ComputerSystem, etc.
      Config Variables	To pass all config parameter (namespace variable) values to BPPM.	osType, osVersion, etc.

      For additional details, refer Static and Dynamic Metadata.

   6. To enable Monitoring Policy configuration, add configuration metadata in the Input tab. For example, see Example-of-input-tab-details-for-an-Application-Class.

   7. When setting metadata using PSL set functions, check the PATROL Agent version.
      
      

      Note

      The metadata should be set only when working with PATROL Agent 9.5.

   8. Save the KM.
5. For all applicable Parameters:
   1. Click the KM tab in the Developer Console.
   2. Expand Application Classes to view all the loaded application classes.
   3. Expand an application class to view all Global and Local entries.
   4. Expand the Global > Parameters to view all parameters in the application class.
   5. Right-click on the parameter name and click on Properties.
   6. Click the Metadata tab.
   7. Select all the applicable metadata options. For details, refer Static metadata.
   8. Save the KM.
6. For all applicable Menu commands:
   1. Click the KM tab in the Developer Console.
   2. Expand Application Classes to view all the loaded application classes.
   3. Expand an application class to view all Global and Local entries.
   4. Expand the Global > Commands.

   5. Expand Menu Commands to view all menu commands for an application class.

      Note

      Menu command ID is the unique ID of the command in the context of the KM. ID is either auto-generated or you can manually provide it as an input. PATROL Console displays Menu command for an application class only if Menu ID is available for Menu commands. PATROL Console sends request with Menu ID to PATROL Agent as a function call. This function should be present in either of one library: <KMName>_<Auto Generated ID>.lib (auto-generated) or <KMName>_<Menu ID>.lib (manually generated). PATROL Agent executes the request to create a PSL command as requires <APPNAME>_menu; <menuid>();.

   6. Right-click on the menu command and click on Properties.

      Note

      Ensure that you take a back up of the Command text before generating an automated ID.

   7. In the General tab, perform the following to generate the ID:
      1. For auto-generated ID:
         1. Select the Generate Auto ID option and click Yes.
            The auto generated id is displayed in the ID field and a function with the same name is created in the Command text.
         2. Click the Command tab.
         3. Write the logic of the menu in the Command text.

         4. Click Apply.
            
            

            Note

            When you select the auto-generated ID option, a library file is created in the PATROL_CACHE\psl directory by PATROL Console.
            The naming convention used is "<KMName>_<Auto Generated ID>.lib". For example, NT_OS_MenuCmdFunc_8087042345.lib

         5.  If you want to have inputs taken from a user on the BPPM Operations Console, write the input metadata in the Input tab. For example, see Example-of-input-tab-details-for-a-Menu-command.
             Ensure that Annotate option is not checked for input to work.
      2. For manually generated ID:
         1. Select the Generate Auto ID option and click Yes. Now, deselect the the Generate Auto ID option to add Menu ID manually.
         2. Enter Menu ID. 

         3. Create a PSL library with naming convention as "<KMName>_<Menu ID>.lib" and export the PSL function with same name as Menu ID. 

            Note

            When you manually provide an ID, PATROL Console does not create a library and you must create a PSL library.

         4. Click the Command tab.
         5. Write the logic of the menu in the Command text to be executed by PATROL Console.
   8. Click Apply.
   9. From the BPPM server, if you want to execute a menu command automatically on the ALARM state:
      1. Select the Annotate option in the General tab. Ensure that no inputs are used for the menu command.
      2. Click Apply.
      3. The menu command will appear in the Event Rules list on the BPPM server.
      4. Associate this event rule to an event trigger. In this case the ALARM state trigger.
   10. Save the KM.
7. Create a bundle with the newly created <ApplicationClassName>.xml, menu command library files, and the XSD shipped with PATROL Console.