Table Of Contents
Using the Configuration Manager
Configuration Manager Operation
Starting the Configuration Manager
Selecting Configuration Manager Tabs
Using Configuration Manager Tool Bars and Menu Bars
Users and Groups
Changing the User List Display
Sorting the User List
Resizing the Columns in the User List
Including or Excluding Types of Users in the User List
Refreshing the User List Display
Creating a User
Editing a User
Copying User Names from the System User List
Deleting a User
Adding a User to a Group
The Groups Window
Creating a Group
Renaming a Group
Deleting a Group
Removing a User from a Group
Cisco Info Server Properties
Menus, Tools, and Prompts
Managing Menu Items
Adding a Tool to a Menu
Adding a Separator
Adding a Sub-Menu
Deleting a Menu Item
Renaming a Menu Item
Changing the Order of Menu Items
Filtering Tools by Class and Group Access
Testing Menus
Tools
Copying a Tool
Creating a Tool
Editing a Tool
Deleting a Tool
Tool Buttons
Prompts
Creating a Prompt
Classes
Creating a Class
Editing a Class
Deleting a Class
Refreshing the Class Display
Conversions
Creating a Conversion
Editing a Conversion
Deleting a Conversion
Refreshing the Conversions Display
Column Visuals
Creating a Column Visual
Editing a Column Visual
Deleting a Column Visual
Refreshing the Column Visual Display
Creating a Color
Editing a Color
Deleting a Color
Refreshing the Color Display
Properties Editor
Starting the Properties Editor
Selecting a Property File to Modify
Adding a Property
Editing a Property
Removing a Property
Saving Properties
Using the Configuration Manager
This chapter describes how to configure Cisco Info Center using the Configuration Manager and the Properties Editor. It contains the following sections:
•
Configuration Manager Operation
•
Users and Groups
•
Cisco Info Server Properties
•
Menus, Tools, and Prompts
•
Classes
•
Conversions
•
Column Visuals
•
Properties Editor.
For information on how to configure automations, see Automation.
Configuration Manager Operation
Most Cisco Info Center configuration tasks are performed from the Configuration Manager. Changes to one installation do not affect other installations.
This section is an introduction to the Configuration Manager, including:
•
Starting the Configuration Manager
•
Selecting Configuration Manager Tabs
•
Using Configuration Manager Tool Bars and Menu Bars.
Starting the Configuration Manager
Start the Configuration Manager by clicking the Configuration button on the Conductor or from the command line by entering:
$OMNIHOME/bin/nco_admin [-option [<parameter>]...]
where -option is the command line option and <parameter> is the option parameter. Table 3-1 lists the command line options.
Table 3-1 Configuration Manager Command Line Options
Command Line Option
|
Description
|
-username <string>
|
Specifies the user name.
|
-password <string>
|
Specifies the password for the user.
Note Entering a password on the command line is not recommended because it will then be displayed in the system's process list.
|
-server <string>
|
Specifies the name of the Cisco Info Server to which to connect. If not specified, the default is NCOMS.
|
-nlw
|
Does not display the license expiry warnings.
|
-diagnostic
|
Displays extended diagnostic messages (for Cisco Support only).
|
-cmap
|
Installs a custom color map. This is useful for displays with limited colors available.
|
-automations
|
Opens the Configuration Manager with the Automations tab displayed.
|
-users
|
Opens the Configuration Manager with the Users tab displayed.
|
-properties
|
Opens the Configuration Manager with the Properties tab displayed.
|
-menus
|
Opens the Configuration Manager with the Menus tab displayed.
|
-classes
|
Opens the Configuration Manager with the Classes tab displayed.
|
-conversions
|
Opens the Configuration Manager with the Conversions tab displayed.
|
-visuals
|
Opens the Configuration Manager with the Column Visuals tab displayed.
|
-help
|
Displays help text on the command line options and exits.
|
-version
|
Displays version information and exits.
|
Selecting Configuration Manager Tabs
The tabs display an icon and text. Cisco Info Center configuration is divided into categories. To select a configuration category, click the tab on the left-hand side of the Configuration Manager.
Table 3-2 indicates where to find information about each tab in this guide.
The selected tab appears in front of the other tabs. Right click the Tab bar to display a popup menu from which you can change the size of the icons.
Using Configuration Manager Tool Bars and Menu Bars
The Tool bar and Menu bar are different for each tab. The Menu bar contains drop-down menus. The Tool bar contains buttons for the most frequently performed tasks.
Users and Groups
The Users tab of the Configuration Manager enables you to view, create, and modify the users and groups for the Cisco Info Server to which you are connected.
You must have super user (for example, the root user) privileges to configure users and groups.
Figure 3-1 shows an example Users tab.
Figure 3-1 Configuration Manager - Users Tab
When the Users tab is selected, the Configuration Manager Tool and Menu bars display the user configuration options. The Users tab also displays all users for the Cisco Info Server to which you are connected. The columns contain the following details:
•
user name
•
full name
•
user ID
•
user type
•
whether password-enabled
•
whether access is allowed in the SQL interactive interface
•
whether modification is allowed in the SQL interactive interface
•
any applied restriction filters.
Changing the User List Display
In the user list display, you can:
•
sort the user list by user name, User ID, or security level
•
resize the columns in the user list
•
include or exclude types of user in the user list.
Sorting the User List
By default, the users are sorted by user name.
You can also sort users by user ID or security level. To change the sort order of the user list, choose
View -> Sort, then select the Sort column.
Resizing the Columns in the User List
To resize the columns in the user list display:
Step 1
Click and hold down the mouse button on a column divider.
Step 2
Drag the mouse to change the width of the column.
Including or Excluding Types of Users in the User List
By default, the View menu lists the following types of users:
•
Normal User
•
Administrator
•
Super User
•
Nobody User.
To include or exclude a user type from the display, click the user type in the View menu.
Refreshing the User List Display
To refresh the display, choose View > Refresh Users.
Creating a User
To create a user, do one of the following:
•
choose User > New or
•
click the New User button.
The New User window appears. Fill in the information for the window items shown in Table 3-3.
Table 3-3 New User and Edit User Window Items
Window Item
|
Description
|
User Name
|
Enter or edit the user name. When you are editing an existing user, this field is read-only and the user name appears in gray.
User names are restricted to 64 characters and can include spaces.
|
Full Name
|
Enter or edit the full name of the user.
|
User ID
|
Enter or edit the user identifier number. The Users tab displays these numbers in the UID column.
You can enter any number not already assigned to a user in this field. The number can be set to the UNIX user identifier on UNIX platforms.
|
Fill In
|
If the user name matches a UNIX user name, you can click the Fill In button to copy the UNIX system information for the user automatically to the Full Name and User ID fields.
|
Conversion
|
When Conversion is selected, a conversion entity is added to the internal conversions table when you create a user. This converts the user's UID to the user's name in the Event List. You can edit the name displayed using the Conversions tab of the Configuration Manager, if required. See Conversions.
Note It is recommended you leave the Conversion box selected.
|
Use System Password
|
Select this check box if you want users to have Cisco Info Center passwords the same as their UNIX passwords. Cisco Info Center accepts UNIX passwords provided by the Network Information Service (NIS).
|
Password
|
Enter the user's password in the Password field and retype it in the Verify field. The password characters appear as asterisks as you type.
Note You should only use alphanumeric characters in the password. Special characters such as #, /, >, @, and ! should not be used.
The password is optional.
|
Security Level
|
Select one of the following levels of access to the Cisco Info Center system:
- Normal users can use all the Desktop tools except the Objective View Editor, the Configuration Manager, the Server Editor, and the Properties Editor.
Normal users can work with alerts assigned to them and those assigned to the Nobody user. If the AlertSecurityModel property is enabled (the default is disabled), normal users can also work with alerts assigned to a user in the same group.
- Administrator users can use the Configuration Manager except for the Properties, Users, and Automations tabs. Administrator users can work with any alerts owned by a Normal user or the Nobody user, and alerts assigned to them or their group.
- Super Users can use all Desktop tools. A Super User can manipulate any alert, no matter who owns it.
|
Restricted Events
|
The Restricted Events check box specifies which alerts a user is allowed to see. Check the Restricted Events box to activate the corresponding text pane.
Type SQL commands in the text pane to create the restriction filter. Only the alerts satisfying this query can be viewed by the user.
Alternatively, click the Filter button to use the Filter Builder to create the restriction.
|
Allow ISQL Access
|
Select the Allow ISQL Access check box to allow a user to connect to the Cisco Info Server and view (SELECT) Cisco Info Server data using the SQL Interactive Interface, described in Direct Access Using the SQL Interactive Interface (nco_sql).
Note The AllowISQL Info Server property, described in Specifying Cisco Info Server Properties, must be set to True for any users to be able to connect to the Cisco Info Server using the SQL Interactive Interface.
|
Allow ISQLWrite Access
|
Select the Allow ISQLWrite Access check box to allow a user to modify (INSERT, UPDATE, and DELETE) Cisco Info Server data using the SQL Interactive Interface, described in Direct Access Using the SQL Interactive Interface (nco_sql).
Note The AllowISQLWrite Info Server property, described in Specifying Cisco Info Server Properties, must be set to True for any users to be able to make updates to Cisco Info Server data using the SQL Interactive Interface.
|
Editing a User
To change the details of an existing user, do one of the following from the Users tab:
•
choose User > Edit or
•
click the Edit User button.
The Edit User window appears. When you are editing an existing user, the User Name and User ID fields are gray and cannot be modified. See Creating a User for a description of the window items.
Copying User Names from the System User List
To display a list of users known to the system, click the System Users button in the Users tab. The System User List window, shown in Figure 3-2 appears.
Figure 3-2 Sample System User List Window
The list displays the following information for all known users:
•
System User Name
•
Full Name
•
UID (User Identifier)
•
GID (Group Identifier).
This list can be used for reference or as a source of names.
To copy a selected user to the user list display, choose User > Add User.
Deleting a User
To delete a selected user, do one of the following:
•
choose User > Delete or
•
click the Delete User button.
When the popup prompt appears requesting verification, click OK. The user is deleted.
Adding a User to a Group
To add a user to a group:
Step 1
Choose a user.
Step 2
Choose User > Add to Group.
A popup list appears showing the existing groups.
Step 3
Choose a group.
The user is added to the group. For more information on groups, see the next section.
The Groups Window
The Groups window, shown in Figure 3-3, displays all existing groups. You can use this window to create and manage groups.
To open the Groups window, do one of the following while the Users tab is selected:
•
choose User > Edit Groups or
•
click the Groups button.
Figure 3-3 Sample Groups Window
The Groups window displays the following information:
•
Defined groups and corresponding group identifier
•
User names associated with each group
•
Full name of each user
•
User identifier UID).
Creating a Group
Step 1
To create a group, do one of the following:
a. 
choose Group > New or
b.
click the New Group button.
The New Group window appears.
Step 2
Enter the following in the New Group window:
a.
Name of the new group in the Name field.
b.
Group ID in the Group ID field.
Two groups cannot have the same group ID. The group ID appears in parentheses to the right of the group name in the Groups window.
Renaming a Group
Step 1
To rename a selected group, do one of the following:
a. 
choose Group > Rename or
b.
click the Edit Group button.
The Edit Group window appears.
Step 2
Change the name.
Step 3
Click OK to confirm.
If the name entered already exists, a warning message appears and you are prompted to enter an alternative name.
Deleting a Group
To delete a selected group, do one of the following:
•
choose Group > Delete or
•
click the Delete Group button.
When the popup prompt appears requesting verification, click OK. The group is deleted.
Removing a User from a Group
To remove a selected user from a group, do one of the following:
•
choose Group > Remove Member or
•
click the Remove Member button.
The user is removed from the group.
To add a user to a group, see Adding a User to a Group.
Cisco Info Server Properties
The Cisco Info Server uses properties, stored in a $OMNIHOME/etc/<servername>.props properties file, to control its behavior. The Properties tab of the Configuration Manager, shown in Figure 3-4, enables you to view and modify the Cisco Info Server properties file.
where <servername> is the name of the Cisco Info Server.
The Properties Editor, described in Properties Editor, enables you to edit the information in the properties files for Cisco Info Servers, proxy servers, process agents, Cisco Info Mediators, and gateways.
Figure 3-4 Properties Tab
See Specifying Cisco Info Server Properties for descriptions of the displayed properties. You must have super user (for example, the root user) privileges to modify Cisco Info Server properties.
Note
It is essential you are familiar with the properties before modifying them. Incorrect configuration can negatively impact system performance.
The Toggle Property button becomes active when a property with a boolean data value is selected. The button toggles the property between Yes and No. When the boolean value is No (False) the property icon is red. When the boolean value is Yes (True) the property icon is green.
The Edit Value button becomes active when a property with an integer or string data value is selected. The button opens a window in which you can enter a new value. Properties having an integer value display a numeric field with arrows to increase or decrease the value. Properties having a string value display a text field with no arrows.
The Save button saves the changes permanently to the .props file.
Note
You can modify properties while the Cisco Info Server is running. When you make a change it is applied instantly, but it is not automatically saved. If you shut down and restart the Cisco Info Server the original settings are restored from the .props file unless the new settings are saved.
Menus, Tools, and Prompts
The Menus tab of the Configuration Manager enables you to configure menus, tools, and prompts for the Desktop. Each menu consists of a menu name and a list of menu items. Menu items are tools, separators, and sub-menus. Figure 3-5 shows an example Menus tab.
Figure 3-5 Sample Menus Tab
The Menus tab view can be filtered by selecting a specific group or class from the drop-down lists in the Tool bar. See Filtering Tools by Class and Group Access.
Double-click a menu item to display its associated tools and sub-menus, if any exist. Click a sub-menu to display its associated tools.
Each tool has a menu item name and an associated tool name. The tool name is the name of the tool in the Tools database. The menu item name appears when the menu is opened. You can modify the menu item name as required.
Tools appearing as menu items on the Menus tab are automatically assigned an icon based on the status of the tool, as listed in Table 3-4.
Table 3-4 Icons in Tools List
Icon
|
Description
|
|
The tool is enabled (red).
|
|
The tool is disabled (gray).
|
|
The tool does not exist in the tools database.
|
Managing Menu Items
In the Menus tab, you can:
•
add menu items
•
delete menu items
•
rename menu items
•
change the order the menu items
•
filter which tools are displayed based on class and group access
•
test menus.
Table 3-5 shows the menus you can manage. You can add items to these menus, or remove items from them, but you cannot delete the menus.
Table 3-5 Menus Associated with Cisco Info Center Components
Menu Name in Configuration Manager
|
Menu Name on the Cisco Info Center Component
|
AlertsMenu
|
Alerts menu and popup menu on the Event List, when an alert is selected.
|
ConductorMenu
|
Tools menu for the Conductor.
|
MainEventListMenu
|
Tools menu for the Monitor Box window of the Event List.
|
MainOVMenu
|
Tools menu for the objective view main window.
|
MapPageOVMenu
|
Tools menu for any open objective view map page and the Unplaced Events window.
|
SubEventListMenu
|
Tools menu for any Event List window.
|
SymbolToolsMenu
|
Tools menu when you right-click an objective view symbol.
|
Adding a Tool to a Menu
To create a new tool, see Creating a Tool. When you create a new tool, it is added to the Tools database. The tool is then available to add to a menu.
To add an existing tool to a selected menu or sub-menu:
Step 1
Do one of the following:
a. 
click the New Menu Item button, then choose New Tool from the popup menu or
b.
choose Menu > New Tool.
A popup list appears showing the existing tools.
Step 2
Select a tool from the tool names in the popup list.
Adding a Separator
To add a separator to a selected menu, do one of the following:
•
choose Menu > New Separator or
•
click the New Menu Item button, then choose New Separator from the popup menu.
A separator appears at the bottom of the menu.
Adding a Sub-Menu
Step 1
To add a sub-menu to a selected menu, do one of the following:
a.
choose Menu > New Sub-Menu or
b. 
click the New Menu Item button, then choose New Sub-Menu from the popup menu.
The New Sub-Menu window appears.
Step 2
Enter a sub-menu name, then click OK.
Step 3
If the name already exists, you are prompted to enter an alternative name.
Once the window has closed, a new sub-menu entry appears below the parent menu. The sub-menu does not yet contain any tools.
Deleting a Menu Item
To delete a menu item, select it and do one of the following:
•
choose Menu > Delete or
•
click the Delete Menu Item button.
When the popup prompt appears requesting verification, click OK.
The menu item is removed from the list.
When you delete a tool from a menu, only the menu entry is removed. The tool remains in the Tools database, the Tools window, and any other menu in which it appears. To delete a tool, see Deleting a Tool.
Note
You cannot delete the default menus listed in Table 3-5.
Renaming a Menu Item
Step 1
To rename a menu item, select it, then choose Menu > Rename.
The Rename Menu Label window appears.
Step 2
Change the name.
Step 3
Click OK to confirm.
If the name entered already exists, a warning message appears and you are prompted to enter an alternative name.
Note
The Tool entry in the menu consists of the tool name, which refers to the tool in the Tools database, and a label that appears in the menu. When you rename a menu item, you are changing the label, rather than renaming the tool itself.
Changing the Order of Menu Items
To rearrange the order of tools, separators, and any sub-menus within a menu, select the item to be moved, then click the appropriate Tool bar buttons, listed in Table 3-6, to reposition the menu items.
Table 3-6 Reposition Buttons
Button
|
Description
|
|
Up one position.
|
|
Down one position.
|
|
To top.
|
|
To bottom.
|
The window is refreshed automatically with the item in its new position. You can also use the cut, copy, and paste menu options to reposition menu items.
Filtering Tools by Class and Group Access
The Menus tab includes two drop-down lists used to filter the tools displayed. The first filter enables you to select a group. The default entry is All Groups. The second filter enables you to select a class. The default entry is All Classes.
When the filters are changed from these default options, the text is grayed on any tool not matching the filter. The tool is not available if:
•
the user is not in a selected group
•
the alert belongs to a class not in the list of selected classes.
You must assign class access and group access to each tool. See Completing the Access Tab.
Testing Menus
You can test the selected menu by clicking the Test Menu button. The menu appears as a popup menu. The contents of the menu appear as they will on the Event List and other windows.
Not all menu items in the Menus tab are displayed. The class or group filter in use affects the menu as follows:
•
when a group filter has been applied, any tool not enabled for the selected group does not appear in the test menu
•
When a class filter is applied, any tool not enabled for the selected class appears in gray. Disabled tools also appear in gray.
Note
Tools appearing in the Test menu do not run when selected.
Tools
Tools allow you to control alert management functions within Cisco Info Center. Each tool has an associated SQL statement (called an internal effect), an executable (called an external effect), or both. You can group tools in Tools menus, which you can associate with a class or classes of alert.
You create and edit tools using the Tools window. When you create a tool, it is added to the tools database. The tools appearing in the Menus tab and the Tools window are links to entries in this database.
To open the Tools window, click the Tools Window button.
The Tools window displays all available tools in the left hand column. The other columns show whether the tool has been enabled to do the following:
•
start an internal effect. SeeCompleting the SQL Tab
•
start an external effect. See Completing the Executable Tab
•
force a journal entry for an alert. See Completing the Journal Tab.
The icons indicating the status of the tool are described in Table 3-4.
Figure 3-6 shows an example Tools window.
Figure 3-6 Sample Tools Window
Copying a Tool
To create a new tool based on an existing tool, copy the tool within the Tools window. The content of the new, copied tool is identical to the source tool. You can then edit the new tool and add it to menus, as required.
Copying a Tool
To copy a tool, select the tool you wish to copy, then do one of the following:
•
choose Tool > Copy or
•
click the Copy button.
The new tool is added. It is named Copy of <toolname>, where <toolname> is the source tool. You need not paste it.
Creating a Tool
The Tools window contains the master version of each tool. Tools are stored as entries in the Tools database. Menu items are links to the tool.
To create a tool, do one of the following:
•
choose Tool > New or
•
click the New Tool button.
The New Tool window appears. The window items shown in Table 3-7 appear above every tab.
Table 3-7 Tool Window Common Fields
Window Item
|
Description
|
Name
|
Enter a unique name for the new tool.
|
Enabled
|
The Enabled check box appears above every tab in the window. Tools are not available in the Menus tab until they are enabled and the window is closed.
There are separate Enabled check boxes for the SQL command, the executable command, and the forced journal entry.
|
The New Tool window is divided into the following tabs:
•
SQL
•
Executable
•
Journal
•
Access
•
Description.
Fill in the tabs as described in the following sections. Click OK to save the new tool. This updates the Tools database. An entry for this tool then appears in the Tools window.
Completing the SQL Tab
Use the SQL tab to create an internal effect. Type the SQL text or build the SQL statement using the tools provided by the buttons on the right of the pane. The SQL statement appears in the main pane of the SQL tab.
Fill in the window items shown in Table 3-8.
Table 3-8 Tool Window Common Fields
Window Item
|
Description
|
Enabled
|
Select this check box to enable SQL for this tool.
|
Execute for Each Selected Row
|
When this check box is selected, the SQL command is executed once for each row in an Event List row selection.
|
You can use the SQL Statement Builder, Column Names, Conversion Names, Internal Value Names, Prompt Names, and Filter Builder buttons to build the SQL statement. These are described in Tool Buttons.
Completing the Executable Tab
Use the Executable tab to create external executable commands for a tool. The executable command appears in the main pane of the Executable tab. Figure 3-7 shows an example Executable tab.
Figure 3-7 New Tool - Executable Tab
Fill in the window items shown in Table 3-9.
Table 3-9 Tool Window Executable Tab
Window Item
|
Description
|
Enabled
|
Select this check box to enable the executable action.
|
Execute for Each Selected Row
|
When this check box is selected, the executable is run once for each row in the Event List selection.
|
Redirect Output
|
The Redirect Output check box controls where the output of a command is sent. When it is not selected, the output is discarded. When it is selected, the output is echoed in a read-only window.
|
Redirect Errors
|
The Redirect Errors check box controls where any error messages from a command are sent. When it is not selected, error messages are discarded. When it is selected, errors are echoed through a read-only window.
|
In the Platform pane, select the platforms which are able to run the executable.
There are buttons to add platforms to the Selected list and remove platforms from the Selected list. Table 3-10 describes the function of these buttons
Table 3-10 Tool Window Executable Tab - Selected
Button
|
Description
|
|
Copy all platforms to the Selected pane.
|
|
Remove all platforms from the Selected pane.
|
|
Copy selected platforms to the Selected pane.
|
|
Remove selected platforms from the Selected pane.
|
Using nco_elct in an Executable Command
The nco_elct utility enables you to open a customized, transient Event List from within an executable tool. For example, you can create a tool that automatically opens an Event List and applies a filter to that list to view all critical and severe alerts from a particular Cisco Info Server. The command line options for the nco_elct utility are shown in Table 3-11.
Table 3-11 nco_elct Command Line Options
Command Line Option
|
Description
|
-cmap
|
Specifies a custom color map.
|
-diagnostic
|
Displays extended diagnostic messages. This is typically used from the command line only.
|
-ffile <string>
|
The filter file name.
|
-fmetric <string>
|
The filter metric.
|
-fname <string>
|
The filter name.
|
-ftext <string>
|
The SQL statement to use for filtering events.
|
-help
|
Displays help text. This is typically used from the command line only.
|
-password <string>
|
The password for the selected user name. The nco_elct utility only accepts alphanumeric characters in the password. Special characters such as #, /, >, @, and ! are not permitted.
|
-server <string>
|
The Cisco Info Server to which you are connecting.
|
-username <string>
|
The user name to connect as.
|
-version
|
Displays version information. This is typically used from the command line only.
|
-vfile <string>
|
The view file.
|
Note
You can also run nco_elct directly from the command line.
Using nco_elct Example
To create a transient view of all events with a critical severity, enter the following into the main pane of Executable tab:
$OMNIHOME/bin/nco_elct -fname "CriticalEvents" MYVIEW -ftext "Severity=5" -fmetric "sum(Acknowledged)"
When you run this tool, an Event List appears containing all events with a critical severity.
You can also use the Column Names, Internal Value Names, Environment Variable, and Prompt Names buttons to build the executable command. These are described in Tool Buttons.
Completing the Journal Tab
The Journal tab is used to write journal text. This text is appended to the journal of the selected alert or alerts when the tool is executed.
Fill in the information listed in Table 3-12.
Table 3-12 Tool Window Executable Tab
Field
|
Description
|
Force Journal Entry
|
When you execute a tool with the Force Journal Entry check box selected, a new window opens and the text from the Journal tab is displayed in it. You can then add more text before clicking the OK button to complete the tool execution.
|
Execute for Each Selected Row
|
When this check box is selected, the journal entry is executed once for each row in the selection.
|
Redirect Output
|
The Redirect Output check box controls where the output of a command is sent. When it is not selected, the output is discarded. When it is selected, the output is echoed in a read-only window.
|
Redirect Errors
|
The Redirect Errors check box controls where any error messages from a command are sent. When it is not selected, error messages are discarded. When it is selected, errors are echoed through a read-only window.
|
You can use the Column Names, Internal Value Names, and Prompt Names buttons to build the executable command. These are described in Tool Buttons.
Completing the Access Tab
The Access tab enables you to specify the classes and groups that can use the tool. Alerts are assigned a class by the Cisco Info Mediator that sends them to the Cisco Info Server. For more information on classes, see Classes. For more information on groups, see Users and Groups.
Figure 3-8 shows a sample Access tab.
Figure 3-8 Sample Access Tab
Use the buttons shown in Table 3-10 to select and deselect one or all of the classes and groups.
The tool is not available if:
•
the user is not in a selected group
•
the alert belongs to a class not in the list of selected classes.
For information on how an unavailable tool appears in a menu, see Table 3-4.
Description Tab
The Description tab of the New Tool window enables you to enter notes describing the function of the tool. Enter a description of the tool on this tab. The description does not affect the operation of the tool.
Editing a Tool
When you modify a tool, the change is made to the entry in the Tools database. The modification affects the entries in the Menus tab and the Tools window, which are linked to this modified tool.
To edit a tool, do one of the following:
•
choose Tool > Edit or
•
click the Edit Tool button.
The Edit Tool window appears. When you are editing an existing tool, the Name field appears in gray and cannot be modified. See Creating a Tool for a description of the window items.
Deleting a Tool
When you delete a tool, the selected tool is deleted from the Tools window, the Tools database, and every menu which uses the tool.
To delete a tool, do one of the following:
•
choose Tool > Delete or
•
click the Delete Tool button.
The tool is deleted.
Tool Buttons
The following buttons are available from the New Tool and Edit Tool windows. Depending on the tab selected, different options are available. The sections on the tabs in Creating a Tool list the buttons relevant to that tab.
SQL Statement Builder Button
When you click the SQL Statement Builder button, a popup list appears containing the following SQL commands:
•
Delete
•
Insert
•
Select
•
Service Update
•
Sync
•
Update
•
Use
Click one of these options to open the associated window as described in Table 3-13.
Table 3-13 SQL Statement Builder Options
SQL Option
|
Description
|
Delete
|
The delete statement requires a database name and a table name. Enter the details in this window, then click OK.
|
Insert
|
The insert statement requires a database name, a table name, and entries for all of the fields in the specified table. When the table is selected, the lower pane changes to show a list of every field name in the selected table. If you do not complete a field, the default value is used. Default values are:
• 0 for integers
• an empty string for varchar and char fields
• the current time for time fields.
|
Select
|
The select statement requires a database name, a table name, and a list of fields from the table for selection.
Use the arrows to move fields in the Available Fields list to the Selected Fields list or to remove them from the Selected Fields list.
|
Service Update
|
The service update statement requires a service name and a value. The value can be selected from the options in the drop-down list. Values can be Good, Marginal, or Poor.
|
Sync
|
In the Sync window, first select either database or table. If database is selected, enter only the database name. If table is selected, enter the database and table names.
|
Update
|
In the Update window, select a database name and a table name from the drop-down lists.
Click the New button to open the Edit Expression window. You can use the Edit Expression window to create and edit prompt and value expressions by entering a field and a value for the field. Click OK to return the Update window. The expression created in the Edit Expression window appears in the Expression list.
Click the Edit button to edit a selected expression.
Click the Delete button to delete a selected expression.
|
Use
|
The use statement sets the database name to use in the SQL statement.
|
Column Names Button
Click the Column Names button to open a list of available field names in the alerts.status table. Click a column name to add the name to the statement.
The column name is substituted for the corresponding Event List row value when the tool is executed.
Column names appear in the text as the expansion keyword @<name>, where <name> is the name of the selected field.
Conversion Names Button
Click the Conversion Names button to open a list of available conversions.
When an option is selected, it opens a popup window showing the list of conversions. Select a conversion name from the list.
Internal Value Names Button
Click the Internal button to open the Internal Values popup window. Table 3-14 lists the possible internal values.
Table 3-14 Internal Values Description
Internal Value
|
Description
|
display
|
The current display running the application.
|
password
|
The password of the user running the application.
|
server
|
The name of the Cisco Info Server to which the tool is currently connected.
|
UID
|
The user identifier of the user running the application.
|
username
|
The user name of the user running the application.
|
Internal values appear in the script as an expansion keyword %<name>, where <name> is the name of the internal value.
Start Filter Builder Button
Click the Start Filter Builder button to open the Filter Builder, described in the Cisco Info Center User Guide, 3.6.
Environment Variable Names Button
Click the Environment Variable Names button to open a list of available environment variables for the local machine.
Environment variable names appear in the text as the expansion keyword $<name>, where <name> is the name of the environment variable.
Prompt Names Button
Click the Prompt Names button and select a prompt from the list of prompt names in the popup list.
Prompts appear in the text as the expansion keyword $prompt.<name>, where <name> is the name of the prompt.
Prompts
A tool can include a prompt window or a popup menu for the user to enter information. You can enter a prompt in an SQL statement, an external command, or a journal entry.
The Prompt Definitions window displays the prompts available for tools to use. To open the Prompt Definitions window, do one of the following:
•
choose Menu > Edit Prompts while the Menus tab is selected or
•
click the Prompt Definitions button.
The Prompt Definitions window appears, as shown in Figure 3-9.
Figure 3-9 Prompt Definitions Window
Creating a Prompt
To create a prompt:
Step 1
Do one of the following:
a. 
choose Prompt > New or
b.
click the New Prompt button.
The New Prompt window appears.
Step 2
Enter the following details in the window:
a.
in the Name field, enter the name of the prompt, which must be unique.
b.
in the Prompt field, enter the prompt text that appears when the tool requests information.
c.
select the prompt type from the Type drop-down list.
The available prompt types are:
•
Dynamic Choice
•
Fixed Choice
•
Float
•
Integer
•
Lookup
•
Password
•
String
•
Time
The remaining fields depend on the prompt type, as described in the following sections.
Completing a Dynamic Choice Prompt
A single dynamic choice prompt in a tool creates a popup menu. The menu is populated by the results of a database query.
To complete the prompt details:
Step 1
Select a database from the drop-down list in the Database field.
Step 2
Select a table in the selected database from the drop-down list in the Table field.
Step 3
The Show field defines the table field used to populate the Prompt menu. Select a field name from the drop-down list.
Step 4
The Assign field defines the table field used to return a value to the SQL statement, external command, or journal entry containing the prompt. Select a field name from the drop-down list.
Step 5
Enter a search condition in the Where field.
You can use the Filter Builder button to open the Filter Builder to create this condition.
Step 6
The Order By field defines the table field used to order the items in the prompt menu. Select a field name from the drop-down list.
Step 7
The Sort Direction button sorts the Order By field in ascending or descending order. Click the buttons to set the sort order.
Completing a Fixed Choice Prompt
A single Fixed Choice prompt in a tool creates a popup menu. The menu is populated by the values you enter into the list.
All values in the list appear in the popup menu.
To add a value to the list, enter the value, then click the + button.
To remove a value from the list, select a value from the Value pane, then click the - button.
To edit a value in the list, select a value from the Value pane, click the Edit button, then edit the text.
To remove a value from the list, select a value from the Value pane, then click the Delete button.
The total number of characters in the prompts in the list cannot exceed 256. For longer lists, use the Lookup prompt type.
Completing a Float Prompt
The Float prompt creates a prompt window that accepts a floating point number, which can contain a decimal point.
To complete the prompt details, enter a default value to display.
Completing an Integer Prompt
The Integer prompt creates a prompt window that accepts an integer value. To complete the prompt details enter a default value to display.
Completing a Lookup Prompt
A single Lookup prompt in a tool creates a popup menu. The menu is populated by the values in a file.
To complete the prompt details, do one of the following:
•
enter the path and name of the file in the Value field or
•
click the Browse button to open a standard file selection window, then select the file.
Completing a Password Prompt
The Password prompt creates a prompt window that accepts one or more characters. The password characters appear as asterisks as you type.
Completing a String Prompt
The String prompt creates a prompt window that accepts one or more characters. To complete the prompt details, enter a default value for the prompt to display.
Completing a Time Prompt
The Time prompt creates a prompt window that accepts a time. The default display is the current time.
Prompt Display Types and Their Appearance
The way prompts appear depends on the prompt type and the number of prompts in the tool. Prompt display methods are described in Table 3-15.
Table 3-15 Prompt Type Appearance
Prompt Type
|
Appearance
|
Dynamic Choice, Fixed Choice, or Lookup
(single prompt in tool)
|
The tool opens a popup menu, which does not display a label.
|
Dynamic Choice, Fixed Choice, or Lookup
(multiple prompts in tool)
|
The tool opens a prompt window with multiple fields as drop-down lists. The content of the Prompt field from the New Prompt window appears as the label for the field.
|
Float, Integer, Password, String, or Time
|
Opens a prompt window with a single field.
|
Editing a Prompt
To edit a selected prompt, do one of the following:
•
choose Prompt > Edit or
•
click the Edit Prompt button.
The Edit Prompt window appears. When you are editing an existing prompt, the Name field appears in gray and cannot be modified. See Creating a Prompt for a description of the window items.
Deleting a Prompt
To delete a selected prompt, do one of the following:
•
choose Prompt > Delete or
•
click the Delete Prompt button.
When the popup prompt appears requesting verification, click OK. The prompt is deleted.
Renaming a Prompt
To rename a selected prompt, select Prompt > Rename.
The Rename Prompt window appears.
Change the name, then click OK to confirm. If the name entered already exists, a warning message appears and you are prompted to enter an alternative name.
Classes
The Classes tab of the Configuration Manager enables you to view, create, and modify classes. Alerts in the Cisco Info Server have a class assigned by the Cisco Info Mediator. Each class can be associated with a Tool menu that contains useful tools for alerts of that class.
For more information about tools and classes, see Menus, Tools, and Prompts. As shown in Figure 3-10, each entry in the Classes tab displays a unique identifier number and the name of the class.
Figure 3-10 Configuration Manager - Classes Tab
Creating a Class
Step 1
To create a class, do one of the following:
a. 
choose Class > New or
b.
click the New Class button.
The New Class window appears.
Step 2
Enter the class identifier in the Identifier field. The class identifier is defined in the rules file for each Cisco Info Mediator.
Step 3
Enter a name for the class in the Name field.
Step 4
Additionally, select an image from the Image pane, using the slider to move from one image to the next. Click the image to make the selection.
The image is used in the Symbol Palette window in the objective view (see Starting the Objective View Map Editor).
Editing a Class
To edit a selected class, do one of the following:
•
choose Class > Edit or
•
click the Edit Class button.
The Edit Class window appears. When you are editing an existing class, the Identifier field appears in gray and cannot be modified. See Creating a Class for a description of the window items.
Deleting a Class
To delete a selected class, do one of the following:
•
choose Class > Delete or
•
click the Delete Class button.
The class definition is deleted.
Refreshing the Class Display
To refresh the display, select View > Refresh Classes.
Conversions
The Conversions tab of the Configuration Manager enables you to view, create, and modify conversions. In the Event List, conversions translate integer or boolean values into strings for readability. Conversions are associated with columns in the Cisco Info Server alerts.status table. Figure 3-11 shows an example Conversions tab.
Figure 3-11 Configuration Manager - Conversions Tab
The Conversions tab displays a list of columns in the alerts.status table that have conversions. Double-click the column icon to display the existing conversions. The conversions are shown indented below each column name.
Creating a Conversion
Step 1
To create a conversion, do one of the following:
a. 
choose Conversion > New or
b.
click the New Conversion button.
The New Conversion window appears.
Step 2
In the Column drop-down list, select the name of the column containing the data to be converted.
Step 3
In the Value field, enter the integer value which is to be converted.
Step 4
In the Conversion field, enter the string to which the value is to be converted.
Editing a Conversion
To edit a selected conversion, do one of the following:
•
choose Conversion > Edit or
•
click the Edit Conversion button.
The Edit Conversion window appears. When you are editing an existing conversion, the Column and Value fields appear in gray and cannot be modified. See Creating a Conversion for a description of the window items.
Deleting a Conversion
To delete a selected conversion, do one of the following:
•
choose Conversion > Delete or
•
click the Delete Conversion button.
The conversion definition is deleted.
Refreshing the Conversions Display
To refresh the display, select View > Refresh Conversions.
Column Visuals
The Column Visuals tab of the Configuration Manager enables you to view, create, and modify column visuals. When alert information is displayed in the Event List and other tools, the visual appearance is defined by the settings of the column visuals.
For each field in an alert, you can set the title text, title justification, data justification, and the default and maximum widths. Figure 3-12 shows an example Column Visuals tab.
Figure 3-12 Configuration Manager - Column Visuals Tab
The Column Visuals tab has two columns. The left column lists the fields in the alerts.status table. The right column lists the associated column title displayed in the Event List. The icon to the left of the field name indicates the justification of the column.
Table 3-16 shows example column visual table field justification icons.
Table 3-16 Example Column Visual Table Field Icons
Icon
|
Description
|
|
Title and column justified left.
|
|
Title justified center and column justified right.
|
Creating a Column Visual
Step 1
To create a column visual, do one of the following:
a. 
choose Column Visual > New or
b.
click the New Column Visual button.
The New Column Visual window appears.
Step 2
Click the Column drop-down list to select the column for which you are adding the visual.
Step 3
In the Title field, enter the title that is to appear at the top of the column in the Event List.
Step 4
In the Default field, enter the default column width (in characters).
Step 5
In the Max field, enter the maximum column width (in characters).
Step 6
Click the column Justify drop-down list and select Left, Right, or Center.
Step 7
Click the title Justify drop-down list and select Left, Right, or Center.
Editing a Column Visual
To edit a selected column visual, do one of the following:
•
choose Column Visual > Edit or
•
click the Edit Column Visual button.
The Edit Column Visual window appears. When you are editing an existing column visual, the Column field appears in gray and cannot be modified. See Creating a Column Visual for a description of the window items.
Deleting a Column Visual
To delete a selected column visual definition, do one of the following:
•
choose Column Visual > Delete or
•
click the Delete Column Visual button.
The column visual definition is deleted.
Refreshing the Column Visual Display
To refresh the display, choose View > Refresh Column Visuals.
Creating a Color
Step 1
To create a color definition, do one of the following:
a. 
choose Color > New or
b.
click the New Color icon.
The New Color window appears.
Step 2
Choose the severity for which you wish to define the colors in the Severity field.
You can also click the arrows to increment or decrement the value. When you select a severity, the conversion name appears in the Conversion field.
Step 3
Set the colors for Unacknowledged and Acknowledged alerts. To define the color, in the Red, Green, and Blue fields, enter the RGB value for the required color. Alternatively, click the Palette button to display a color palette.
Editing a Color
To edit a selected color definition, do one of the following:
•
choose Color > Edit or
•
click the Edit Color icon.
The Edit Color window appears. When you are editing an existing color, the Severity field appears in gray and cannot be modified. See Creating a Color for a description of the window items.
Deleting a Color
To delete a selected color, do one of the following:
•
choose Color > Delete or
•
click the Delete Color button.
The color definition is deleted.
Refreshing the Color Display
To refresh the display, choose View > Refresh Colors.
Properties Editor
The Properties Editor enables you to edit the information in the properties files for Cisco Info Servers, proxy servers, process agents, Cisco Info Mediators, and gateways.
You can also modify the Cisco Info Server properties file using the Properties tab of the Configuration Manager. See Cisco Info Server Properties.
Starting the Properties Editor
To start the Properties Editor, click the Properties button on the Conductor. If the Cisco Info Server has not been started, you can enter the following command:
$OMNIHOME/bin/nco_xprops
Figure 3-13 shows the Properties Editor.
Figure 3-13 Properties Editor
Selecting a Property File to Modify
A properties file has a .props extension. To select the property file in the Properties Editor:
Step 1
Choose the property type from the Type drop-down list.
The types available are Server or Info Mediator.
Step 2
Choose a property file from the File drop-down list.
All property files for the selected type are shown.
Step 3
Click OK.
The Properties Editor searches for the selected file and then lists the properties. The settings in a read-only property file appear in gray. You cannot modify them.
Adding a Property
To add a new property:
Step 1
Enter a property name in the Name field.
Step 2
Enter a value in the Value field.
Step 3
Click the Add button to add the new property.
Editing a Property
To edit the value of an existing property:
Step 1
Click a property to select it.
Its name and value appear in the Property pane.
Step 2
Edit the value in the Value field.
Step 3
Click the Update button to modify the property.
Removing a Property
To remove a property from the list:
Step 1
Click the property to select it.
Step 2
Click the Remove button.
The property is removed.
Saving Properties
To save the changed properties, click the Save button.