Creating Custom Dashboards

SapphireIMS has a number of in-built dashboard widgets using which the dashboard can be configured. While the Dashboard is accessible from the Service Desk module, it has widgets for other modules as well. Appropriate widgets can be selected such that the dashboard gives a complete view across all IT functionality including Service Desk, Asset Management, Inventory and Automation and Monitoring.

Custom role based dashboards can also be created with new widgets. This topic provides the details on creating new widgets.

Creating Custom Widgets

Click on on the Dashboard Customization screen to add a widget or click on on the widget to edit the widget. The Widget Builder screen is displayed.

The fields are described in the table below.

Note: Wherever queries need to be configured, please contact SapphireIMS Support to obtain the queries since it needs internal product knowledge.

Serial. No	Field	Description
1	Widget Name	Enter a name for the widget
2	Template	Select a 'Template' among the list displayed. Commonly used templates are among the following: Card View - Displays a single Key Performance Indicator of interest Charts - Displays data in chart format Percentage and Value Based - Displays percentages Quick Stats - Comparison view of statistics Each template has a number of parameters which need to be configured.
3	Users	Select the 'Users' for whom this widget should be displayed.
4	Roles	Select the 'Roles' for whom this widget should be displayed.
5	Data Template	Select the 'Data Template' to be used to populate the data in the template. There are some in-built Data Templates available. The Data Templates are MySQL queries which are executed to retrieve the data. You can search for the template by typing in the name partially or fully in the search box. If a Data Template is not available, you can create a new Data Template. To add a new Data Template click on the + button. Enter the 'Template Name'. Enter a 'Query' to fetch the data to be displayed on the widget. There is a facility to drill down on the dashboard data where on click of the widget a redirection the drilled down data is displayed on a redirected page. This feature is available only for the Card View, Percentage Fill, Iconized View, Percentage and Value Based, Detailed View, Threshold Monitoring and Charts widgets. There are two options. 'Redirect to link URL' and 'Redirect to record(s)'. If 'Redirect to link URL' is selected, then enter the URL for redirection on clicking on the widget for more details. If 'Redirect to record(s)' is selected, then the following configuration needs to be done. A 'Redirection query' has to be specified which retrieves the records as per the query. While forming the query, macros can be defined and the values can either be hard coded or dynamically obtained by means of a query. Click on 'Add' to add the query after entering. Once the template is saved, to edit the Data Template, click on the edit button.
6	Filters	Select the 'Filter' to be used for filtering the data. There are some in-built Filters available. The Filters are MySQL queries which are executed to retrieve the data. You can add a new Filter by clicking on +. Enter a 'Filter Name'. Select the 'Filter Style'. Check the box 'Is Multi Select' if it is a multi select filter. Enter the 'Parameter Name' on which to filter, the 'Macro Name' and the 'Query'.
7	Widget Size	Select the 'Widget Size' between 'Small' and 'Medium'.
8	Lowest Value, Highest Value	Some of the widgets like Threshold Monitoring and Comparative Status allow indication of the trend using down arrow and up arrow and which can be red or green colors.
9	Background Color	Select the background color of the widget. You can create a new color by clicking on . Either enter the color code in RGB format as a hexadecimal string prefixed by # or choose a color from the picker. Click on 'Add' to add the color to the list.
10	Chart Type, Axis, Series, Colors	In the case of Chart widget, you can select the 'Chart type', the 'X-axis Name', the 'Y-axis Name', 'Series Type' and the 'Colors' for the element of chart.
11	Publish Dashboard	You can select the Dashboard to which the widget has to be published. If these fields are left blank, the widget is displayed on the 'Main Dashboard' by default and the name of the widget is displayed on the widget. 'Publish To': Select the Dashboard in which the widget has to be displayed 'Publish As': Enter the name which will be displayed on the widget. You can add a new Dashboard by clicking on . The following has to be entered for adding a new Dashboard. 'Dashboard Name': Enter the name of the Dashboard 'Access To': Select the roles for which access has to be provided for this Dashboard. Click on 'Add' to add the new Dashboard. Once the Dashboard is selected, you can also edit or delete the Dashboard using the icons which appear. Note: The new widget has to be included in the Dashboard configuration before it is displayed in the new Dashboard.

After entering all the fields click on 'Save'.

Adding Quick Link and Quick View Widgets

The purpose of these Widget types is to navigate to any part of the Service Desk quickly. The widget addition screen is shown below.

The initial fields are the same as for any other widget.
Click on next to the Data Template selection.
Enter the 'Template Name'.
From the 'Link Templates' list, select the Template to use.
Enter the 'Name' of the link.
Click on next to the 'Link Templates' field to copy the link.
Paste the link in the box 'Link' by typing CTRL+V. Hover on the icon to get the macros to be replaced with the actual values. For example, 'goToQuickTemplate(MACRO_QUICKTEMPLATEID,MACRO_PROJECTID)' is the link which is created. On replacing the macros it could look like 'goToQuickTemplate(1,6)' where the Quick Template ID is 1 and the Project ID is 6. You can contact SapphireIMS Support for getting these IDs.
In the case of Quick View widget, instead of links, icons can be configured to select any link for redirection.