|
|
This chapter covers how configure the Cisco Info Center Java Event List. You need only read this section when you have installed Java support for the Java Event List.
This chapter includes the following sections:
The Java Event List is used to distribute and manage Cisco Info Center events through the World Wide Web (WWW). The Java Event List uses a background server process, which obtains information from the Cisco Info Server.
The background process, called jeld, and a Web server should be installed on the same machine to overcome Java browser security issues.
When a Web browser makes a connection to the Web server, the server can send back an HTML page containing the Java applet to the browser. The applet then connects to the jeld and requests a configuration. The jeld retrieves the configuration from the Cisco Info Server, and this is used to display the Event List information in the Web browser.
The configuration information is stored in an Cisco Info Server database table and is configured using the JEL Advanced Configuration Editor (JACE).
The Java support components are, by default, installed in the $OMNIHOME/java directory. The configuration procedure for Java support covers the following steps:
1. Install a Web server and set up the communications to Cisco Info Center.
2. Copy the class files to the publication home directory of the Web server.
3. Set the properties files.
4. Create configurations with JACE.
5. Create the HTML pages.
6. Run the background process, jeld.
These steps are described in detail in the following sections.
In order to use the Java Event List, you must have a Web server installed and configured to support Java applets. The Web server must be installed on the same machine as the Java support components. You can obtain free Web servers from the WWW.
For information about how to configure the Web server to support Java applets, for example, initialization of class files, see your Web server documentation.
You should configure the system that runs the Web server to connect to Cisco Info Center. To do this, you install a Cisco Info Admin Desktop on the machine that runs the Web server to check the connectivity requirements. See the Cisco Info Center Installation and Configuration guide for more information.
Before you can create HTML pages for the WWW, you must publish the class and zip files on the Web server. The class files are in the $OMNIHOME/java/jel directory. This directory contains the following subdirectories:
Copy these directories to the publication home directory of your Web server. To test the applets, load the pages from the Web server.
For example, specify your server name with the following URL:
http://<your-server-name>/html/index.html
The jeld.props properties file is located in the $OMNIHOME/java/props directory. You must modify this file to match your system configuration. An example properties file is shown below.
jeld.Cisco Info Server.host: omnihost
jeld.Cisco Info Server.port: 4100
jeld.Cisco Info Server.user: root
jeld.Cisco Info Server.password:
jeld.listenport: 7575
jeld.maxconns: 3
jeld.isp: +*
jeld.hosts: +*
jeld.logdir: /opt/Omnibus
jeld.logfile: jeld.log
The following sections explain the items in the properties file and how to set the values.
This entry contains the host name where the Cisco Info Server is located. For example, specify:
jeld.Cisco Info Server.host: omnihost
Where omnihost is the name of the host.
You can override this entry with the jeld command line option -host.
This entry contains the port setting for the Cisco Info Server. For example, specify:
jeld.Cisco Info Server.port: 4100
You can override this entry with the jeld command line option -port.
This entry contains a user name (the suggested user name is jeld) for the Cisco Info Server. For example, specify:
jeld.Cisco Info Server.user: jeld
This entry contains the jeld password for the Cisco Info Server. The password should be encrypted using the nco_crypt command. For example, specify:
jeld.Cisco Info Server.password: <string>
Where <string> is the encrypted password. To create an encrypted password, specify:
nco_crypt <password>
Where <password> is the unencrypted form of the password. The nco_crypt command displays an encrypted version of the password.
This entry contains the port number. For example, specify:
jeld.listenport: 7575
You can override this entry with the jeld command line option -listenport.
This entry contains the maximum number of connections supported by the nco_jeld process. For example, specify:
jeld.maxconns: 3
You can control the number of connections a single jeld process can handle, however, this does not override the number of available licences.
This entry is a list of the domains allowed to connect to the applet. For example, to allow only 10.0.0.1, 10.0.0.5, and 10.0.0.10 to connect to the applet, specify:
ips:+10.0.0.1 +10.0.0.5 +10.0.0.10 -*
To allow only machines in the domain 10.n.n.n to connect, specify:
ips:+10.* -*
To allow any domain to connect, specify:
ips:-+*
This entry is a list of hosts allowed to connect to the applet. For example, to allow only machine1, machine2, and machine3 to connect to the applet, specify:
hosts:+machine1 +machine2 +machine3 -*
To allow only machine1 to connect, specify:
hosts:+*machine1 -*
To allow any machine to connect, specify:
hosts:+*
This entry contains the name of the directory in which the log file is located. For example, to ensure the log file is located in the /opt/Omnibus directory, specify:
jeld.logdir: /opt/Omnibus
This entry contain the name of a log file. The log file contains diagnostic information about the background process, jeld. For example, to use a log file called jeld.log,specify:
jeld.logfile: jeld.log
For Java configuration, use the JEL Advanced Configuration Editor (JACE). JACE is a table-orientated editor that allows you to manage configurations. These configurations are stored in the jel.jel_props Cisco Info Server table, to which the jeld is connected. You must have super user privilege to use JACE.
For maximum flexibility, the configuration files include options to take particular settings from the HTML parameters. These parameters include, view name, fields, order, and filter.
To start JACE, specify the following command:
host# $OMNIHOME/java/bin/jace
Figure 6-2 shows the JACE display. When you first start JACE, you should import the default configuration file $OMNIHOME/java/misc/jel1.jace.
The JACE display is in a tree format, made up of sets. A set is a group of property and name value pairs. The display shows a configuration, named jel1, which contains the default values for the sets. This configuration is used by default in the applet parameters in the HTML page, and is specified using the configuration parameter. See Section, "Configuration Parameter".
You can edit the jel1 configuration or use it as the basis for new configurations.
To rename a configuration:
1. Click on the configuration you want to rename. For example, click on jel1.
2. Click on the Rename button. The Rename Configuration window is displayed, as shown in Figure 6-3.
3. Specify the new name for the configuration.
An entire configuration can be copied, including all sets and properties, or just one part of a configuration.
To copy a configuration:
1. Click on the configuration you want to copy. For example, click on jel1.
2. Click on the Copy button. The Copy Configuration window is displayed, as shown in Figure 6-4.
3. Specify a name for the configuration. The copied configuration is displayed in the JACE display.
To delete a configuration:
1. Select the configuration from the JACE display.
2. Click on the Delete button. The configuration is removed from the JACE display.
You can create additional sets in the configuration. To add a set:
1. Select the configuration from the JACE display.
2. Click on the Add button. The Add Set to Configuration window is displayed, as shown in Figure 6-5.
3. Specify the name of the set. The set is displayed in the configuration in alphabetical order.
JACE allows you to import and export configurations for use on other machines. Configurations may be exported to ASCII readable files and those files can be imported, allowing for the backup of master configurations.
To import a configuration:
1. Select the File menu's Import option.
2. Select the configuration file to import, then click on the OK button. The configuration is displayed in the JACE display.
To export a configuration:
1. Select the configuration from the JACE display.
2. Select the File menu's Export option.
3. Specify a file name for the configuration. It is recommended you give the file name a .jace extension.
The configuration mechanism allows multiple-named configurations to be stored for use by the applets.
To use a configuration, the configuration name is used in an applet parameter in the HTML page. See Section, "Configuration Parameter".
A configuration is made up of sets. A set is made up of a group of property and name value pairs. In the following sections, the properties are listed as:
*.<setname>.<propertyname>=<value>
Where * represents any configuration name, <setname> represents the name of the set, and <propertyname> represents the name of the property.
*.view.fieldsfromhtml=false
When true, the field information for the JEL is taken from the HTML page applet parameter fields in the same format as JEL 1.x. When false, the field information is taken from the following property:
*.view.fields=1,2,3
Where 1,2,3 represents the field sets. The field information is taken from the field data in the configuration (see Section, "Fields").
*.view.filterfromhtml=false
When true, the filter is taken from the HTML page applet parameter filter in the same format as JEL 1.x. When false, the filter is taken from the property view.filter.
*.view.namefromhtml=false
When true, the view name is taken from the HTML page applet parameter viewname in the same format as JEL 1.x. When false, the view name is taken from the property view.name.
*.view.orderfromhtml=false
When true, the order is taken from the HTML page applet parameter order in the same format as JEL 1.x. When false, the view name is taken from the property view.name.
*.view.toolsfromhtml=false
When true, the tools information is taken from the HTML page applet parameter tools in the same format as JEL 1.x. When false, the tools information is taken from the tool data in the configuration (see Section, "Tools").
*.view.filterrestriction=
When not null, the filter is prefixed and an AND clause is added with the specified restriction. This applies to HTML and configuration filters.
*.view.name=All Critical
Specifies the name of the view, which is displayed on the Monitor box button, the inline-view message area, and the float-view title bar.
*.view.order=Severity asc
Specifies the ordering to be used for the view.
*.view.filter=Serial>0
Specifies the filter to be used for the view.
*.audio.alertsample=crash.au
This sets the sample to be played for audio alerts.
*.audio.enable=true
When this is set to true, the alerts sample is played when new alerts are displayed in the Event List. When this is set to false, the alerts sample is not played.
A field is stored as a set of attributes, each set being named field1, field2, field3. The field information is set in the *.view.fields= set. The properties within each set are field, title, and width. For example:
*.field1.field=Serial
*.field1.title=Serial
*.field1.width=10
*.field2.field=Node
*.field2.title=Node
*.field2.width=16
*.field3.field=Summary
*.field3.title=Summary
*.field3.width=20
Each tool is stored as a set of attributes, each set being named tool1, tool2, tool3, tool<n>. Any discontinuity in the ordering (for example, tool1, tool2, tool4) forces only the tools before the discontinuity to be used. The properties within each set are name, params, type, and url. These properties reflect the four components of a tool as used in the JEL 1.1 release. For example:
*.tool1.name=Show Home Page
*.tool1.param=
*.tool1.type=go
*.tool1.url=http://icarus/
Sets the URL to browse when the help option is selected from the menu.
*.help.url=http://icarus/help.html
*.look.authenticate=true
When true, you can authenticate perform operations that modify alerts.
*.look.authenticatefirst=false
When true, you must authenticate yourself before JEL displays any data.
*.look.background=708090
Sets the background cover of the JEL for all widgets where a background color is meaningful. All colors are specified in hexadecimal.
*.look.font=Helvetica
Sets the font for the Event List and windows.
*.look.fontsize=12
Sets the font size for Event List and windows.
*.look.foreground=ffffff
Sets the foreground color for windows.
*.look.frameheight=256
Sets the pixel height of the frame opened when JEL opens an Event List in float mode.
*.look.framewidth=512
Sets the pixel width of the frame opened when JEL opens an Event List in float mode.
*.look.inline=false
When true, the JEL operates in inline mode. When false, JEL operates in float mode.
*.look.menufont=SansSerif
Sets the font for menus (where the platform allows menu fonts to be set).
*.look.menufontsize=12
Sets the menu font size (where the platform allows menu fonts to be set).
*.look.monitorbox=true
When true, enables the Monitor box in float mode. When false, only a button with the view name is displayed in float mode.
*.look.look3d=true
When true, the Event List grid has a 3-dimensional raised edge look. When false, the grid has a flat 2-dimensional look.
The following sets are associated with the refresh utility.
*.look.autorefresh=true
When true, JEL automatically refreshes at a rate set by the property *.look.refreshrate.
*.look.manualrefresh=true
When true, you are provided a menu option or button to allow for the manual refreshing of JEL.
*.look.refreshrate=10
Sets the refresh rate for the Event List in automatic refresh mode.
*.look.refreshtoggle=true
When true, you can see menu options/buttons to alternate between automatic and manual refreshing.
The following options are only relevant in float mode to control the appearance of the Monitor box.
*.monitorbox.font=Helvetica
Sets the font used in the Monitor box.
*.monitorbox.fontsize=12
Sets the font size used in the Monitor box.
*.monitorbox.height=40
Sets the height of the distribution meter in the Monitor box.
*.monitorbox.highest=true
When true, displays the highest severity in the current view.
*.monitorbox.lowest=true
When true, displays the lowest severity in the current view.
*.monitorbox.total=true
When true, displays the total number of alerts in the current view.
The following options control the modifying of alerts. Note, all options require you to authenticate yourself first.
*.updatepermissions.acknowledge=true
When true, a menu option/button allows you to ack and deack alerts.
*.updatepermissions.assign=true
When true, a menu option/button allows you to assign alerts to other users.
*.updatepermissions.delete=true
When true, a menu option/button allows you to delete alerts.
*.updatepermissions.journal=true
When true, a menu option/button allows you to add entries to an alerts journal.
*.updatepermissions.severity=true
When true, a menu option/button allows you to change the severity of alerts.
The following options control the viewing of alerts.
*.viewpermissions.details=true
When true, and you are showing a full report or information, the details for the alert are also shown.
*.viewpermissions.fullreport=true
When true, a menu option/button allows you to do a full report (information, details, and journal) on selected alerts.
*.viewpermissions.info=true
When true, a menu option/button allows you to display information (and optional details) on selected alerts.
*.viewpermissions.journal=true
When true, a menu option/button allows you to display journal details for selected alerts.
*.viewpermissions.select=true
When true, you can select alerts in the Event List. This is recommended.
To configure the Java Event List, you add applet parameters to the HTML pages. An example HTML file is available in $OMNIHOME/java/html/jel1.htm. The following sections describe the available parameters and how to set their values.
The applet tag defines where the code for the Java Event List should be located and the class that should be run. It also defines the width and height of the applet in the HTML page.
For example, specify:
<APPLET CODEBASE="../classes" archive="jel.zip"
CODE="COM.micromuse.jel.Jel.class" WIDTH=200 HEIGHT=64>
For Communicator and other Java 1.1 compliant browser users, change the archive entry to jel.jar. For example, specify:
<APPLET CODEBASE="../classes" archive="jel.jar"
CODE="COM.micromuse.jel.Jel.class" WIDTH=200 HEIGHT=64>
The config parameter allows you to specify the configuration to use. The configuration is defined with JACE. See Section, "Configuration with the JACE Editor". For example, specify:
<param name="config" value="jel1">
The host parameter allows you to specify the host name. For example, specify:
<param name="host" value="127.0.0.1">
The port parameter allows you to specify the port number. For example, specify:
<param name="port" value="7575">
The ViewName parameter is a string that labels the button and window that are displayed when you use the float mode. For example, specify:
<param name="ViewName" value="High Severity">
This parameter is used when the configuration namefromhtml is set to true.
The Order parameter is the SQL text of an Ordered By clause. For example, specify:
You can specify multiple orders, with precedence going from left to right, by separating entries with a comma. For example, specify:
<param name="Order" value="Severity desc, Serial asc"
This parameter is used when the configuration orderfromhtml is set to true.
The ViewFields parameter controls the display of fields. For example, specify:
<param name="ViewFields" value="Serial,Serial,10|Node,Node,16| Summary,Summary,64|Severity,Sev,10|Acknowledged,Ack,3|FirstOccurence,First,16|OwnerID,Owner,16">
The fields are listed in the following format:
FieldName,Title,Width[|FieldName,Title,Width]...
Where FieldName is the field from the Cisco Info Server, Title is the text to appear above the column when it is displayed, and Width is the number of characters. The pipe character (|) is used to separate the entries.
Note, when you do not include the Severity field, no severity coloring is displayed. When you do not include the Acknowledged field, no acknowledgment shading is displayed. Therefore, this feature allows you to prevent severity and acknowledgment information appearing in the Event List.
This parameter is used when the configuration fieldsfromhtml is set to true.
The Filter parameter allows you to define the filter. This is the SQL of a where clause and can contain any valid filter text. For example, specify:
<param name="Filter" value="Severity>3">
This parameter is used when the configuration filterfromhtml is set to true.
The Tools parameter is used to call up CGI scripts (or other Web-based tools) based on fields in selected alerts. The entries can be spread over multiple lines in the following format:
<NameforMenu>(<setting>) (BaseURL) (<CGIParam>,<Value>,<CGIParam>,<Value>...)
<NameforMenu> is the name that will appear on the Tools menu.
<setting> is the mode for this tool and can be either:
BaseURL is the URL to be called.
<CGIParam> is the name of the parameter to be passed to the CGI script.
<Value> is the value taken from the same named field in the Java Event List view.
For example, specify:
<param name="Tools" value=
Show Home Page (go) (http://armagnac/) ()
Ping a single host(one)(http://armagnac/cgi-bin/ncping)(Node,Node,Serial,Serial)
Ping multiple hosts(all)(http://armagnac/cg-bin/ncping) (Node,Node,Serial,Serial)">
This parameter is used when the configuration toolsfromhtml is set to true.
The </Applet> tag marks the end of the applet.
To run the background process, jeld, specify the following command:
host% $OMNIHOME/java/bin/jeld
When the background process is running, you can then open the HTML page in a Web browser. The page displays the configuration settings. For example, Figure 6-6 shows the Web browser when you use the default settings in the jel1 configuration and use the example HTML page.
Posted: Thu Mar 18 11:22:58 PST 1999
Copyright 1989-1999©Cisco Systems Inc.