skip to main content

The GUI

The GUI
About The GUI
This chapter covers the following topics:
Navigation
The new generation GUI in op5 Monitor is made to be as simple as possible to use. Even if the GUI has a new look and feel it works in many ways as the old one. You will recognize most of the features from the CGIs.
In-line help
A manual is great but many times you only need to get a fast answer about a special part of op5 Monitor.
To get information from the in-line help
1
Click the help icon
This gives you a small frame with the help text included in.
2
 
Login and logout
To login to op5 Monitor
First of all you need to login before you can start use op5 Monitor. To login to the op5 Monitor GUI:
1
2
3
4
Click Login
To logout from op5 Monitor
To logout from op5 Monitor just click Log out in the upper right
corner of the GUI.
Main menu
The navigation in op5 Monitor is simple and in many ways the same as in the old CGI GUI. But there are a couple of things that is new like:
*
*
*
*
Hide and show parts of the main menu
If you do not want to see the whole main menu you can easily hide parts of it by clicking on the section header of the section you want to hide.
Hide a section
Let's say you want to hide the Reports section of the menu. Then you should click on Reports like in the picture below:
Show a section
To show the Reports section again you just have to click on the Reports section header again.
Scroll the main menu
Sometimes your browser is unable to show the complete main menu.You can scroll the main menu by using the scroll bar just to the right of the menu, shown in the picture below:
Hide and show page header
In many views in op5 Monitor you can hide the page header. This will give you a bit more space to show the ''important`` things on the page.
Note:
This is not persistent. This means that if you navigate away from the current view and back again the header is visible again.
If you take the Unhandled problems as an example the normal page header looks like the picture below. Under the page header the list of monitored objects is shown.
Hiding the page header
To hide the page header
1
2
Showing the page header
To show the page header again you just need do one of the following
*
*
 
Minimize and expand the main menu
It is possible to hide the main menu and only show the icons instead of the icons plus the captions.
To minimize or expand the main menu you only need to click on the icon the top of the main menu.
Pop up graphs and comments
In every view where you find the icons for
*
*
You can over the mouse pointer over the icon and get a pop up looking like this
Changing behaviour of the pop ups
You might not want to have those pop ups every time you hover with the mouse over one of the graph or comment icons. Then you can change that behaviour in My account.
To change the behaviour of the pop ups
1
2
3
Mouse over host
To quickly show the host address of a host, hold the mouse on the host. A pop-up will appear with the host address.
Keyboard commands
The keyboard commands are shortcuts to some of the features in the op5 Monitor GUI. The following keyboards commands are available:
*
*
*
*
Table 1
By default the keyboard commands are disabled. To enable the keyboard commands and change their settings take a look at Keyboard commands used in the GUI on page 123.
 
Multiple host and service commands
Multiple commands is used to apply a single command to one or more host or services.
In almost every view in the monitoring section you may perform commands on the objects displayed in the view. This is very useful if you for instance have a bigger problem with one or many services you may then acknowledge all of them at once.
Multiple host commands list
*
Schedule downtime
*
*
*
*
*
*
*
*
*
*
*
Multiple service commands list
*
*
*
*
*
*
*
*
*
*
*
Example
In this example we will send acknowledgements to a larger number of services.
To execute multiple commands
1
Open up Unhandled problems view.
2
Click Select Multiple Items
(It is located on top of the list.)
3
4
Chose Acknowledge in Select Action drop down list just below the list and click Submit.
5
Quick Action Menu
For quick access some host and service commands you can access the Quick action menu.
The menu can be accessed thru right clicking on the status icon in front of a host or service.
This menu will only appear if you are ‘Authorized for system commands’ under Access Rights in the configuration.
Information about the different actions can be found in the Monitoring chapter, About Monitoring on page 31
Host Actions
The actions that are available on a host are:
*
*
*
*
*
*
*
*
Service Actions
The actions that are available on a service are:
*
*
*
*
*
*
Searching
op5 Monitor has got a search functionality that makes it easy to find:
*
*
*
*
*
*
Note:
The search is case insensitive.
The result is limited to maximum 10 result rows per object type.
In the upper right corner of the gui you find the search input field:
Simple search
To perform a simple search
1
2
3
If you click on a host in the drop down list you will be redirected to the Service Status Details For Host page for the host you clicked on. The same happens if the search found only one object matching your search string.
op5 Monitor will now search for hosts, services, service groups, host groups and notes matching the search string you entered.
The table below shows a list of in what parts of the object types is used in the search.
Advanced search
To make your search more specific you should use the advanced search features.
The following table describes the search parameters that can be used in the search function:
Search for Status information using the output from the latest service / host check.
The AND operator is used to filter records based on more than one condition
The OR operator is used to filter records based on more than one condition
Note:
Advanced search examples
Example 1
If you want to search for hosts only containing “server” in the host name
just enter the following in the search field:
h:server
or
host:server
Press enter to perform the search.
 
Example 2
In this example we want to find all services called either ping or http running on hosts called something like win or linux.
The query would then be:
h:win OR linux AND s:ping OR http
 
Example 3
To search for hosts and services having a certain string in their status output you shall write a query like this:
si:Connection refused
By using the si: search term and you will search the output from the latest check.
 
Example 4
You may also get a list of all services and all hosts from the search function.
To get a list showing all services and host you should write the search query like this:
s:% OR h:%
Example 5
To get a complete list of all hosts, services, host groups and service groups you only need to write a query like this:
%
This will give you a result with all object types grouped in one page.
 
Notes search
The search function can search on notes that is set in the configuration on both in hosts and services.
By default the search function will not search in notes. To enable this go to ‘My Account’ in the menu
and set ‘Show Notes’ to ‘Yes’
Limiting the number of result objects
The default search result will is limited to 100 rows. This can be changed in the search query.
To change the limitation you only need to add limit with the number of lines to your query like this:
limit=10
The line above will give you max 10 rows in the search result.
To return all rows set:
limit=0
 
Search result
No matter if you use the simple or the advanced way to do your search you will end up with the same type of result list.
As you can see in the search result example below the search will be shown with one part for each type of object.
Just like in the normal views you can sort all columns in the search result.
Refresh time
Every view is automatically refreshed after a certain time. You can easily pause or edit the global refresh time in the GUI.
The default Global refresh time is: 90 seconds.
The Global refresh time is valid for all views that uses auto refresh. So it does not matter in what view you are pausing or editing.
Pausing the page refresh
To pause the page refresh
1
Click Settings in the top right corner of the gui:
2
Click in the Pause refresh check box and the Global refresh time is paused.
Editing the refresh time
To edit the Global refresh time
1
Click on the Settings icon in the top right corner of the gui:
2
Once you have edited the Global refresh time a little notice will show up in the GUI. It tells you that the new Global refresh time is saved and look like the picture below.
Widgets
Widgets are used to give the user a ability to personalize the Tactical Overview display status data for their needs.
The first thing you will see when you login to op5 Monitor is the Tactical overview and it looks like this:
In the Tactical Overview you may:
*
*
*
*
*
*
 
Note:
Widget list
op5 Monitor comes with a number of availible widgets used to display data in Tactical Overview:
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
Beside this wide range of widgets you can find additional widgets on www.op5.org, or create a own widget that fits your needs. This is described in“op5 Monitor Administratiors Manual”.
Widget parts
Below you see an example of what a widget can look like:
 
The following table describes the parts of a widget shown in the picture above.
Renaming the widget header
The widget header displays the name of the widget.
To change the name in the widget header
1
2
3
Click OK to save the new name.
Collapse and expand
If you like to hide the content of a widget but still keep it on the Tactical overview page just click on the Collapse icon.
To show the widget again
Click on the Expand icon.
Widget settings
In this version of op5 Monitor the only setting you can change on a widget settings is:
*
To set the refresh time on an individual widget follow the instructions below:
1
Click Widget settings icon
2
Extended widget settings
As described in “Multiple Instances” it is possible to create multiple copys of a widget.
This can be useful with some of the widgets we ship with op5 Monitor such as “Unacknowledged Service problems”. This widget displays the content of “Unhandled Problems” as default, but can be configured to use filters to display status information from servicegroups, and it is also possible to filter on the following statuses:
*
*
*
*
*
Besides the standard Status filters: “Warning, Critical, Unknown”, Hard and Backlog are present.
With “Hard” you can select to only filter on Hard status and discard all SOFT states. This is the default setting when op5 Monitor sends notifications.
Backlog is a little more complicated. This setting can be useful if Tactical overview is displayed on a screen as a NOC-dashboard to monitor the status of hosts and services.
When the Backlog setting is used the widget will display all the problems that has been reported since your last login, even if these problems has been resolved.
To remove a problem when the backlog setting is activated you must either acknowledge the problem, or click the “X” button to remove it form the list.
Note:
 
In the following example we will choose to display all the critical problems in HARD-state from the servicegroup “Web Services”:
 
1
2
3
When you have applied your settings a notification will be displayed in the top right corner showing that the settings are saved.
4
 
Hiding widget 1
 
You may hide one or more widgets from the Tactical overview.
Just click on the Hide widget icon to hide the widget completely from the Tactical overview.
Hiding widget 2
Another way to hide the widgets from the Tactical overview is to click on the Page settings icon.
And then you just uncheck the widget, you like to hide, from the list.
Note:
The widget will only be visually removed from the Tactical overview. It will not be removed from the software. See Moving widgets on page 28 about how to show the widget again.
Multiple instances
It is possible to create multiple instances of a widgets, this can be useful to use to display different datasources in widgets, such as status of a servicegroup or critical unacknowledged problems.
To create another instance of a widget: Click the copy button on a widget .
This will create an identical copy of the widget.
 
Moving widgets
You may move around the widgets shown in the Tactical overview as you like.
To move a widget from one section an other
1
Grab the Widget parts on page 23 and move it to the section you like to place it in.
2
Restoring to factory settings
To restore the Tactical overview to factory (default) settings
1
Click Widget settings icon.
2
Click on the Restore to factory settings button and all widget have
*
*
*
*
Create you own widgets
You may build your own widgets but this is not a subject for this user manual.
You can read more about how to build your own widget in the op5 Monitor Administrator manual.

Feedback on documentation Feedback on documentation