Adding a Report

Navigation:  Managing the Account > Business Analytics > Reporting >

Adding a Report

 Previous pageReturn to chapter overviewNext page

 

Overview

 

Reports provide device-specific information (= software, hardware and system data) as well as details on MCL-Mobility Platform entities such as Sites, Device Groups, Operator Groups. The returned data is listed  and displayed for viewing and analysis.

 

Reports are ONLY created at account level. Site users can view and export the provided data for analysis but NOT create their own reports.

 

Reports are always based on a report template - MCL-Mobility Platform provides a list of report templates that return specific information. The available report templates are categorized into "Masterdata" (= reports return static data related to the account's entities), "DeviceStatus" (reports return dynamic data that are constantly updated due to the generated business data/account activity) and "Operational" (reports provide dynamic operational data from "enabled" devices).

For more details on each report template, check our MCL Knowledge Base for the corresponding article - "Reporting Service's Report Templates". (You must register/log in to access this article.)

 

Choose the template that best suits your needs as a basis for your reports.

 

Each report template includes specific parameters which you can attribute values to so that the returned data can be filtered. For instance, if you choose the "Device List - System" report template as the basis for your report, you can set values for the parameters so that the report only returns device related info for the devices of a specific site or specific device group instead of returning data on all the account's devices.

 

 

Step-by-step

 

1. Access the "Report Management" page (Admin Dashboard > Control Panel > Business Analytics module > Reporting sub-module > Report Management page).

 

Reports_Main Page_AD

 

2. Click Add Button_Header  and, in the resulting page (which opens in edit mode) fill in the editable fields in the tabs.

 

New Report_Details Page

 

hmtoggle_plus1"Report Properties" tab

 

Template *

Select the template that will be the basis for your report from the drop-down OR  click Report Select a_Button to open the "Select a Template" pop-up window and select one of the listed templates.

See Details on the "Select <entity>" window.

 

If the selected template has more than one version, you can choose the preferred version in the related drop-down.

 

NoteSome templates have more than one version. The difference between versions is mainly related to the available fields/parameters.

We recommend you verify the template version's available fields/parameters to make sure the version you select will return the data you need.

Name *

There is a suggestion based on the name of the selected template but we recommend you define a report name that provides some context to the displayed information.

Description

The box already includes the selected templates default description but you can edit and/or add relevant information on the report.

Title

Define a title for the new report to be displayed in the "Data" section along with the returned data (section to the right). We recommend you define a title that relates to the purpose/values you want to display.

 

hmtoggle_plus1"Parameters" tab

 

The available parameters depend on the selected report template's version.

 

If the selected report template does not require the setup of parameters (ex: the "Site List" template), the "Parameters" tab will not be active.

 

Example of a "Parameters" tab associated to the "Device List - Config" report template:

 

Report Details_Page_Parameters Tab_B

 

Site

Limit the returned data to a specific site. Select it from the drop-down or the site list that opens when clicking Report Select a_Button.

 

Selecting "<All>" means the scope of the returned data includes all the account's sites.

Device Group

Restrict the returned data to a specific device group. Select a device group from the drop-down or the device group list that opens when clicking Report Select a_Button.

 

"<All>" means the scope of the returned data includes all the device groups of a specified site or the account (it depends on the value set in the "Site" parameter).

Status

Filter the returned data by entity status, in this case, by device status. Select a status from the drop-down.

 

Selecting "<All"> means the status of the source entity for the returned data will not matter. If, for instance, you select the "Disabled" status, the report will only include data about entities with that status.

 

Use the Apply button Reports button to apply the defined parameter values, temporarily. This allows you to, immediately, check the resulting filtered display in the "Data" section. Be aware that the defined parameter values will NOT be saved for this report, if you use this option.

 

To definitively save the parameter values you set up and make them a part of the report, you must click Save Button_Header .

 

 

3. Click Save Button_Header to conclude the new report.

 

 

hmtoggle_plus1 Details on the "Select <Entity>" window Report Select a_Button

 

The content of this window is context-based. It opens when pressing the Report Select a_Button button and it provides info/options depending on the option it is associated to.

For instance, if this button is attached to the "Template" option ("Report Properties" tab), it will be named "Select a Template" and provide a list of the available report templates. If Report Select a_Button appears next to the "Site" option ("Parameters" tab), the resulting window becomes "Select a Site" and it will provide a list of the available sites.

 

Example:

 

Select a Template1

 

Potential Operations/Options:

 

The availability of these options depends on the context associated to this window.

 

•Use the search box to look for specific list items.

 

•Configuration Button ReportsOpens a pop-up window where you can define which table columns should be displayed.

Click Configuration Button Reports again to hide the list.

 

•Download List_Button Downloads the displayed list in an Excel file format.

 

•Refresh_Button Refreshes the window's information.