Difference between revisions of "Reports"

From eMMS Help
Jump to navigation Jump to search
imported>Dpltech
imported>Dpltech
(Data Selection)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTITLE__
 
  
 
= Reports =
 
= Reports =
There are five ways to see your report: Standard Reports, Custom Columns Reports, Scheduled Reports, Report History, and Report Shortcuts. Selecting the Reports button at the left brings you to the Standard Reports tab by default. The other kinds are available by selecting the other tabs. Using the reporting tools, you can easily view your data in printable and exportable reporting formats.
+
Using the reporting tools, you can easily view your data in printable and exportable reporting formats. There are two types of report: Standard Reports and Custom Columns Reports. Selecting the left Reports button brings you to the Standard Reports tab by default.
  
  
 
=== Standard Reports ===
 
=== Standard Reports ===
:There are a number of pre-defined standard reports to choose from that make viewing essential data quickly and easily. Simply choose the report from the Standard Reports tab and click the View Report button.  
+
:There are a number of pre-defined standard reports to choose from that make viewing essential data quick and easy. Simply choose the report from the Standard Reports tab and click the View Report button. Some reports such as Values Report and Comm Message Count Report also provide the [[Reports#Graph Mode|Graph Mode]]. You also have the ability to schedule standard reports. See (B) Schedule of [[Reports#Custom Columns Reports|Custom Columns Reports]]. 
  
 
:[[File:StandardReports.png]]
 
:[[File:StandardReports.png]]
  
 +
=== Custom Columns Reports ===
  
=== Custom Columns Reports ===
+
Custom Columns Reports target your reporting needs more precisely than the standard reports. These report present data about equipment aggregated over time periods for a customized set columns.
  
 
:[[File:CustomColumnReports.png]]
 
:[[File:CustomColumnReports.png]]
  
:;A. New: Creates Custom Reports that target your reporting needs more precisely than that of the standard reports. This brings you to the New Report Configuration page where you can define your new custom columns report.  
+
:;A. New: Creates New Custom Report.
 
::[[File:NewCustomColumnReport.png]]
 
::[[File:NewCustomColumnReport.png]]
::Give your report a descriptive name, a DataTag and select the approproate options for your new report. Please note that in order to customize which columns appear in the report, you must select the Apply button. This saves your changes and enables the Add columns button.
+
::Give your report a descriptive name, a DataTag and select the appropriate options for your new report. Then click the Apply button. This saves your changes and enables the "Add Columns" button.
 +
 
 +
:;B. Schedule: You have the ability to schedule custom columns reports. This brings you to the Schedule Report page where you can setup the schedule and apply some further options to the report generation. Give the new Scheduled Report a name and move through the available options. You can assign the report to be generated for a particular Account, apply a Region filter and also generate the report for a certain equipment type. The remaining options define when the report will be generated, as well as generation offsets, day masks and ranges. You can also have the report be emailed to you via the email export options.
  
:;B. Schedule: You have the ability to schedule custom columns reports. This brings you to the Schedule Report page where you can setup the schedule and apply some further options to the report generation. Give the new Scheduled Report a name, and move through the available options. You can assign the report to be generated for a particular Account, apply a Region filter and also generate the report for a certain equipment type. The remainging options define when the report will be generated, as well as generation offsets, day masks and ranges. You can also have the report be emailed to you via the email export options. Please note that you should not use your cellphone email address due to the potential size of the report.  
+
::[[File:Schedule1.png]]
  
::[[File:ScheduleReport.png]]
+
::[[File:Schedule2.png]]
  
:;C. Config:
+
::[[File:Schedule3.png]]
 +
 
 +
::[[File:Schedule4.png]]
 +
 
 +
:;C. Copy: You may copy a existing custom columns report and configure it differently.
 +
 
 +
:;D. Config:
 
::[[File:ConfigCustomColumnsReport.png]]
 
::[[File:ConfigCustomColumnsReport.png]]
::Selecting the New column button brings you to the Add Report Column page. Here is where you define which column(s) will be included in the report. Give your column a name and select its type, action, field, alignment and Data Tag. You have 4 choices for Type; Machine Info, Value, Location and Alarm. Based on the Type selection, the options for Action and Field will change.
+
::Selecting the New column button brings you to the Add Report Column page. Here is where you define column(s) that will be included in the report. Give your column a name and select its type, action, field, alignment and Data Tag. You have 4 choices for Type; Machine Info, Value, Location and Alarm. Based on the Type selection, the options for Action and Field will change.
 
:::[[File:AddNewColumn.png]]
 
:::[[File:AddNewColumn.png]]
  
:;D. View Report
+
:;E. View Report
  
 +
:;F. View Graph
  
 
=== Scheduled Reports ===
 
=== Scheduled Reports ===
 
:[[File:ScheduledReports.png]]
 
:[[File:ScheduledReports.png]]
::;A. Enabled: A report will be scheduled only when it is checked.
+
::;A. Enabled: A report will be generated only when this is checked.
::;B. Suspend: A report could have been suspended by the system as there is an error. Please fix and un-Suspend.
+
::;B. Suspend: A report can be suspended by the system if an error in the configuration is detected during generation. You may change the configuration and un-suspend.
 
::;C. Config Schedule: See (B) Schedule of [[Reports#Custom Columns Reports|Custom Columns Reports]].
 
::;C. Config Schedule: See (B) Schedule of [[Reports#Custom Columns Reports|Custom Columns Reports]].
  
  
 
=== Report History ===
 
=== Report History ===
:A user can select and view a report from the Report History tab.
+
:You can view pre generated custom columns reports from the Report History tab.
 
:[[File:ReportHistory.png]]
 
:[[File:ReportHistory.png]]
  
 +
 +
=== Graph Mode ===
 +
 +
[[File:GraphReport.png]]
 +
 +
:;A. Table Mode: Switch to the Table Report View.
 +
:;B. Graph Mode: Switch to the Graph Report View.
 +
:;C. Print: Print Graph Or Save as Pdf.
 +
:;D. Data Point: To see (E) More Info, hover over a data point.
 +
:;E. More Info: Shows device info, event time, datatag, value name, value, and delta value.
 +
:;F. Legend: Show/Hide a line graph. You will notice that the Y scale is updated dynamically.
 +
:;G. Show/Hide Grid
 +
:;H. Full Y Scale Mode: The range of Y scale is rendered from minimum value to maximum value by default. A user can change it from zero to maximum value by clicking this.
 +
:;J. Paging: Move a timespan with a pagesize(I)
  
 
=== Report Shortcuts ===
 
=== Report Shortcuts ===
 
:[[File:ReportShortcuts.png]]
 
:[[File:ReportShortcuts.png]]
:A user also can select and view a report from the Report Shortcuts page. A report shortcut can be created from the expandable menu of a report as below.
+
:Report shortcuts are reports with pre-selected filters that can be created from the expandable menu of a report.
 
::[[File:ReportShortcut.png]]
 
::[[File:ReportShortcut.png]]
  
Line 51: Line 74:
 
== Advanced Filtering ==
 
== Advanced Filtering ==
  
Advanced filtering allows you to apply search filters to your data so that you can view customized, detailed, quick reports for accessing the right information at the right time.
+
Advanced filtering allows you to apply search filters to your data so that you can view customized, detailed, reports.
  
  
Line 57: Line 80:
  
 
:[[File:AdvancedFiltersOnTimelineReport.png]]
 
:[[File:AdvancedFiltersOnTimelineReport.png]]
 +
  
 
=== Equipment Selection ===
 
=== Equipment Selection ===
:You can choose to view only devices assigned to certain accounts, of particular equipment types and the devices last known equipment location.
+
:You can choose to view only equipment assigned to certain accounts, that are of particular types or that are in particular regions.
 +
 
  
 
=== Data Selection ===
 
=== Data Selection ===
:The data selection filters allow you to select as many rows as you choose and apply data specific filters to that data set. Filters include; Data locations, reason type and to prioritize active equipment. You can then sort those rows further by any viewable column in either ascending or descending order.
+
:The data selection filters allows further filtering of rows if they don't meet certain criterion. Filters include; data locations, reason, alarm tags, value tags, or action tags. You can sort rows by most viewable column in either ascending or descending order.
 +
 
 +
:If filters are changed, data will no longer reflect the current state of the filters. The Go button will be shown in orange and must be clicked to re-query the report data with the currently selected filters.
 +
 
 +
=== Region Filter Option ===
 +
:When the Regions filter is set, you have three filtering options shown below. The default is to filter equipment by verifying that their last location are in the selected regions.
 +
::[[File:RegionFilter.png]]
 +
 
  
:If any of the filters are changed, the data will no longer reflect the current state of the filters. To indicate this situation, the Go button is shown in orange and must be clicked to re-query the report data with the currently selected filters.
+
== Export Data ==
  
 +
:By clicking the Export(as .csv) button from the expandable menu of a report, you can export the current visible data and download it into a .CSV file which is easily imported into a spreadsheet.
 +
::[[File:ExportedCsv.png]]
  
== Export Data, Export(as .pdf) ==
 
  
:By clicking the Export(as .csv) button from the expandable menu of a report, you can export the current pages data and download it into a .CSV file which is easily imported into a spreadsheet.
 
 
:There's also the option to perform the exact same operations, but to export to a PDF file.
 
:There's also the option to perform the exact same operations, but to export to a PDF file.
 +
::[[File:ExportedPdf.png]]

Latest revision as of 20:15, 4 November 2015

Reports

Using the reporting tools, you can easily view your data in printable and exportable reporting formats. There are two types of report: Standard Reports and Custom Columns Reports. Selecting the left Reports button brings you to the Standard Reports tab by default.


Standard Reports

There are a number of pre-defined standard reports to choose from that make viewing essential data quick and easy. Simply choose the report from the Standard Reports tab and click the View Report button. Some reports such as Values Report and Comm Message Count Report also provide the Graph Mode. You also have the ability to schedule standard reports. See (B) Schedule of Custom Columns Reports.
StandardReports.png

Custom Columns Reports

Custom Columns Reports target your reporting needs more precisely than the standard reports. These report present data about equipment aggregated over time periods for a customized set columns.

CustomColumnReports.png
A. New
Creates New Custom Report.
NewCustomColumnReport.png
Give your report a descriptive name, a DataTag and select the appropriate options for your new report. Then click the Apply button. This saves your changes and enables the "Add Columns" button.
B. Schedule
You have the ability to schedule custom columns reports. This brings you to the Schedule Report page where you can setup the schedule and apply some further options to the report generation. Give the new Scheduled Report a name and move through the available options. You can assign the report to be generated for a particular Account, apply a Region filter and also generate the report for a certain equipment type. The remaining options define when the report will be generated, as well as generation offsets, day masks and ranges. You can also have the report be emailed to you via the email export options.
Schedule1.png
Schedule2.png
Schedule3.png
Schedule4.png
C. Copy
You may copy a existing custom columns report and configure it differently.
D. Config
ConfigCustomColumnsReport.png
Selecting the New column button brings you to the Add Report Column page. Here is where you define column(s) that will be included in the report. Give your column a name and select its type, action, field, alignment and Data Tag. You have 4 choices for Type; Machine Info, Value, Location and Alarm. Based on the Type selection, the options for Action and Field will change.
AddNewColumn.png
E. View Report
F. View Graph

Scheduled Reports

ScheduledReports.png
A. Enabled
A report will be generated only when this is checked.
B. Suspend
A report can be suspended by the system if an error in the configuration is detected during generation. You may change the configuration and un-suspend.
C. Config Schedule
See (B) Schedule of Custom Columns Reports.


Report History

You can view pre generated custom columns reports from the Report History tab.
ReportHistory.png


Graph Mode

GraphReport.png

A. Table Mode
Switch to the Table Report View.
B. Graph Mode
Switch to the Graph Report View.
C. Print
Print Graph Or Save as Pdf.
D. Data Point
To see (E) More Info, hover over a data point.
E. More Info
Shows device info, event time, datatag, value name, value, and delta value.
F. Legend
Show/Hide a line graph. You will notice that the Y scale is updated dynamically.
G. Show/Hide Grid
H. Full Y Scale Mode
The range of Y scale is rendered from minimum value to maximum value by default. A user can change it from zero to maximum value by clicking this.
J. Paging
Move a timespan with a pagesize(I)

Report Shortcuts

ReportShortcuts.png
Report shortcuts are reports with pre-selected filters that can be created from the expandable menu of a report.
ReportShortcut.png


Advanced Filtering

Advanced filtering allows you to apply search filters to your data so that you can view customized, detailed, reports.


AdvancedFiltersOnEqReport.png
AdvancedFiltersOnTimelineReport.png


Equipment Selection

You can choose to view only equipment assigned to certain accounts, that are of particular types or that are in particular regions.


Data Selection

The data selection filters allows further filtering of rows if they don't meet certain criterion. Filters include; data locations, reason, alarm tags, value tags, or action tags. You can sort rows by most viewable column in either ascending or descending order.
If filters are changed, data will no longer reflect the current state of the filters. The Go button will be shown in orange and must be clicked to re-query the report data with the currently selected filters.

Region Filter Option

When the Regions filter is set, you have three filtering options shown below. The default is to filter equipment by verifying that their last location are in the selected regions.
RegionFilter.png


Export Data

By clicking the Export(as .csv) button from the expandable menu of a report, you can export the current visible data and download it into a .CSV file which is easily imported into a spreadsheet.
ExportedCsv.png


There's also the option to perform the exact same operations, but to export to a PDF file.
ExportedPdf.png