PATROL KM packaging overview
Packaging of a PATROL KM is an important issue for distributing your KM product to your customers. This section discusses considerations for building a PATROL KM distribution package that enables your PATROL KM to install easily.
PATROL KM file naming conventions
BMC Software recommends that you use a consistent naming scheme for all PATROL KM files and PATROL KM objects. This avoids problems with duplicate filenames, promotes maintainability, and clearly identifies and associates your PATROL KM components.
PATROL does not have separate directories for different PATROL KMs and their supporting files. Therefore, it is extremely important that each PATROL KM filename is unique and can be associated with the appropriate PATROL KM.
A KM filename is formed by adding a three-character KM prefix to the root name and separating the two parts with an underscore () symbol. The file extension indicates the file type. A KM filename has the following format:
_KMprefix_BaseName.filetype
- KMprefix identifies the PATROL KM to which the file belongs; it is a three-character (all upper case) code to designate a specific registered KM.
Since PATROL stores all KMs in the same directory, it is very important that KMs and their associated files have a unique identifier. - BaseName is made up of concatenated word(s) that describe the file and can differ in capitalization depending on the type of PATROL file. See the following table for more information.
- filetype is a 1 to 3-character file extension that indicates the type of file.
For example, a file that contains the PSL code for a parameter named PacketErrs in the PATROL KM named NETWORK (NET) would be named NET_PacketErrs.psl.
Rules for capitalizing PATROL file base names
The following rules describe how to capitalize the base names of various PATROL file types:
Rules for capitalizing PATROL file base names
PATROL KM product file components
You should package the following files with your PATROL KM:
File components for packaging your PATROL KM
Type of file | File extension | Required |
|---|---|---|
Application class file | .km | Yes |
PATROL KM file list | .kml | Yes (PATROL 3.2 and later) |
KM User-defined Event catalog files | .ctg | Yes (if they are required by the KM) |
Icons | Windows | Yes (if they are required by the KM) |
UNIX | ||
Help files | Windows | Yes |
UNIX | ||
PSL scripts and libraries not saved as part of the PATROL KM files. | .psl | Yes (if they are required by the KM) |
PATROL KM packaging considerations
Before you begin packaging your PATROL KM for distribution as a product, review the following considerations listed in the following table.
PATROL KM packaging issues
PATROL KM packaging
Packaging a PATROL KM for use consists of placing all files that make up your PATROL KM into one or more compressed files that can be uncompressed and distributed to the correct directories in the users PATROL environment. Typically, the files that make up a PATROL KM are divided into agent and console resources, and two compressed files are created for the KM installation. One file is installed on agent machines, and one file is installed on console machines. Using two files conserves system resources by eliminating the distribution of unnecessary files on both the agent and console machines.
PATROL Agent resource files
The PATROL Agent side of a PATROL KM includes files and directories required for the managed PATROL Agent system and should contain files for these items:
- PSL files
- PSL libraries or binaries
- KM files
- PATROL Agent-side components
PATROL Console resource files
The PATROL Console side of a PATROL KM includes the PATROL Agent side components plus user interface elements and should contain files for the following items:
- PSL files
- PSL libraries or binaries
- KM files
- Icon and icon mask files
- Help files