- Default Dashboard
- Accessing Other Dashboards
- Dashboard Management Console
- Dashboard Management Console – Start Dashboard Rotation
- Dashboard Management Console – Dashboard Configuration
- Creating a new dashboard
- Reordering the list of dashboards
- Activating and deactivating dashboards
- Dashboard Management Console – Control
- View a dashboard
- Clone a dashboard
- Configure dashboard
- Delete a dashboard
- Rename a dashboard
- Enabling/Disabling a dashboard
- Configuring a Dashboard
- Control Buttons
- Save progress
- Save and Close
- Grid size
- Fixed Grid Size
- Adding grid rows and columns
- Creating/Resizing/Moving Dashlets
- Configuring a dashlet
- Example: Interface Performance Metric Dashlet for group Athens
- Control Buttons
- Admin Tool – Dashboard Configuration
- Global settings and User Overrides
- Available Options
- Enable Dashboards
- Custom Reporting Console
- Dashboard Manager
- Default Tab
- NIM Console Default
- Admin Tool – Dashboard Copy to other User
- Errors and Warnings
- Copy to Section
- Delete Existing
- Overwrite Mode
A dashboard is presented as the default landing page when a user logs in to Statseeker.
The admin user can change this default view for different users via the Administration Tool > Dashboards configuration tool. This includes disabling dashboards for a user, or presenting the NIM Console by default.
The order of the dashboards can be changed by each user via the Dashboard Management Console. By moving a dashboard to the first dashboard in the list it will become the default dashboard.
If a user does not have any dashboards configured they will be presented with the NIM Console as the landing page.
- The admin user has an example dashboard configured
- Newly created users will not have any dashboards configured
- If upgrading from Statseeker 3.8.1 each user will still have their 3.8.1 dashboard
Default dashboard presented as the landing page for the admin user.
Accessing Other Dashboards
The list of available dashboards is presented to each user via a menu list in the header on the Dashboard TAB. To view a dashboard, select it from the menu list.
Dashboards can be bookmarked in the browser in order to return to a specific dashboard. Note: renaming a dashboard will break this browser bookmarked link.
The order that dashboards appear in the list can be changed via the Dashboard Management Console.
When a dashboard is being configured via the Dashboard Management Console using the save progress option, this configuration view of the dashboard is also available in the same menu list. This helps to identify dashboards that are still being worked on from a user perspective.
Dashboard menu list with the default admin dashboard.
Dashboard menu list with several configured dashboards.
Dashboard menu list while the admin dashboard is still in configuration mode.
Dashboard Management Console
The Dashboard Management Console is available in the Dashboard dropdown menu list.
The admin user can enable or disable this functionality for users via the Administration Tool > Dashboards configuration tool.
The Dashboard Management Console allows users to perform a range of management tasks on their dashboards from the Dashboard Configuration section.
The Dashboard Management Console also provides an option and launcher for rotating the dashboard view in the Dashboard Configuration section.
Selecting Dashboard Manager to navigate to the Dashboard Management Console.
Dashboard Management Console with the default admin dashboard.
Dashboard Management Console – Start Dashboard Rotation
The Start Dashboard Rotation section can be used to trigger a rotating view of the dashboards.
It has been observed that rotating through the dashboards at a high frequency (less than 10 seconds) may have an impact on the client browser. If the browser appears to have problems it is recommended to have the rotations at least 10 or more seconds apart, or to try a different browser.
The rotating view can be exited:
- By pressing the "Back" button on the browser
- By explicitly selecting a different dashboard or a different console from the menu lists at the top of the page (if not in "Hide Headings" mode).
The rotate will cycle through all dashboards in the Active Dashboards list in order from top to bottom.
The Start Dashboard Rotation section.
If the Hide Headings checkbox has been selected, a narrow bar will replace the usual Statseeker header when viewing the rotating dashboards. This presents a cleaner view and means there is no ability to navigate to other dashboards or consoles until exiting the rotating view. The easiest way to exit the rotating view is to use the browsers back button.
The default admin dashboard when in the rotating view mode with "Hide Headings" checked.
Dashboard Management Console – Dashboard Configuration
The Dashboard Management Console – Dashboard Configuration section is broken down into 3 main parts:
- Active Dashboards list
- Inactive Dashboards list
- Control screen
This section can be used to:
- Create a new dashboard
- Reorder the list of dashboards (via drag/drop)
- Activate and deactivate dashboards (via drag/drop)
Creating a new dashboard
A new dashboard can be created by clicking the blue (+) link at the bottom of the Active Dashboards list. It should appear in the Active Dashboards list as well as the Dashboards menu list at the top of the page.
Creating a new dashboard.
Reordering the list of dashboards
The dashboard order can be changed by dragging/dropping the dashboards in the Active Dashboards list. Re-ordering the dashboards will also change the order they are displayed in the Dashboards menu list at the top of the page.
Note: the order of the dashboards in the Inactive Dashboards list is not saved.
The first dashboard in the Active Dashboards list will by default become the dashboard displayed when logging in to Statseeker.
- Select the dashboard
- With the mouse button pressed, drag the dashboard into the desired position
- Let go of the mouse button
Re-order the dashboards via drag and drop.
Activating and deactivating dashboards
A dashboard can be activated or deactivated by dragging/dropping the dashboards between the Active Dashboards list and the Inactive Dashboards list.
Dashboards that appear in the Active Dashboard list are "active". An active dashboard:
- Will appear in the Dashboard menu list at the top of the page
- Can be viewed via links or bookmarks
- Will have dashlet data generated for it
An inactive dashboard can be reactivated at any time in the future, but will not use resources while in the inactive state.
Make a dashboard inactive via drag and drop.
Dashboard Management Console – Control
The Dashboard Configuration – Control section provides more granular control over each dashboard.
A preview of each dashboard is generated to make it easier to identify the desired dashboard.
To control a dashboard, first select the desired dashboard by clicking on the relevant dashboard in the Active Dashboards or Inactive Dashboards lists.
For each created dashboard the user can:
- View the dashboard (links to the view for that dashboard)
- Clone a dashboard (creates a new dashboard in the Active Dashboards or Inactive Dashboards list)
- Configure the dashboard (links to the configuration screen for that dashboard)
- Delete a dashboard
- Rename a dashboard
- Disable/Enable the dashboard (will move the dashboard between the Active Dashboards and Inactive Dashboards lists)
Control section with the admin dashboard selected.
View a dashboard
Viewing a dashboard will switch to the selected dashboard. This is the same behaviour as selecting the dashboard from the Dashboards menu list at the top of the page.
Note: inactive dashboards cannot be viewed without first being made active.
Clone a dashboard
Cloning a dashboard will create a new dashboard based on the currently selected dashboard. It will be identical except for the name. The cloned dashboard name is derived from the currently selected dashboards name. It is suggested that the new dashboard is renamed at the first convenience.
The cloned dashboard will be created within the same list (ie Active or Inactive) as the currently selected dashboard.
Once created, the cloned dashboard is highlighted, meaning that the Control section is now focused and working on the cloned dashboard.
Admin dashboard selected before selecting "Clone".
After pressing "Clone", the new dashboard is created in the Active Dashboards list and the Cloned dashboard is now selected.
Configuration a dashboard will switch to the configuration screen for the selected dashboard.
While a dashboard is being configured, navigation is still possible using the Dashboard menu list at the top of the page.
For information on how to configure a dashboard see the Configure a Dashboard section.
Delete a dashboard
When deleting a dashboard you are presented with a popup warning confirming the action of deletion. Please beware that once a dashboard has been deleted there is no mechanism to restore the deleted dashboard from the Dashboard manager.
Before deleting the dashboard "admin_clone_0″.
The browser will present a confirmation dialog.
After deleting the dashboard it is completely removed.
Rename a dashboard
Renaming a dashboard will change the name that is used to refer to the dashboard, and the name that is presented when viewing the dashboard. The name must be unique and not conflict with any other dashboard names relating to the user. Note: renaming a dashboard will break any URL links to that dashboard.
The following restrictions apply to dashboard names:
- Cannot start with a number
- Cannot be empty
- Allowed characters:
– US-ASCII Alpha-Numeric characters ( a-z , A-Z and 0-9 )
– The characters -_ .^=+%
Dashboards are referred to in URL links via name. If the name is changed any previous links to that dashboard (including in the history list) will instead go to the NIM Console. The dashboard name should not be changed while it is being configured.
Before renaming the admin_clone_0 dashboard.
Renaming the dashboard to "Servers".
Once the rename is complete the name is changed in the Active Dashboards list, the Dashboards menu list and in the Control section.
Note: Renaming a dashboard to an already existing name is allowed, however it will overwrite the existing dashboard configuration with that same name.
Enabling/Disabling a dashboard
Enabling/Disabling a dashboard will move it between the Active Dashboards list and the Inactive Dashboards list.
If an inactive dashboard is made active it will appear at the bottom of the Active Dashboards list, and not in the position previously held by that dashboard.
If the drag-drop functionality for a browser is broken, this is the only mechanism that can be used to re-order the dashboards in the Active Dashboards list. To do this, select each dashboard in the order you want them to appear and select "Disable" then "Enable". This will gradually shuffle them into the desired order.
Servers dashboard before pressing Disable.
After Disabling, the Servers handle has moved to the Inactive Dashboards list. The Disabled button is now labelled Enable.
Configuring a Dashboard
A blank dashboard when configuring a dashboard for the first time.
This options helps to view the effects of small changes. To view the changes press Save progress, then navigate to the view of the dashboard. To configure again, navigate back to the configuration screen via the Dashboard menu list at the top of the page. While this allows quick changes to be viewed, it is not a preview as the changes are actually saved and there is no way to cancel changes.
If the browser is resized while away from the Configure: dash screen the grid resize buttons will be collapsed into the corner.
The work around is to resize the window again when on the Configure: dash screen. This will cause the grid resize buttons return to their appropriate position.
Saving the progress and viewing the result without closing the configuration screen.
Save and Close
This will save the dashboard and exit the Configuration screen and return the user to the Dashboard Management Console screen.
This will cancel any changes since the last saved change and exit the Configuration screen and return the user to the Dashboard Management Console screen.
This will affect the resolution of the grid that the dashlets are created on.
Tip: If working with a very fine grid and small dashlets, it can be easy to extend the grid size while configuring, and then reduce the grid size just before saving.
If the max grid size is used there are issues when creating, moving and resizing dashlets.
The work around is to either avoid using the max grid size, or to reduce the grid size while configuring items.
A 4×3 grid when the grid size is changed.
Fixed Grid Size
By default the dashlets will resize when the browser window resizes. Most dashlets have been designed to automatically fill the size of the dashlets.
However, sometimes dashlets that will comfortably fit the content on a large display will not resize nicely the the browser window is made smaller. Also sometimes there is a desire to have more control over the exact size of the dashlet.
Without selecting Fixed Grid Size, resizing the browser window will cause the size of the dashlet to change.
With Fixed Grid Size selected, resizing the browser window will not cause the size of the dashlet to change.
Dashlets are created on a grid which determines their position and size. Some properties about the grid can be changed such as:
- Whether the points stretch or are fixed
- The distance between each grid point
- The number of grid points
Adding grid rows and columns
The grid can be resized in order to create more dashlets. Resize by clicking the green/red arrows in any direction.
Click the arrow button to add a new row of grid points.
A new row of grid points is created.
To create a dashlet:
- Press the mouse button down while on a + symbol
- Drag the box to the desired size
- Release the mouse button
Creating a dashlet.
To move a dashlet:
- Hold the mouse button down anywhere in the background of a dashlet
- Drag the box into the desired position
- Release the mouse button
Moving a dashlet.
To resize a dashlet:
- Hold the mouse button down while over the blue border to resize the dashlet
- Drag the box into the desired dimension
- Release the mouse button
Resizing a dashlet.
If attempting to create/move/resize to an invalid position the covering box will appear red:
Attempting to move to an invalid position.
Configuring a dashlet
To configure a dashlet:
- Click Configure
- Select the type of dashlet
- Set the desired options. Most dashlets will include at least:
– Group list
- Click Done
- Save the dashboard
Example: Interface Performance Metric Dashlet for group Athens
Choose Interface Performance Metrics > Bar Graph: Single Range.
Select the following options and then press Done:
Save and then view the dashboard:
Admin Tool – Dashboard Configuration
Dashboard settings can be configured for users by the admin user using the Dashboards section of the Administration Tool.
Navigate to the Administration Tool > Reporting/Scheduling > Dashboards
The user configuration screen.
Global settings and User Overrides
Each configuration item set in the Global Settings section will apply to any user that has the “Use global default” option set for that item.
By default, users will have Use global default set for all items, meaning they will use the global settings. The exception is the admin user which has the NIM Console Default option set to Advanced Console by default.
The global settings can be overridden to apply different options to different users. This can be done one user at a time, or changes can be made to several users at the same time by selecting multiple users before applying the change.
When multiple users are selected, the "– keep current –" option can be selected to avoid making a configuration change for that item. This will be selected automatically if the option for the selected users for that item is different.
The below example shows changing some settings for admin, qa and Thanuja user. Note: the ‘NIM Console Default’ which is currently different for all the users, and because ‘– keep current –’ is set this option will not be changed.
No changes will take effect until the Save button is pressed. When the save is successful a message is returned indicating that the changes were made.
Press the Save button to apply changes.
The message returned indicated that the changes were successfully applied.
If the dashboards are disabled for a user, then the dashboard menu item will not be visible for that user. Also, viewing dashboards through a URL bookmark link will not work.
The dashboard data generation will still occur on the back end for Active dashboards even if the user does not have front end access. It is advised to disable all the users dashboards before disabling the displaying of the Dashboards TAB for that user.
The Dashboard menu list is available when dashboards are enabled.
The dashboard menu list is not available when the Dashboards TAB has been disabled.
Custom Reporting Console
This option enables or disables access to the Custom Reporting Console. Users will still be able to view any custom reports that are available in the NIM Console, however they will not be able to configure any new reports or edit existing custom reports.
NIM Console with the Dashboards TAB disabled but with the Custom Reporting Console enabled.
With both dashboards and the Custom Reporting Console disabled, only the NIM Console is displayed. This is the traditional Statseeker view.
This enables or disables the Dashboard Manager for the user. If the Dashboard Manager is disabled the user will still be able to view existing dashboards but will not be able to add any new dashboards or configure any existing dashboards.
Disabling the Dashboard Manager will also disable the rotating dashboards launcher. The rotating feature can still be activated by adding the fullscreen=1&rotate=10 to the browser URL (prepend before the hash mark in the URL).
Dashboards menu list with the Dashboard Manager available.
Dashboards menu list with the Dashboard Manager disabled.
This option determines which screen is presented to the user as the default landing page.
If this is set to show the first available dashboard but a user has no Dashboards configured they will be redirected to the NIM Console instead.
The landing page when showing the first available dashboard.
The landing page when NIM Console is selected.
NIM Console Default
The NIM Console has two views which can be toggled by selecting the Standard Console / Advanced Console buttons from within the console.
This option selects which view a user is presented with by default.
NIM Console Advanced Console – this is set as the default for the admin user.
NIM Console – Standard Console.
Admin Tool – Dashboard Copy to other User
This primary function is to allow a dashboard from any user to be copied to any other user. There are some additional extended features that make it useful for managing users dashboards without directly using the Dashboard manager. There are however a few limitations, which are highlighted below.
Currently it is fairly easy to:
- Copy one or many users dashboard to one or many other users
- Clone a set of dashboards by removing all users dashboards before performing the copy
The current functionality is unable to:
- Change the order of a users dashboards
- Change the active/inactive state of users dashboards
- Delete all of a users dashboards
- Directly configure users dashboards
The above features can be worked around to some extend by:
- Copying all of the users dashboards to the admin user
- Perform re-arranging, enabling/disabling, configuration via the admin users Dashboard Management Console
- Copy the dashboards back to the user while selecting: Delete users existing dashboards before performing copy
Note: dashboards can be deleted by simply not copying them back. However, it is currently impossible to delete all dashboards. A workaround might be to copy a single dashboard that is in the disabled state.
In Delete Existing option if you set ‘Remove users existing dashboards’ and then change back to ‘Keep users existing dashboards’ the copy will still proceed to remove users existing dashboards.
The only work around at this stage is to refresh the browser window and do not change the selected options in ‘Delete Existing’. Always check and verify the informational messages before confirming the copy.
Dashboard Copy Utility.
Errors and Warnings
When copying a dashboard to another user it is important to check that the target user has access to all of the required groups, timefilter favourites, SLA’s etc. that are used by the dashboard. If they do not have this access then the dashboard may contain dashlets with no information being returned. An error will be returned when attempting to copy a dashboard if this scenario is detected.
If a user does not have access to a report that is used by the drilldowns then the dashboards may not be as useful. If this is detected a warning is given.
It is recommended that the copy process does not proceed until all ERROR messages have been resolved.
It is also recommended that all WARNING messages be resolved, but at the least they should be understood and the consequences (eg. no drilldowns) deemed acceptable.
INFO messages are not harmful but provide information on what will occur when the copy takes place, including if any files will be removed, overwritten or renamed.
Error and Warning messages when attempting to copy a dashboard.
The dashboard copy function is categorized into 3 main sections:
- Copy To Users
The objective is to:
- Select one or more user dashboards to be copied
- Select one or more users
- Select the options that will control what happens in the copy process
- Press the Copy button
- Stop if there are any ERROR or WARNING messages. Read and review all of the informational messages
- Press Copy to confirm the copy
Copying dashboards Servers and Brisbane Devices from user admin to user qa and John.
Copy to Section
This will determine whether the dashboards will be active of inactive when copied to the user.
The options are:
- Keep the same section
- Copy to the users ‘Active’ section
- Copy to the users ‘Inactive’ section
Some situations where these options might be useful:
- A user has a selection of dashboards with some in the active state and some in the inactive state and there is a desire to "clone" this selection of dashboards to another user. Use Keep the same section.
- A user does not have access to the Dashboard Manager. The admin user selects a series of common dashboards to allocate to the user which are in the inactive state, but wishes these to be active for the user. Use Copy to the users ‘Active’ section.
- The admin user wants to publish a series of common dashboards to various users but allow the users the control over what they want to view. So they are copied to the disabled section with the idea that users can enable the ones they want. Use Copy to the users ‘Inactive’ section.
If selected a users dashboard settings and all current dashboards will be deleted before performing the copy.
The options are:
- Keep users existing dashboards
- Delete users existing dashboards before performing copy
Some situations where these options might be useful:
- Users manage their own dashboards. The admin user has an interesting dashboard they want to make available to these users. Use Keep users existing dashboards.
- Some users do not have access to the dashboard manager. Instead the admin user maintains a set of dashboards and pushes any changes to these users. Use Delete users existing dashboards.
This determine what happens when copying a dashboard if the user already has a dashboard with the same name.
The options are:
- Do not copy if name conflicts
- Overwrite users dashboards if name conflicts
- Rename the new copy if name conflicts
- Rename the users dashboard if name conflicts
Some situations where these options might be useful:
- There is a nice-to-have dashboard that the admin wishes to copy to many users. It had been shared previously to some users and those users may have made their own local modifications. Use Do not copy if name conflicts.
- Some dashboards are managed by the admin user and pushed to users. It is understood that there should be no local changes to these dashboards and the desire is to have a consistent dashboard across many users and without many versions of the dashboard. Use Overwrite users dashboards if name conflicts.
- There is a nice-to-have dashboard that the admin wishes to share and has not previously been shared with those users. The admin user does not want to disrupt any users set-up if they have coincidentally named a dashboard with the same name. Use Rename the new copy if name conflicts.
- There is an important dashboard that the admin wishes to share and it makes sense that the dashboard has the same name for all users (for example because it may be overwritten in the future when updated or even just for consistency). Use Rename the users dashboard if name conflicts.