Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

PATROL KM installation


Installing a PATROL KM is a fairly simple process. All you need to do is distribute your KM related files to the proper directories in the PATROL environment. There are several ways to do this depending on the PATROL KM and the operating system. It is up to you to determine the best way to install your PATROL KM.

 Additional installation steps

Once your KM is installed into the PATROL environment, your customers will need to load the KM onto their consoles and agents (PATROL 3.3 and later).

Consoles and Agents

To load your KM onto their PATROL Consoles and Agents your customer will need to use the PATROL Developer Console as they would with any other PATROL KM.

PATROL KM product file destinations

Installation of a PATROL KM requires that all your KM related files are placed in the proper place in the PATROL environment. The following table lists the directories that your KM related files should be placed in during the install process of your PATROL KM: 

File destinations for your PATROL KM related files 

File description

Extension

Windows directory

UNIX directory

Application class PATROL KM list

.km 
.kml

%PATROL_HOME%\lib\knowledge

$PATROL_HOME/lib/knowledge

KM User-defined Event catalog

.ctg

%PATROL_HOME%\lib\knowledge

$PATROL_HOME/lib/knowledge

Icons

Windows 
.bmp 
.bmk

%PATROL_HOME%\lib\images

-

UNIX 
.xpm 
.msk

-

$PATROL_HOME/lib/images

Help files

Windows 
.hlp 
.cnt

%PATROL_HOME%\lib\help\WinHelp

-

UNIX 
.htm

-

$PATROL_HOME/lib/help

PSL scripts and libraries not saved as part of the PATROL KM files. 
This includes any required directories, PATROL Agent configuration files, 
external scripts, procedures.

.psl 
.bin 
.lib

%PATROL_HOME%\lib\psl

$PATROL_HOME/lib/psl

PATROL target script

On UNIX, PATROL provides a script that is used to determine the UNIX platform. Before installing the files for your PATROL KM, you can execute the PATROL target script to ensure that you are distributing the correct KM files on a UNIX platform. The target script allows you to develop and easily install platform dependent binaries and PSL scripts. 

The target script is executed with the following command on a UNIX system: 

target.sh

Target script return values

Target script return value depends upon the platform. For the platforms that are not supported by PATROL, the UNSUPPORTED string is returned. 
The appendix illustrates the typical PATROL directory structure for both Windows and UNIX. 

 

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