Operations Center - Custom Right-Clicks - Menu Options

over 7 years ago
Within the Operations Center Console (Java webstart client), you can right-click on alarms or elements to perform actions (AKA: Operations).  These actions are exposed by underlying Adapters and/or are Operations Center specific.   Operations can be used to perform actions such as Close, Acknowledge, Suppress and many other things.   If you find that while using the Operations Center client that you manually launch a browser to do other things, go to the start menu to run something, etc, you have an opportunity to add additional custom Operations such as Opening a help desk ticket, launching event viewer in context to the selected host.   I will cover options in a future blog.   For today, I'd like to discuss the options for creating the Operations.

To start with, out of the box Operations are handled under the cover by Operations Center.   They are either NOC specific or they are exposed through a specific adapter.   These menu options can not be changed.  They are presented as options to the end user based on permissions.   If you would like to add more operations, with the java webstart client, navigate to Administration\Server\Operation Definitions.  By default there are no custom operations defined within a new install.  There are some examples ones provided.

Turn on Examples Operations

To turn on the example operations, you must have access to the file system on the NOC server.   Copy NOC\database\examples\Operations.ini file into NOC\database\shadowed directory.   Within a minute the custom examples should show up in the java webstart client under Administration\Server\Operation Definitions.   A server restart should not be required.

I will cover the guts of the operations in a future blog, today is all about creating them and customizing the menu.

Create your own Operations

To create your own Operations, you can right-click on Administration\Server\Operation Definitions and choose Create Operation.   There are a few fields that are required to be filled out such as where the operations should be exposed (on an alarm or element), base permissions the end user requires to see the operations, etc.

Operation "Name" field

When creating an custom operation, the Name field is not exposed to the end user.  This ends up being the name of the element under Administration\Operation Definition.   Most people match the "name" field to the next field (read further).

Operation "Menu text" field

The Menu Text field is the name of the menu option that will be displayed to the end user.   This name should be obvious as to what the operation does such as "Launch Eventviewer", "Create Ticket", etc.  I typically make the Name field and the Menu text field the same in order to make it easy to find it in the future if I need to edit it further.

Operation Submenus

If you are creating several menu options, it is nice to group similar actions such as Telnet, SSH, RDP, etc.   In order to do that, you use the pipe sign (IE:  | ) within the menu text.   For example, entering "Open|Telnet" for one operation and "Open|SSH" for another menu option would create a singled entry on the root of the operation called "Open" and then under this section you would have two options, Telnet and SSH.  Below is an example where I group different debugging options, the first menu text entry would look like "Dev|Client Debug"


Customizing the Look of the Operation Menu option

The Menu text field can be customized to show the text in different colors, even font sizes.  To do this, you need to leverage HTML formatting options.  By default if you enter text such as "Open Ticket", it will display the menu option in the standard text format just like all the other Operation options.  To make the menu text display to the end user in Red, you could do something like this:

<HTML><BODY><B><FONT COLOR="Red">Escalate Incident</FONT></B></BODY></HTML>

The menu text option above will create a menu item called "Escalate Incident" and it would be displayed in red.   You can leverage the submenu option with this example also by doing the following:

Incidents|<HTML><BODY><B><FONT COLOR="Red">Escalate Incident</FONT></B></BODY></HTML>

This will create a menu option off the root of the menu called "Incidents" and a submenu option of Escalate Incident under it.   On one of the demo systems, the engineers like to be able to right-click on an element and set an element to specific algorithm.  The _forceCritical option would look like this:

Set Algorithm|<HTML><BODY><B><FONT COLOR="Red">_forceCritical</FONT></B></BODY></HTML>


This covers the basics of creating custom operations.  In a future blog I will go further into the other options such as the Match By option and some basic scripting tips.   As usual, have fun playing with it and as usual, practice on a development system, not production.

Comment List
Related Discussions