KM help files
The PATROL 3. x consoles continue to use the same Help architecture that they used in the past, WinHelp on Windows and NetHelp on UNIX.
The 7. x consoles use a new Help architecture. The PATROL Central-Windows Edition uses compiled html Help (.chm files), and the PATROL Central-Web Edition uses browser-hosted html Help (.jar files).
In PATROL 7. x, the Help files are installed using the ISO 639 language codes and ISO 3166 country codes for the LOCALE to support internationalization and localization. The LOCALE value is formed by concatenating the language code, an underscore, and the country code. For example english (EN) and the United States (USA) form the following LOACLE value: EN_USA
For PATROL Central-Windows Edition the LOCALE is used in the directory structure on the console server where the Help files are installed:
% PATROL_ROOT%\lib\knowledge* prd_1_2\lib\help* LOCALE** prd.chm
For PATROL Central-Web Edition the LOCALE is used in the name of the Help jar file:
KM help file locations
The KM Help is installed in different locations in the users environment. The location is dependent on the console that will use the Help. The following sections define the locations for each type of KM Help.
The PATROL 3.5 Console Help is installed on the console computer in the same location that it was in PATROL 3.4.
On Windows, the PATROL 3.5 Console Help is installed in the following directory:
On UNIX, the PATROL 3.5 Console Help is installed in the following directory:
PATROL Central help
In the first release of the PATROL 7.x components, Help files are installed to the default directory. These Help files are used as a default when the KM version is not specified using the KM pragmas or when version-specific Help does not exist for a KM. For more information, see KM directives.
PATROL Central-Windows Edition
The .chm Help files are installed in the following directories on the console server for the PATROL Central-Windows Edition:
- default PATROL Central-Windows Edition KM Help
version-specific PATROL Central-Windows Edition Help
%PATROL_ROOT%\lib\knowledge* prd_1_2\lib\help\LOCALE* prd.chm
Installing Help in the product-specific directory allows the console server to support multiple versions of the KM Help.
PATROL Central-Web Edition
The .htm Help files are installed in a .jar file in the following directory on the PATROL Central-Web Edition Web server:
- (Windows) BASE_DIR\PWC_DIR* km_services\html\default\lib\help* LOCALE
- (UNIX) BASE_DIR/PWC_DIR/ km_services/html/default/lib/help/ LOCALE
In the preceding list:
- BASE_DIR is the BMC Software installation directory
- PWC_DIR is the PATROL Central - Web Edition installation directory.
- LOCALE is the LOCALE value is formed by concatenating the language code, an underscore, and the country code. For example, english (EN) and the United States (USA) form the following LOCALE value: EN_USA
The Help files are installed to these directories, but the .jar files are moved and served by the PATROL Central-Web Edition Web server from the following directory:BASE_DIR/PWC_DIR/km_services/html
In the LOCALE directory, the PATROL Central-Web Edition KM Help files use the following naming convention:
Where the file name variables have the following values:
- prd - the KM product code or registered prefix
- v.r.m - the KM version
- LOCALE - the LOCALE value is formed by concatenating the language code, an underscore, and the country code.
The PATROL Central-Web Edition Web Server serves the Help from the .jar file as it is requested by PATROL Central-Web Edition. The Help files are not extracted from the .jar files.