Reports

You can define reports that are generated periodically and sent automatically to your customers and partner users as a PDF attached to an email.
A report is sent only to users who, in the profile preferences page, have chosen to receive periodic reports.

Creating a Report

To add a new Report, you should:

1. Enter the Interfaces / Reports page.

2. Select whether you need to create a General report or a Thing Definition-specific report.

3. In the case of Thing Definition, select the target Thing Definition.

4. Press the Add Report button.

5. Provide the name of the report and additional information.

6. Press the Save button.

Editing a Report

In the case of a General report, you must select whether it must be generated for customer or partner users.

The report is defined by:

• Name: The name uniquely identifies the report in the configuration.

• Description: A descriptive text of the report content and purpose.

• File Name: The name of the file to be attached to the email.

• Title: The title of the report that is included in the report cover.

• Recurrence: When the report must be generated and sent to users.
  You can select among Weekly, Monthly, Quarterly, and Half-yearly.

• Report Date Range: The period of data to load according to the selected recurrence (e.g., Last Month).

• Template: The template describing the content of the report. In the case of a General report, it must be a general template, else a thing definition one.

• Subject: The text to be used as email subject.

• Body: the HTML text to be used as the email body.

According to the specified recurrence, report generation occurs after midnight, taking into account the time zone of the customer, partner, or thing.

The content of the PDF report is generated from a template, defined in the same way as for dashboard page templates.
A report is static content, so controls and filtering buttons cannot be used.

You can enable/disable the report by pressing the Activate o Deactivate button.

Report Recurrence

A report can be scheduled so that it is automatically generated and sent periodically to the DPS users.
Within the Recurrence option, you can select among:

• Weekly: The report is generated every week.
  You must also specify the weekday (e.g., every Monday).
  

• Monthly: The report is generated every month.
  You must also specify the day of the month (e.g., every 10th of the month).  
  

• Quarterly: The report is generated every April (Q1), July (Q2), October (Q3), and January (Q4).
  You must also specify the day of the month (e.g., October 10th for the Q3 report).  
  

• Half-yearly: The report is generated every July (S1) and January (S2).
  You must also specify the day of the month (e.g., July 10th for the S1 report).
   

Context Period

When the periodic report is generated, in the page context, there will be a variable named context_period which provides access to the startTimestamp and endTimestamp related to the data range and recurrence of the report.
In this way, instead of specifying the loading period on each page widget (e.g., Last 30 Days), you can now use the page's implicit variable named context_period.

If you are developing a custom widget, you can leverage the appUtils.getContextPeriod() method to access the context period programmatically.

Report Preview

You access a preview of the report directly from the report definition page.

1. Select the Report definition whose preview must be displayed.

2. Select a User View in the Console top bar. This is required to define the context used to generate the report (e.g., Customer).
   In the case of a Thing Definition report, you must also select the location and thing.

3. Click on the Preview button.
    

A new browser tab is opened with a preview of the report with the selected context.

.../dashboard/thing_details/<thing_id>/reports/<report_id>
.../dashboard/customer_details/<customer_id>/reports/<report_id>
.../dashboard/partner_details/<partner_id>/reports/<report_id>

Once the page is open, you can use the print function of your browser to see how the report looks.
The displayed page includes the cover and the report template loaded by using the selected context, and non-printable elements are automatically hidden.