Report template
- Navigate to the 'Apps > Report Template > Test' menu.
The 'Report template' app creates and tests user-defined templates for plant reports. The final reports are then generated from the plants based on these templates.
Purpose of 'Reports'
Plant 'Reports' are logs that reflect the current state and operating history of the plants. They assist in controlling and monitoring plants. The logs can be manually or automatically produced on the plant level and downloaded.
The reports can be modified. Report templates are first built and then used in a second step:
- To either upload directly to the plant as a plant file,
- or load as a 'Report file' to a plant’s application set.
Report functions
Reports:
- Based on a blank template created by the user.
- The tables and graphic depictions of the plant:
- Plant graphics.
- Tables with detailed information and lists of data.
- Charts
- Google Maps applications.
- They are exported in .odt format (OpenOffice template: https://www.openoffice.org/).
- Based on the Mustache programming language (https://www.tsmean.com/articles/mustache/the-ultimate-mustache-tutorial/).
- They can be created manually or automatically triggered.
- Depending on the default settings, the templates can be based on different templates and have different content.
- Generated based on templates that can be applied to all plants via the assignment '
Plant<PROPERTY>'. - The name of the 'Property' is the same as the name of the Cloud API.
Detailed procedure
Follow the steps in the order below to generate a plant report:
- Grant the necessary privileges at the administrator, user and plant levels.
- Prepare a blank report template.
- Climatix IC Support (see 'Support provides a template that can be used as a starting point for generating your own report.
- When a new tenant is created, a sample report template is included within the application set. This example can also be used as a template for further processing (see 'Reports').
- Edit the blank report template until it meets your reporting needs.
- Test the edited report template using the 'Test' function.
- Load the completed and tested report template from Climatix IC to the application set or plant.
- In the application set or in the plant, trigger the reporting function manually or on a scheduled basis.
- The completed plant report can be downloaded at the plant level.
The individual steps are described in more detail in the following paragraphs.
Access and privileges
The ability to trigger reports and upload report templates to application sets and plants is based on the particular user's role. Report templates can be loaded either to plants or in application sets. You can upload and use multiple templates at the same time.
For applications:
To access the 'Report' functions in applications:
- The own role↑ is 'ApplicationAdministrator'.
- See 'Assign administrator roles.'
- You can set the users with access to the 'Report' functions in 'User access configuration.'
- Report files can be loaded to the application set as 'Plant files'.
- You can set up automatic report generation at specific times.
- You can access the 'Testing' menu.
For plants:
To access the 'Report' functions on plants:
- The user has the privilege 'Plant / Trigger reports'.
- At the plant level, the 'Plant / Trigger reports' privilege is also granted.
Creating and testing 'Report Templates'
- Edit the blank template per the instructions in the 'Documentation' menu.
- Then test the template as described in the 'Testing' menu.
- Revise and retest as needed.
Load the pre-built 'Report templates’ to plants or application sets
- To load the report template as a plant file: See 'Files in plants.'
- Load the report template as an application file to an application: See 'Plant files.'
Trigger the generation of a plant report
- See 'Download report'.