Building and packaging custom KMs
Before you can load a custom Knowledge Module (KM) in the BMC ProactiveNet Performance Management environment and configure it through BMC ProactiveNet Central Monitoring Administration, you must build and package the KM.
The PCIG tool builds and packages custom KMs and creates Product Package Files (PPFs), which are required for the build and package (BAP) image. The PCIG tool is supported only in Linux and Windows platforms.
For information about building a KM, see Building a PATROL Knowledge Module Developers Guide.
This topic describes how to use the PCIG tool to create new PPFs.
Before you begin
You can find the PCIG tool installer in the installation utility\bmc_products\tools\pcig directory of the BMC PATROL Installation Utility installer. To start using the PCIG tool for creating a BAP image for custom KMs, perform the following steps :
- Copy the downloaded file and the product (KM) in a temporary folder.
For more information, see Downloading the product.
- Extract the installation utility folder and the custom KM folder for which you want to create the BAP image.
The executable files, pcig-32.exe or pcig.l22 (for 32-bit Microsoft Windows or Linux), and pcig-64.exe or pcig.l64 (for 64-bit Microsoft Windows or Linux) of the PCIG tool will be located in the following directory, depending on the operating system:
- (Microsoft Windows): installation utility\bmc_products\tools\pcig
- (Linux): installation utility/bmc_products/tools/pcig
Creating a BAP image for custom KMs
You can create a BAP image for custom KMs by running the following command:
$. /pcig<32-bit or 64-bit> -p <product_name> -r <release> -s <source_path> -l <os_list> -t <product name in BMC ProactiveNet Central Monitoring Repository> -c
-p <product_name>—Name of the KM package in the format, [A-Za-z0-9]. It also specifies the output name of the PPF file that will be created. The maximum number of character allowed in the product name is 10.
-r <release>—The version of the package to be used with BMC ProactiveNet in the format, vv.mm.rr .
-s <source_path>—The path required to package member files. The files under source_path are copied to dest_path/products/product_name and zipped, and their respective entries are added under the files section of the ppf. The ppf and cat file are located at dest_path/Products/product_name, and a copy of the PPF is also placed in dest_path/Index/.
-l <os_list>—(Optional.) Comma separated list of OS types. The supported values are: AIX, SOLARIS, HP, LINUX, WINDOWS, ALL, ALL-UNIX. If you have not specified any operating system type, by default, ALL is considered as the value.
-t <product name in BMC ProactiveNet Central Monitoring Repository>—(Optional.) Product name (within double quotes) to be used in the BMC ProactiveNet Central Monitoring Repository. If you have not specified the product name, by default the name of the KM package (value of the -p switch) is considered as the value.
-c—(Optional.) Print copyright details
Here is an example of creating a BAP image for a custom KM, XOM:
$. /pcig-64 -s XOM/ -p XOM -t "PATROL for XOM" -r 1.0.00 prearing PPF [HEADER] section... Loading files for packaging... 7 files prepared for packaging. Preparing PPF [FILES] section... Generating PPF file... bmc_products/Index/XOMs.km.ppf... Generating AT file... bmc_products/Products/XOMskm/XOMskm.cat...
Here a BAP image for XOM KM will be created with the name "PATROL for XOM", and the version 1.0.00. After you run the above command, the bmc_products folder will be created in the parent directory (temporary folder).
$ls -ltr total 84 -rwxr-xr-x 1 wasbld bmc 74358 Jan 8 19:20 pcig drwxr-xr-x 4 wasbld bmc 2048 Jan 8 20:30 XOM drwxr-xr-x 4 wasbld bmc 2048 Jan 8 20:40 bmc_products
The bmc_products folder contains files required for building and packaging the KM. To list the files created for building and packaging the KM, run the
find bmc_products -type f command.
c$ find bmc_products -type f bmc_products/Index/XOMs.ppf bmc_products/products/XOMs.km/XOMs1.gz bmc_products/products/XOMs.km/XOMs2.gz bmc_products/products/XOMs.km/XOMs3.gz bmc_products/products/XOMs.km/XOMs4.gz bmc_products/products/XOMs.km/XOMs5.gz bmc_products/products/XOMs.km/XOMs6.gz bmc_products/products/XOMs.km/XOMs7.gz bmc_products/products/XOMs.km/XOMskm.ppf bmc_products/products/XOMs.km/XOMskm.cat bmc_products/imageinfo.000000-000000
Run the following command to see the values created in the PPF file:
$ more bmc_products/Index/<KM file name>skm.ppf
$ more bmc_products/Index/XOMskm.ppf [HEADER] PRODUCT=XOMskm PKGNAME=XOM-KM-Application_Classes VERSION=1.0.00 VERSION_COMPATIBILITY=ALL BOOK=PATROL Knowledge Modules DESC=PATROL for XOM RELEASEVER=3.4, 3.5, 7.1, 7.2, 7.4 OSLIST=all PRODUCT_FAMILY=PATROL INFRASTRUCT_DESIGNATOR=PAT, PAV, PAA, PWN ISKM=1 PKG_SIZE=29321 PKG_LOCALE= AUTOSELECT SEQUENCE=10000 [END HEADER] [FILES] ./lib/knowledge/XOM_Performance.km;Y;;;644;all|| ./lib/knowledge/XOM_Performance.kml;Y;;;644;all|| ./lib/knowledge/XOM_Perf_Disks.km;Y;;;644;all|| ./lib/knowledge/XOM_Perf_Disk_CONTAINER.km;Y;;;644;all|| ./lib/knowledge/XOM_Perf_MSSQL_Locks.km.km;Y;;;644;all|| ./lib/knowledge/XOM_Perf_MSSQL_Locks_CONTAINER.km.km;Y;;;644;all|| ./XOM/XOM.cfg;Y;;;755;all
The BAP image of the custom KM will be created in a zipped file, and you can import this into BMC Performance Management Repository.
For information on importing a component into BMC Central Monitoring Repository, see .