Generating a probe lookup table from the Tellabs fault text definition XML file

The probe is supplied with a utility that allows you to generate lookup tables from the Tellabs fault text definition XML file.

In the previous version of this probe, the probe was supplied with the following lookup tables:

  • tellabs8000_gpt.lookup
  • tellabs8000_ntunames.lookup
  • tellabs8000_sptnms.lookup
  • tellabs8000_sptntu.lookup
  • tellabs8000_sptunit.lookup
  • tellabs8000_unames.lookup

With this version of the probe, these lookup tables are still provided, but the lookup table generator utility (tellabs8000_lookup_generator.jar) allows you to generate lookup tables from a fault text definition XML file. This means that the lookup tables that the probe uses can be updated before a newer version of the probe is released.

The lookup table generator utility is installed in the following directory:

$OMNIHOME/probes/java/tools/Tellabs8000LookupGenerator

The fault text definition XML file can be obtained from the Tellabs INM product or from Tellabs directly.

Note: The probe is also supplied with tellabs8000_alarmtype.lookup, but this lookup table is not generated by the lookup table generator utility.

Configuring the lookup table generator utility

The lookup table generator utility is configured using a properties file. It is supplied with the following properties file which has been pre-configured with default values set for each property:

$OMNIHOME/probes/java/tools/Tellabs8000LookupGenerato/generator_default.properties

The following table describes the properties and their default values. The only property you need configure is the inputPaths property to specify the location of the XML file that you want the probe to parse.

Table 1. Lookup table generator utility properties

Property name

Description

inputPaths string

Use this property to specify the location of the fault text definition XML file.

The default is resource/nbi/faults.xml.

combineMethod string

This property specifies how the utility generates the output files.

The default is separate which instructs the probe to create a separate lookup table for each fault type.

outputPath string

This property specifies the locations of the output files that the utility generates.

The default is tellabs8000_gpt.lookup| tellabs8000_ntunames.lookup| tellabs8000_sptnms.lookup| tellabs8000_sptntu.lookup| tellabs8000_sptunit.lookup| tellabs8000_unames.lookup.

Note: Each filename is separated by a pipe character (|). If the number of filenames specified does not match the number of table names specified by the tableName property, the utility writes all tables into the first filename specified in the list.

tableName string

This property specifies the names of the lookup tables that the utility generates.

The default is tellabs-GPT|tellabs-NTUNAMES|tellabs-SPTNMS|tellabs-SPTNTU|tellabs-SPTUNIT|tellabs-UNAME.

Note: Each table name is separated by a pipe character (|).

tableComment string

This property specifies comments to include with the tables that the utility generates.

The default is "" .

Note: Use a pipe character (|) to specify table comments for each table generated. The order of tableComment should follow the order of the table names specified in the tableName property.

verbose string

This property specifies whether the utility prints detailed log messages.

The default is false.
Note: If you need to include spaces in the value set for any of the properties, you must include the whole value within double quote marks (").

Running the utility

You run the lookup table generator utility from the command line. To run this utility, you must have Java JRE version 6 installed.

To run the utility with the default properties file (generator_default.properties), use the following command:

java -jar tellabs8000_lookup_generator.jar

To run the utility with an alternative properties file, use the following command:

java -jar tellabs8000_lookup_generator.jar -propPath "generator.properties"

Where generator.properties is the name of the properties file that you want to use instead of the default file.

To print information about the usage of the utility, use the following command:

java -jar tellabs8000_lookup_generator.jar -help

After running the utility, verify that the lookup tables have been generated correctly.

Note: The Tellabs fault text definition XML file encoding is set to UTF-8 and may contain some special-characters. These special characters may not appear correctly if viewed with a different locale settings. Use the following command to specify the file encoding property when generating the lookup tables and update your locale settings to UTF-8:

java -Dfile.encoding="UTF-8" -jar tellabs8000_lookup_generator.jar