iTwin IoT - Article 2: How to Create a Basic Report

Overview

This article will show you the basic steps of creating a new Report, including navigating to the Reports Module, creating a new Report, configuring pages, and adding content.

Navigating to the Reports Module and Starting a New Profile

The Reports Module can be found on the left-side module toolbar toward the bottom. Clicking on the icon will open the Reports page shown below. This page has a list of all Reports created by or shared with you and some additional options including a blue "+ Report profile" button which you will push to open the new report configuration window. You are now ready to proceed to the next section to begin configuring the new report.

Configuring a New Report- Basics

This section will cover the basic elements of Report configuration. For more advanced Report configuration options not covered in this article, visit LINK. The new report configuration page will look like the image below. We will work through the basic elements of report configuration in the steps below.

1. Report Name- The first step will be to name the report by clicking the pencil icon next to "New Report".

2. Data Time Zone- The time zone selection dropdown allows you to select the time zone you would like data timestamps displayed in for content added to the report.

3. Adding and Editing Content Blocks- The Content block selection has several selections that can be divided into two types: profiles created in Graphs or Dashboard modules and open-format options, including a text box and image upload option.

These blocks can be added to the report via a drag and drop technique onto the page. Once you've dragged a block onto the page, a placeholder black will appear on the report page, and the "Edit Configuration" window will be opened on the right side of the screen. All content blocks can also be moved by clicking and dragging the block around the report page, and they can be resized by clicking and pulling a corner of the block.

We will cover how to configure each content type below.

Rich Text Block- The Rich text box allows you to add information and comments to the report like the example below. Input the text in the highlighted box on the right side of the screen. There are a variety of standard text configuration tools available at the top of the "Edit content" window.

Image Block- The image block configuration requires you to drag and drop a file into the grey upload area highlighted below, or click the "Choose a file" button to open a file selection window on your computer.

Once you've uploaded the image, it will appear on the report. You can turn off "Preserve aspect ratio" in the settings if you would like the image to fill the entire content block without preserving its proportions.

Dashboard Block- The Dashboard block must have a pre-configured, project-wide shared Dashboard to be added as a report content block. For information about Dashboard configuration, please visit the Dashboard Section.

- a. Dashboard Selection- The Dashboard selection is a dropdown option that allows you to select from any Dashboard shared publicly. If you do not see any options in the dropdown, please confirm you have Dashboards available to add and that they are shared publicly. It may take some seconds to minutes for the Dashboard to appear in the report.
- b. Title- Input the title that will be displayed above the Dashboard on the report. The font size can be changed via the dropdown to the right of the title input.
- c. Time range override- The default for data display on the Dashboard card is the configured setting made within the Dashboard. The reports tool offers the ability to override those settings and select a different timeframe for the report. If this is set and you need to clear it, the clear button to the right of the time picker will reset back to the Dashboard settings.

Graph Block- The Graph block must have a pre-configured, project-wide shared Graph profile available to be added as a report content block. For information about Graph profile configuration, please visit the Time-Series Graph Section.

a. Graph Selection- The Graph selection is a dropdown option that allows you to select from any Graph profile shared publicly. If you do not see any options in the dropdown, please confirm you have Graphs available to add and that they are shared publicly. It may take some seconds to minutes for the graph to appear in the report.
b. Title- Input the title that will be displayed above the Graph on the report. The font size can be changed via the dropdown to the right of the title input.
c. Time range override- The default for data display on the Graph is the configured setting made within the Graph profile. The reports tool offers the ability to override those settings and select a different timeframe for the report. If this is set and you need to clear it, the clear button to the right of the time picker will reset back to the Graph profile settings.

4. Adding Additional Pages- The Pages tab on the left side of the page allows you to add and edit Report pages. Click the pages tab to get to the Page edit option page below.

a. Add page- The "+ Page" button will create a new page for the Report.
b. Move page- If you have multiple pages already added to the Report, you can move them up and down in the Report by clicking on the right side of the page tile and dragging and dropping where you would like it placed.
c. Navigate between pages- You can navigate between your pages by using the selector at the bottom of the preview window or by clicking on the page tiles on the left side of the preview window.
d. Delete page- To delete pages, click the checkbox next to a page, then click the "Delete Selected" button.

5. Saving Report- Once you have configured your report, you can click the "Save" button in the upper right of the page. For more advanced Report configuration options, please visit the LINK.