ServicePilot SaaS Documentation

Reporting

What are Dashboards?

Tiled layout of widgets, each of which presents a different view of the collected data

Dashboards of data are made available to extract, collate and highlight statistics captured. Dashboards might present a summary of the environment for all elements of the same package or detailed statistics for a particular monitored element. There are four types of dashboard:

Type Description
Global Overview dashboards, summarizing the status of an aspect of the supervision. For Example: A summary of the availability and performance of all monitored components or a table counting the number of objects by object class.
Package Per package summary dashboards. These dashboards provide statistics for all resources of the same type. For Example: A summary of all Windows Servers, listing those that have the highest CPU, Memory and Disk usage.
Resource A per resource dashboard. These dashboards collate information from just one resource, highlighting important statistics based on the resource type. For Example: A network router will have a dashboard detailing the important statistics for this particular router.
Custom Custom dashboards may be created by users to include any widgets they are interested in. Administrative users can see all custom dashboards and can make a Custom dashboard available to all users.

Create a custom dashboard

All users may create their own custom dashboards by building on an existing dashboard or starting from a clean slate.

  1. Click on the Dashboards menu item. Dashboards menu item
  2. Click on the + button to add or edit dashboard templates. Edit custom dashboards button
  3. Either add a new dashboard with the + Add a dashboard button or use the blue pencil icon to edit an existing dashboard.

Add widgets to a dashboard

New widgets are added to the dashboard by dragging the icon representing the new widget types to include. Before letting go, make sure that a purple highlight appears to indicate where the new widget will be placed.

Add widget buttons

Widget Type Use
Title or text Include a title or text widget. Remember to complete the title and text fields in all languages used. If the Iterations checkbox is checked then this title becomes a header that is repeated multiple times based on the Query field. {resource}, {object} or {view} variables may then be used in the title. The end of the section is defined by the next title at the same level.
JSON widget definition Widgets are defined in terms of parameters in a JSON formatted document. You may extract the JSON definition of any existing widget using the copy button on the existing widget and paste the text here.
Select existing widget Existing widgets from built-in dashboards or custom dashboards can be selected and re-used.
Map A widget showing the current state of a particular view in the view hierarchy.
HTML and metadata A widget containing valid HTML text, pictures and metadata.
Web page A widget containing a web page, embedded into the dashboard as an iFrame. The content may be auto-refreshed at a defined interval.
Live Ping A widget that will ping an IP address every couple of seconds and display the latency graph.

Edit dashboard widget parameters

Depending on the type of widget to be modified, some editing buttons will appear to the right of the widget title. Note: The buttons only appear when the mouse is moved over the widget title.

Edit widget buttons

Widget buttons Use
<- Move the widget to the left. By using this action on a widget in the third column, it will move into the second column along with the existing widget. In this way it is possible to stack multiple widgets in one column against only one widget in another column.
View type The queries behind some widgets are broad enough to allow the data to be presented in different ways using the existing query. The view type can be changed in this case.
Export to CSV Export the raw data used to display the graph to a comma separated value (CSV) file.
Hide/Show Roll-up or Unroll the widget to just the title.
Widget pop-up Show widget content in a pop-up dialog box taking up more of the screen. This is useful to see larger views on more complex graphs.
Refresh Refresh the content of just this widget.
Copy widget definition Copy the JSON widget definition to the clipboard so that it may be viewed or re-imported as another widget.
Edit Edit widget parameters. Depending on the widget type, the content of this dialog will differ. A second dialog might be shown after editing the widget definition to set the widget title.
Delete Remove the widget from the dashboard. Note: If a widget is deleted by mistake, do not save the dashboard. Instead re-load the dashboard and make the correct changes.

Custom dashboard parameters

Custom dashboard parameters can be accessed using the Parameters button.

Dashboard Parameters button

Administrative users may set a dashboard as being available to a number of groups of users. Multiple groups can be selected using the standard shift or control meta-characters.

What are Reports?

PDF Reports present the same widget data as dashboards on the screen, except that they output this as PDF. Reports may be generated in a number of ways:

  • From dashboard content - when viewing a dashboard
  • When required - based on a report template
  • Scheduled - from a report template to be stored or sent by email

Export dashboard as PDF

When viewing any dashboard, click on the PDF on-the-fly button to generate a PDF report with the same content.

Generate PDF from dashboard button

Create a Report template

A PDF report template is required to generate a report if it will not be generated on-the-fly from a dashboard. ServicePilot provides some sample templates but these might be customized by cloning their definitions and making changes. It is also possible to start a report template from scratch.

  1. Using a user with administrative privileges, log in to ServicePilot.
  2. Open configuration Configuration icon
  3. Navigate to Edit PDF reportsEdit PDF reports menu item
  4. Select a unique report template name and specify if you wish to start from a blank report or an existing report template
  5. Once the report template has been added to the configuration it can be edited using the blue pencil icon

Add widgets to a report template

New widgets are added to report templates by dragging the icon representing the new widget types to include. Before letting go, make sure that a purple highlight appears to indicate where the new widget will be placed.

Add widget buttons

Widget Type Use
Title or text Include a title or text widget. Remember to complete the title and text fields in all languages used. If the Iterations checkbox is checked then this title becomes a header that is repeated multiple times based on the Query field. {resource}, {object} or {view} variables may then be used in the title. The end of the section is defined by the next title at the same level.
JSON widget definition Widgets are defined in terms of parameters in a JSON formatted document. You may extract the JSON definition of any existing widget using the copy button on the existing widget and paste the text here.
Select existing widget Existing widgets from built-in dashboards or custom dashboards can be selected and re-used.
Map A widget showing the current state of a particular view in the view hierarchy.
HTML and metadata A widget containing valid HTML text, pictures and metadata.
Page break Add a page break.

Edit report template widget parameters

Widget parameters are common between the report template widgets and the dashboard widgets. See the Edit dashboard widget parameters section for details.

Custom report template parameters

The report template name and description can be modified using the the Parameters button.

Report template Parameters button

Scheduling reports

Scheduling a report to be generated every day, week, month, etc allows for the ServicePilot data to be distributed to people who would not normally use the monitoring tool's web interface.

  1. Using a user with administrative privileges, log in to ServicePilot.
  2. Open configuration Configuration icon
  3. Navigate to Schedule a reportSchedule a report menu item
  4. Either add a new report with the + Add a scheduled report button or use the blue pencil icon to edit an existing report schedule. Schedule a report menu item
  5. Select a unique report name and complete the report settings before clicking on OK
Report setting Use
Template Select a report template
Generation frequency Specify the frequency at which the report will be generated. If Manual generation is selected, then the report will not be generated on a schedule but will be available to be generated as needed from the Reports icon. Reports generation times are based on the ServicePilot server's local French time zone.
Layout settings Indicate the page format to use and if a table of content is to be added.
Content The Security group and High level view limit the results returned in the report to what users of the group have access to. The Content timeframe sets the time span over which data will be returned. This can be further filtered by a Time period filter that can limit results to open hours only. This is useful when the report should only include availability, performance and alert details for service level agreement monitoring that exclude scheduled maintenance periods.
Localization settings Set the report language, number format and time zone over which the data will be presented.
Email settings If the report is scheduled, it may be sent to a comma separated list of email addresses. The email Subject and Email body fields may contain {FREQUENCY}, {PERIOD}, {REPORTNAME} and {PDFNAME} variables.

View generated PDF reports

Users may view PDF reports that were scheduled and ran. Go to PDF Reports by clicking on the reports icon.

View reports icon

Get started Now