In the Report type configuration module, you can add or change the report templates of your installation.
A report type defines the output format, content and time schedule of a report.
| Property | Description |
|---|---|
| Type | Which type of report should be generated. Currently you can generate CSV, Excel and PDF reports. |
| Name | The name of the report group. |
| Date editable | Can the date of the report be changed when creating a report. |
| Report title | The name which will be assigned to the generated report. Keywords can be used in this field to output the report date. More information about the keywords can be found below. |
| Report title editable | Can the report title be changed when creating a report. |
| Report file name | The name of the file which will be generated. By default the id of the report will be used as file name. Keywords can be used in this field. More information about the keywords can be found below. |
| File name editable | Can the file name be changed when creating a report. |
| Report comment | A comment which will be included for each generated report. |
| Schedule active | Enable or disable the automatic report generation. |
| Schedule | This field is only visible when the schedule is active. The time schedule which will be used to automatically generate reports. More information about the report scheduling format can be found below. |
| Review enabled | Enable or disable the review step. When the review step is enabled, two sets of notification receivers can be configured. The review receivers will receive a notification when the report has been generated and has status |
The report’s time range is always counting back from the report’s creation date.
Example:
If your report’s creation date is 25/01/2018 12:00:00 and you chose 1 day as report period, all data between 24/01/2018 12:00:00 and 25/01/2018 12:00:00 will be included for the selected tags.
Report types
- CSV
- Excel
- Manual
- Custom
All report types can be automatically generated based on the configured schedule, except the ‘Manual’ report type. The manual report type does not work based on a template but expects you to upload a manually created report (outside the application). This type of report is useful for maintenance visit reports, lab results, …
Fields
For each report type additional fields can be defined. This will allow you to provide additional information about the report. By using keywords, the information provided in the custom fields can be included in the report.
Notifications
When a report is generated, notifications will be sent to the configured notification receivers. Following notification types are available:
- E-mail message: An email will be sent to the provided e-mail address.
- SMS: A text message will be sent to the provided phone number. The number should be entered with the country code. Example: +32#########
- Telegram: Telegram is a messaging application, comparable to WhatsApp. A text message will be sent to the provided user or group of users.
- Notification group: A notification will be sent to all notification receivers of the provided notification group.
Keywords & keyword functions
While keywords can be used in the report’s title and comment to include dynamic values, keyword functions can be used to process a provided value.
- $date: This keyword will return the current date.
- $id: This keyword can be used to output the report’s unique id. The is a 24 character long string with hexadecimal characters.
- $customerName: This keyword will return the customer’s name.
- $customerAddress1: This keyword will return the customer’s address 1 field.
- $customerAddress2: This keyword will return the customer’s address 2 field.
- $customerAddress3: This keyword will return the customer’s zip code field.
- $customerAddress4: This keyword will return the customer’s city field.
- $customerAddress5: This keyword will return the customer’s country field.
- $installationName: This keyword will return the installation’s name.
- $installationAddress1: This keyword will return the installation’s address 1 field.
- $installationAddress2: This keyword will return the installation’s address 2 field.
- $installationAddress3: This keyword will return the installation’s zip code field.
- $installationAddress4: This keyword will return the installation’s city field.
- $installationAddress5: This keyword will return the installation’s country field.
- $reportId: This keyword can be used to output the report’s unique id. The is a 24 character long string with hexadecimal characters.
- $reportFilename: This keyword can be used to output the report’s filename.
- $reportContentType: This keyword can be used to output the report’s content type.
- $reportComment: This keyword can be used to output the report’s comment field.
- $reportDate: This keyword can be used to output the report’s generation date.
Dates that are returned by a keyword can be altered or formatted by combining the keyword with one or more of the available functions that can be found here.