Working with Reports in Zoho IoT: A Practical Guide

Working with Reports


The Reports feature in the Zoho IoT Application is designed to help you effortlessly create both simple and complex reports. The intuitive, wizard-based steps guide you through selecting various options and creating insightful reports to study trends and analyze performance.
 

Creating Reports  

To create a report,
1. Access the End Application.
2. Select the Reports option from the main menu on the left. The already created reports are displayed on the right side of the screen.
3. Click Add Report.
4. Select the Type of the report, then click Proceed.


Availability

Info
All Report operations require necessary permissions. Refer to Users and Profiles document for more details.

Check Feature Availability and Limits


Creating Instance Comparison Reports 

 When you want to create a report to analyze datapoint values from different instances over a specified time period you can create an Instance Comparison Report.
 
To create a Instance Comparison report,

1. Select Managed Entity
1. After selecting the report type and clicking proceed, Click Add Managed Entity under Select Managed Entity.
2. Select a module from the Select Module drop down list on the left pane to view instances of that module. You can also use the Location Filter to select modules from a particular location.
3. Select the Managed Entity (ME) instances from the right. The report instances can be from different module lists. i.e. you can first choose the All Assets module in the  Module drop down and select two ME instances on the right, and again choose the All Devices module in the Module drop down and select two instances on the right.
Info
Note: You can choose up to a maximum of 4 instances for comparison. The report instances can be from different module lists.
4, Click Apply.

The selected managed entities are displayed on top of the page. More MEs can be added from here, and the existing MEs can be edited if required using the Edit/Modify Managed Entity button.

2. Choose Datapoints
1. You can choose datapoints for the selected managed entities in the left under the Choose Datapoints option.

Notes
Note: You can choose up to a maximum of 6 datapoints across different selected instances.


 
3. Adjust Time Grouping & Save
1. Choose different Time Grouping as required on the right.
 
4. Choose Data Visualization Option
1. Choose the chart or graph format in which you want to view the data (if required).

 
5. Choose Aggregate or Raw Data
1. You can choose to display aggregate of the data or the incoming raw data.
2. For Aggregate, you need to further choose the arithmetic expression i.e. AVG, SUM, MIN, MAX, LASTVALUE, and FIRSTVALUE for the datapoint in the Choose Datapoints section.
After choosing the options for the reports, you can save the report to view it in the same format every time the report is accessed.

6. Provide the Name, Description, Group, and Permission and save the report.
 


Image: Save report
 


Image: Sample Data Explorer Comparison Report
 
Sample Report : In the above sample report, the average temperature in two different rooms is compared and displayed every hour in line chart format.
 
 

Creating Aggregated Chart Reports 

When you want to create a report to view the summary of values of all managed entities associated to the selected model, you can create an Aggregated Chart Report.
 
To create an aggregated chart report,
 
1. Select Modules
1. After selecting the report type and clicking proceed, Click Add Modules to select the module.
2. Select the Time Series Grouping or Instance Property Grouping option.
Time Series Grouping

a. Select modules for which you want to create the report.
Note: A maximum of 4 modules can be selected for the aggregate report.
Note: You can use the "Add Filter" option to filter the module's data based on specific instances or criteria, allowing you to refine the data for your reports.
Even after creating the report, you can edit the report option using Edit/Modify  Module button on the top right corner of the screen.
b. Select the Timeline for the data

Instance Property Grouping

a. Select the primary module on which the report needs to be created. If required, you can also select a related module of the primary module.

b. Select the instance property by which you want to group the report data.

Info
Note: You can filter the records using the property of the selected module or by the property of any related module. And provide further filter conditions using the criteria builder.  

3. Click Save to store the entered details. The report is displayed for the selected criteria.
 
2. Choose Datapoints/Field

1. You can choose Metrics for the selected managed entities in the left under the Choose Metrics option.

Notes
Note: You can choose up to a maximum of 6 metrics. 


 
3. Adjust Data Grouping
1. Choose different Data Grouping as required.
 
4. Choose Data Visualization Option
1. Choose the chart or graph format in which you want to view the data. 
After choosing the options for the reports, you can save the report to view it in the same format every time the report is accessed.
 
Provide the Name, Description, Group, and Permission and save the report.

 
Image: Sample Aggregated Report - Timeseries Grouping

Sample Report : In the above sample report, the sum of water consumption in liters is displayed for every day in column chart format.
 

Creating Summary Table Reports  

When you want to create a report of a module or combine different modules' data in tabular format, you can use the Summary Table reports.
 
To create a summary table report,
 
1. Select Modules
1.After selecting the report type and clicking proceed, Click Add Modules to select the Module.
2, Select the Time Series Grouping or Module Property Grouping or Time & Instance Property Grouping option.
Time Series Grouping
a. Select modules for which you want to create the report.

Notes
Note: A maximum of 4 modules can be selected for the aggregate report.
Note: You can use the "Add Filter" option to filter the module's data based on specific instances or criteria, allowing you to refine the data for your reports.
Even after creating the report, you can edit the report option using Edit/Modify  Module button on the top right corner of the screen.
b. Select the Timeline for the data

Instance Property Grouping
a. Select the primary module on which the report needs to be created. If required, you can also select a related module of the primary module.
b. Select the instance property by which you want to group the report data.
Note: You can use the "Add Filter" option to filter the module's data based on specific instances or criteria, allowing you to refine the data for your reports.
 
Time & Instance Property Grouping 
a. Select the module on which the report is to be created.
b. Select the timeline.
c. Select the table type: Time & Instance Table Report, Time vs Instance Matrix Report, or Instance vs Time Matrix Report
d. Click Save.

2. Choose Columns
1. You can choose datapoints or fields to be displayed in the tabular report for the selected module in the left under the Choose Columns option.
Note: You can choose up to a maximum of 10 columns
 
3. Adjust Data Grouping & Time Grouping and Save
1. Choose different Data & Time Grouping as required.
 
4. Choose Data Visualization Option
  1. Column List

    Rearrange the columns in the table using the option.

  1. Refresh

    Refresh the table to display current data.

  2. View Color Rule

    Set color coding for the table cells based on metric values.

  1. Click Save to save the report to view it in the same format every time the report is accessed.

  2. Provide the Name, Description, Group, and Profiles and save the report.
 


Image: Sample Tabulated Report with module grouping
 
Sample Report : In the above sample report, the sum of water consumed in the current month is displayed for a managed entity along with its location in tabular format.
 
5. Aggregate Option

1. Click on the Aggregation icon in the column header in the report to apply aggregation to the column. 

You can choose the specific metrics for which you want to apply aggregation and Apply. Based on the matrix report’s layout, the system will automatically apply the appropriate aggregation — either L-shaped aggregation or common row-wise aggregation.




Image: Total water consumption aggregation (SUM) based on usage type.

Creating Matrix Table Reports 

When you want to create a tabular and matrix format of datapoint values from across different managed entities in the same report you can create a Matrix Table report.
 
1. Select Modules
1. After selecting the report type and clicking proceed, Click Add Modules to select the Module.
2. Select the Time Series Grouping or Module Property Grouping or Time & Instance Property Grouping option.
 
Time Series Grouping

a. Select the checkbox against "Show Raw Data as received for a particular instance." if you want to display the raw data as such without any manipulation.
b. Select a module for which you want the aggregated data.
Notes
Note: You can select multiple models from the same module for a Matrix Table report. This capability is not enabled by default, please contact 
support@zohoiot.com for assistance.
Notes
Note: You can use the "Add Filter" option to filter the module's data based on specific instances or criteria, allowing you to refine the data for your reports.
c. Click Save. 

Instance Property Grouping

a. Select the primary module on which the report needs to be created. If required, you can also select a related module of the primary module.
b. Select the instance property by which you want to group the report data.

Notes
Note: You can use the "Add Filter" option to filter the module's data based on specific instances or criteria, allowing you to refine the data for your reports.
Time & Instance Property Grouping
 
a. Select the module on which the report is to be created.
b. Select the timeline.
c. Select the table type: Time & Instance Table Report, Time vs Instance Matrix Report, or Instance vs Time Matrix Report
d. Click Save.
 
2. Choose Columns
1. You can choose datapoints or fields to be displayed in the tabular report for the selected module in the left under the Choose Columns option.
Note: You can choose upto a maximum of 10 columns
 
3. Adjust Data Grouping & Time Grouping and Save
1. Choose different Data & Time Grouping as required.
AlertClick the Edit button next to Data Grouping. Group by the selected field, such as a location.
Select the instance property and timeline by which you want to group the report data.
 
Note: Using the Filter option, you can filter the records using the property of the selected module or by the property of any related module. And provide further filter conditions using the Criteria Builder.  



Image: Edit button for grouping



Image: Group by "Usage Type" text property 

4. Choose Data Visualization Option
  1. Column List
Rearrange the columns in the table using the option.
  1. Table Views
Select the relevant table view option.

1. Time & Instance Table Report - Time as column and Instance as column.
2. Time vs Instance - Time as column and instance as row.
3. Instance vs Time - Instance as column and Time as row.
  1. Refresh
Refresh the table to display current data.
  1. View Color Rule
Set color coding for the table cells based on metric values. 
  1. Click Save to save the report to view it in the same format everytime the report is accessed.
  2. Provide the Name, Description, Group, and Profiles and save the report.

5. Choose Metrics Aggregate

You can choose the metric and the aggregate function using the Metrics Aggregation icon on top of the table. based on the matrix reports layout, so either L-shape aggregation or common row wise aggregation will be added.



Image: Metrics Aggregation Icon



 

Image: Metrics Aggregation property selection

 




Image: Sample table with aggregated metrics


Editing Reports  

Any report configuration can be modified whenever required.
 
Alert
 Note: You will be able to edit the reports that you created by default, but you need appropriate permission to edit reports created by a different user. 
 
 To edit a report,
1. Select the Reports option from the main menu on the left in the End Application. The already created reports are displayed on the left side of the screen.
2. Click on Actions > Edit Report from the drop down list on the right. The report's Edit page is displayed.



3. Click on Add/Edit Managed Entity to select different module instances for the report, and click Apply to traverse back to the Reports Edit page.


4. Choose datapoints for the modified entities in the left.
5. All other options can be modified at the Reports Edit page.
6. Click Save to save the changes.
 

 Viewing Reports  

When you have numerous reports in your application, it is recommended to save them under groups for easy viewing.
 

 
Alert
 Note: Reports view is permissions based, and the left tree structure displays only the reports that you have access to.  

To view a report,
1. Click on any report name on the left. The default report is displayed.
2. Select and modify Time Grouping or Data Visualization options to view the same report with different criteria. These options are for viewing purpose only and are not saved. On subsequent viewing, the same report will be displayed in the default format
3. Select the Aggregate option icon to modify the aggregate type, and click Apply to view the report with a different aggregation. 

In the case of graphical reports, click on the graph options to view specific types of graphs. 

NotesNote: In chart reports, the data is displayed in table format below the graph as an additional view option.




Image: Reports view
 


Image: Tabular view of the report is displayed below the report.

Exporting Reports 

Exporting a report helps you download and store reports in PDF or XLSX file. These files can be secured with a password, if required.

To export a report:
1. Access the End Application and select the report you want to export.
2. Select Actions > Export Report from the navigation menu in the left pane.  


3. Select the format from Export as PDF or Export as XLSX file.


 
4. Provide a password and secure the exported report if required.
5. Click Export. The status of the export process is displayed at the right bottom corner of the screen.
 

 

 
6. Click download to download and save the file.
Notes
Note:  The pdf/xlsx file will be available for download in the application and the intimation mail for 5 hours after exporting the report.  

Sample Mail Format:



See Also