KM directives

For the PATROL 7.x Console Server and BMC ProactiveNet Performance Management 9.5, several directives should be added to the KM file. These directives appear as comments at the top of the KM file. The following table describes the KM directives:

KM Directives

Directive

Description

Release

Identifies the version and release of the KM. Three levels are supported, v.r.m. The productcode value and the release value are concatenated to form the product-specific install directory on the console server for the KM.

Revision

String that identifies the revision of the KM. This value is not currently used by the console server.

Package

String that identifies what KM package this KM belongs to.

Description

String that describes the KM This value is not currently used by the console server.

Productcode

String that represents the BMC product code, which must be of atleast three characters. The productcode value and the release value are concatenated to form the product-specific install directory on the console server for the KM.

Notes

  • Recommendations for specifying the product code:
    • The product code must have atleast three characters. When adding products code that are more than three characters, you can use its initial characters to indicate the company name and remaining characters to indicate the solution name. For example, senmss is a product code for the Sentry Software Microsoft Search KM, where 'sen' indicates a company name and 'mss' indicates a solution name.
    • The product code must not contain any special characters 
    • The product code must not begin with 'p'. This is reserved for BMC solutions.
  • The package and productcode directives must have the same value.
  • The release value only supports xx.yy.zz format. (v.r.m.), xx indicates the major release, yy indicates the minor release, and zz indicates the service pack level. When releasing a KM with changes to the Console Server or PATROL Central - Web Edition Web server resources, update the value incrementally.
  • BMC ProactiveNet Performance Management 9.5 uses the release and revision version for maintaining the latest version of KM XMLs.

Example for KM directives

The following example shows the syntax of the directives that are added to all your KM files:

!release v.r.m
!revision 00
!package PRD
!description PATROL PRD Knowledge Module
!productcode PRD

The productcode value and the release value are concatenated to form the product specific install directory on the console server for the KM. This example requires the following directory structure on the console server:

./lib/knowledge/PRD_v_r_m/

All of the *.km files in your product must add these directives.

Note

  • Do not add these directives to your *.kml files because the PATROL Consoles will not load a .kml file with these directives.
  • You must use the PATROL 3.5 Developer Console when you are working with KMs that contain these directives because older PATROL Developer Consoles will remove these lines when the KM is committed to the agent.

 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*