Required module
Data that is logged with Historical data can be periodically e-mailed to you in the form of a PDF report. With Report Generator you can:
- Create multi-page report templates of your machine data.
- Schedule a report to be sent to you periodically, in PDF format.
- Send a report to yourself or other users once, in PDF format.
Please follow the steps below to get everything set up:
Create a report
Reports are created in the Studio, linked in the Fleet Manager, and used in the Portal. If you are already familiar with Device pages, then you are already largely familiar with how reports work.
- Go to Studio > Reports and click onAdd new report.
- You can also use an existing report as starting point by creating a Duplicate from the report's settings.
- The report Name is only displayed in the Studio. The report Title is displayed in the Portal and in the PDF report e-mails.
- Changes are automatically saved as a draft. Don't forget to Publish the report when you're done to effectively start using your latest changes in the Portal. If you're unhappy with your changes, you can also Revert to the published version from the report's settings.
- In the right menu you can find the Report settings (details below). If you do not see the report settings, make sure to click with your mouse on an empty part of the page and expand the menu.
Setting Description Time period The report's time period determines which period is shown in data components. Time period controls The time period controls enables users to select a custom time period when manually sending the report from the Portal. This is unadvised if the report name and its contents are tuned to a specific time period (e.g. a week, a month). Labels Labels can be used to organize your Studio overview and find pages, cards, and reports more easily. More information: How to organize pages, cards, and reports in the Studio. - At Select device for preview, in the top left corner, select a device to preview the report on.
- At Add a component, in the top left corner, select a component to add to the report.
- You can add up to 64 components per report page (click below for an overview) and you can add as many pages as you like.
Component overview
Component Description Info components: Device Info General information about the device, serial number, firmware version, and the groups to which the device belongs. Event Log An event log that includes what each user did and when. Including search and export options. Report Footer Footer shown at the bottom of each report page, showing the time period presented by the report and also showing the report page number. Report Header Header shown at the top of each report page, showing the company name and logo, report name, and date and time of the report. Service Logbook A logbook that contains the notes that were added to a machine. For example about performed maintenance, remote service, or machine updates to keep track of all that was done and updated at the machine.
The logbook will displayed other users as Unknown user if you do not have the permission Manage users.
Notes can be added to a machine with use of the Service Logbook component on a Device page.Historical Data components:
Requires Historical dataData Table Table component. Gauge Gauge component. Component options: custom color-coded scaling. Line Graph Line graph component. Component options: separate left and right Y-axis. Multiple Status Status component that translates multiple data tags' value into custom and more descriptive values (e.g. boolean true = status "Machine running"). Multiple Values Shows multiple values. Component options: data aggregation (max, mean, etc) and color rules. Period Barchart Bar graph component. Component options: data aggregation (max, mean, etc) per sub-period (bar), automatic or static period size. Single Value Show a single value. Component options: data aggregation (max, mean, etc) and color rules. Status Status component that translates a single data tag's value into custom and more descriptive values (e.g. boolean true = status "Machine running"). Statusbar Horizontal bar that depicts color-coded status over a period of time. Translating a single data tag's value into custom and more descriptive values (e.g. boolean true = status "Machine running"). Tank Water tank component. Component options: custom color-coded scaling. Live Data components:
Requires Live dataLive Gauge Gauge component. Component options: custom color-coded scaling. Live Multiple Status Status component that translates multiple data tags' value into custom and more descriptive values (e.g. boolean true = status "Machine running"). Live Multiple Values Shows multiple values. Component options: data aggregation (max, mean, etc) and color rules. Live Status Status component that translates a single data tag's value into custom and more descriptive values (e.g. boolean true = status "Machine running"). Live Tank Water tank component. Component options: custom color-coded scaling. Live Value Show a single value. Component options: data aggregation (max, mean, etc) and color rules. Layout components: Image Image component. Text note Text component using markdown formatting. Also allows for using dynamic text that adjusts to the device. Data component options
Setting Description Aggregator The time period displayed on a report generally contains more than one logged value. Some components, like a Single Value component, contain an aggregator setting to determine which value to depict. The following aggregators are available:
First Shows the first logged value in the displayed time period. Median Shows the middle logged value in the displayed time period. Last Shows the last logged value in the displayed time period. Min Shows the minimum logged value in the displayed time period. Mean Shows the average of all the logged values in the displayed time period. Max Shows the maximum logged value in the displayed time period. Sum Shows the sum of all the logged values in the displayed time period. Mode Shows the value that occurred most often in the displayed time period. Count Shows the amount of values logged in the displayed time period. Range Shows the difference between the minimum and the maximum logged value in the displayed time period. Difference-Last Shows the difference between the last value in the previous time period and the last value in the displayed time period. Decimals Enter the amount of numbers you want to display after the decimal point. Optional. Unit Enter the unit you wish to show behind the value.
To apply the same unit in every component, leave the unit field empty and instead enter the unit at the Variable in your device's Data source in the Fleet Manager.Factor Enter the factor you wish to apply to the logged value. May be used to translate grams to kilograms for example. This does not change the logged value. It only affects the displayed value.
To apply the same factor in every component, leave the factor field empty and instead enter the factor at the Variable in your device's Data source in the Fleet Manager. - You can move (drag), resize (click and drag), copy & paste (right-click), and remove (right-click) components. Tip: you can also copy a component from one page and paste it onto another page.
- When displaying a boolean in a component, use 0 instead of FALSE and 1 instead of TRUE in the component settings and rules.
- A single report can later be used for multiple devices. Tips and instructions for creating dynamic reports that automatically adjust to the device can be found here: Dynamic cards, pages, and reports.
- You can add up to 64 components per report page (click below for an overview) and you can add as many pages as you like.
- To preview what the report would ultimately look like in PDF format, click Send report in the top right corner to immediately receive an e-mail with the PDF report.
- The latest version will be e-mailed, regardless of whether it is published or not.
- Don't forget to Publish the report in the top right corner to effectively start using your latest changes in the Portal.
Link a report to a device
Reports are linked to a device in the Fleet Manager and used in the Portal.
- Go to Fleet Manager > Devices and click on your device name.
- In the left menu, go to View.
- Under Reports, add the report to the device.
- The Access category determines which users can use the report in the Portal (set a schedule or send the report manually) and which users don't. More information: User management explained.
- Reports can be re-arranged (drag and drop). The order is directly reflected in the Portal.
- A report can be linked to multiple devices. Tips and information about creating a dynamic page that automatically adjusts to the device: Dynamic cards, pages, and reports.
Send a report
Reports can be scheduled to send a report to your mailbox periodically or they can be sent manually when needed.
- Go to Portal > Devices and click on your device.
- In the left menu, go to Reports.
- To send a report to yourself periodically, click on Schedule.
- Reports can only be scheduled for yourself, not for other users. Other users will need to set a schedule for themselves.
- To send a report to you or others once, click on Send report.
Reports take time to generate. As a result, live data may be from a slightly later moment than when you scheduled the report. For time-critical data analysis of the PDF report it is therefore recommended to use historical data instead. The historical data's timestamps will always accurately display the time when the data was logged.