Overview
Once a report has been created, you can preview and download copies at any time, share the report with users for viewing or to reports send to them, and schedule reports so that they are distributed on a prescribed interval. These options can all be found within the Report configuration window. This article will show you how to complete each of these workflows.
Previewing and Downloading A Report
The Preview function allows you to view and proof a report prior to sharing with others or scheduling distribution, and it also provides you a means to download to pdf or print the report if you need a copy immediately.
1. Single Page Preview and Download- If you just need to preview a single page of the report, you can click the Preview page button in the lower right of the middle report configuration window. Once clicked, a preview window, shown below, will open allowing you to view, download, or print the page. The Download and Print buttons are found in the upper right side of the window.
2. Preview and Download Entire Report- Clicking the dropdown to the right of the "Preview page" button exposes the "Preview Entire Report" button. Click this button to access a preview of the entire report. The Download and print buttons can be found in the upper right if you need an immediate copy of the report.
Adding Users to a Report
Adding users to a report can serve two functions. It can allow users to access the report for their own use, as well as edit the report if they have the correct IoT permissions. The second option that sharing a report provides is that added users will receive scheduled reports. A new report will be Private by default, meaning only the creator of the report can see, edit, and receive a scheduled report. The steps below will show you how to add users to a report.
1. Sharing Button- Click on the Sharing button in the upper right of the Report configuration window. It will say "Private" on the button if the sharing setting hasn't been changed. This will open the sharing settings window shown below.
a. Private- By default, all reports are set to private until they are shared. This means only the creator of the report has access and visibility to the report. The mail icon to the right of the user's name allows you to turn email delivery of reports on or off.
b. Restricted- The Restricted access button allows you to control access to the report using the checkbox icons to the left of the user names, and the mail icon to the right of the user names allows you to turn email delivery of reports on or off.
c. Project wide- The Project wide access button give all users on the project access to the project, and the mail icon to the right of the user names allows you to turn email delivery of reports on or off.
Report Scheduler
The Report Scheduler allows you to not only schedule future reports for delivery via email, but also immediately send an emailed report to you or users added to the report.
1. Schedule a Report- Click the scheduler icon in the upper right of the report configuration window. This will open the Schedule configurator window below.
a. Enable- First, you must enable the configuration via the toggle at the top of the window.
b. Frequency- The frequency dropdown allows you to select from Day, Weekday, Week, and Month(s).
Day will send the report out every day at the specified time.
Weekday will send the report daily Monday-Friday.
Week wlll open a configuration option where you can select which days you would like the report to be sent by highlighting those days.
Month(s) opens a more complex set of radio button selectable configuration options shown below.
c. Time Selection- The Time Selection allows you to choose the time of day that the report will be sent out and select the timezone for that selection.
d. Apply- Once the above configurations have been made, click apply to save those changes and complete the report scheduling process. The report will now be delivered at the configured frequency and time to all users configured to receive the report in the previous section of the article.
e. Disable Scheduled Report- If you need to disable a scheduled report, click on the dropdown to the right of the Schedule button. There is a "Pause schedule distribution" option at the top of the dropdown that will pause the email distribution of reports.
An emailed report will look like the example screenshow below, providing information about the report and when it was generated, as well as a link to download a pdf copy of the report to your computer for viewing.
Note: If you or users who should be receiving the report via email are not receiving the email, please confirm that the email address is not going to your spam or being blocked by your IT settings. The email will be from: iiot_noreply@mailhost.bentley.com.
2. Email Report immediately- You may find the need to send a report immediately. In this case, you can click the dropdown button next to the Report scheduler. There are two distirbution options.
a. Send to all- This option will send the report via email to all users configured in the previous article section to receive this report.
b. Send to me- This will only send the report via email to you the user. This is useful for reviewing a report or previewing the email format.
Accessing Previously Scheduled Reports in iTwin IoT
You may find the need to access reports that were generated in the past, either because you need to check historic information, redistribute to a team member, or to access a report without email. This can be accomplished via the "View History" button.
1. View History button- The View History button is located in the upper-right corner of the Report configuration page. Click this button to access the Report History window.
The Report history window is shown below. Configuration updates and report generation events are listed by timestamp.
2. Download Old Report- To download an old report that has sent via scheduler, click the Download button on the right side of window.
3. View Report History- You can view information about who updated the report and click the dropdown for scheduled reports to see information about the scheduled report event.
Related articles: