|
Report Details |
  
|
Report Details
|
Report Details |
|
Overview
A Report provides information on a variety of MCL-Mobility Platform entities - devices, sites, operator groups, device groups, etc.
Each report is based on a report template and returns entity-specific data.
You can open a page that displays the report's returned information - a report view page - and you can open its details page to edit its settings.
See Report View Page below and Report Details Page.
Report View Page
This page allows you to view the report's returned data, view its parameters and temporarily edit them (if they are editable) and export the data.
Use the 
button (in the Admin Dashboard's "Control Panel") to access the "Reporting" sub-module.
Click 
.
In the resulting "Reports" page, click the name of the intended report (displayed in light blue) to open the corresponding Report View page.
This page includes 2 sections, a "Data" section which is open by default and a "Parameters" section (hidden to the left) that can be expanded, if necessary.
This section displays the data returned by the selected report which is aggregated according to its defined parameters (you can expand the "Parameters" section to check which parameters, if any, have been set for the current report).
This section provides the report's internal reference (ex: "REP-1"), the report's title (ex: "Configuration per Device") and a table with the data that is meant to be returned by the selected report.
Ex: This report is based on the report template "Device List - Config" - it is meant to return a device's configuration related data so the table is made up of columns that convey that type of information ("Device Ref.", "Device SSN", "Device Name", "Device Status", "Device Type", "Site Ref.", "Site Name", "Device Group Ref.", etc.).
If you mouse over the 
icon next to the report's title, you get the content of the report's "Description" field. This field is available in the report's details page. See Report Details Page.
This section is hidden by default. You must click 
(upper left corner) to expand the section.
This section displays the parameters associated to the current report.
Ex: Since this report is based on the report template "Device List - Config", it is possible to define a specific site, device group and/or device status to restrict the returned device related information. In this case, there are no specific values defined for this report's parameters - the displayed list includes all the devices paired to the account.
If one or more parameters of the selected report are set as editable (you can define which parameters can be edited in the report's details page), you can temporarily edit the parameters in this section.
•Open the drop-down, when available, and select a listed element.
•Use the 
button, when available, to open the corresponding list and select an item.
•If there is a icon, you can mouse over it to check its information.
Example of available Parameters:
Site |
Limit the returned data to a specific site by selecting it from the site list provided by the drop-down. As an alternative, click
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. As an alternative, click
Keeping option "<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 status. Select a status from the drop-down.
If you select "<All">, 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. |
To apply the new parameter values and view the filtered data in the "Data" section, click the 
button.
This parameter edition is NOT permanent. It ONLY lasts while this page is open. To apply a permanent change, access the report's details page and save your edition there.
Mouse over the on the right of the status field to see details on the field. This info is from the chosen template.
This page is where you define/edit the report's settings.
In the Admin Dashboard's "Control Panel", click and, then, .
This opens a page with the available reports.
Select the report whose settings you want to view by checking the corresponding 
and click 
. This opens the selected report's details page.
This page is divided into the "Report Properties" and "Parameters" tabs and a "Data" section.
It is always set to edit mode to allow you to change its properties and/or parameter values.
The "Report Properties" tab allows you to:
•choose the report template that will be the basis for your report;
•define a name for the report and a report title to be displayed in the "Data" section;
•enter a description for the report.
This tab includes the parameters compatible with the report template you have chosen.
For instance, if the report template is meant to return device data, this tab is likely to provide the "Site", "Device Group" and "Status" parameters. If you set values for those parameters, it will filter the report's returned data.
You can define parameter values for your report and, also, set them as editable so that any user that accesses the Report View page for this report can edit them in that page, if required.
Mandatory parameters, are marked with an asterisk (*).
For more detailed information on the editing of these tabs, see Editing a Report.
To permanently apply your edition, click 
. To close the page without saving any changes, select 
.
"Data" section
This section, located to the right of the page, displays the data returned by the current report.
You can control the data display, refresh and export the report's data.
See Available Operations below for more details.
•Use the and 
arrows (top of the page) to expand and collapse tab area.
•
Use the search box to look for specific listed elements.
a. Enter what you want to search for.
b. Click 
or press <ENTER> in your PC keyboard to initiate the search.
c. Use one of the following to clean the searched data to start a new search or return to a full view:
▪empty the search box and click ;
▪empty the search box and press <ENTER> in your PC keyboard;
▪click the 
button.
•Use 
to show/hide report columns. The listed columns depend on the report type/data it is meant to return.
a. Click (located on the upper right corner) to access the list of available columns.
b. Select the column(s) to be shown by clicking the corresponding .
c. Click to hide the list again and apply your changes.
•Click 
to export a "*.csv" file with the report's returned data.
Since the export ONLY includes the currently displayed information, make sure the page contains the intended columns/data before you begin the export. Click to open a list with the report's existing columns and make sure the required columns are selected. Once you are done checking the columns you need, click again to close the list.
a. Click and 
in the resulting pop-up window.
An "MP_<report name>_<time stamp>.report.csv" file is, automatically, generated (ex. "MP_Devicelist config v1_211210112045.report.csv").
b. Conclude the export operation by saving the Excel file in your PC - select the intended PC location from the OS browse window and save it.
•Click 
to refresh the data display of the "Data" section.
