Report
This context lets you access and manage a single report.
Unique Actions
[ ? ]
Configure
This action is used to edit Report properties.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Edit Report Template
This action is supported in Iotellect Client only. Is starts the Report Editor and allows to edit the report template.
Action Name: | editTemplate |
Non-Interactive Mode : | Not Supported |
Permissions: | Accessible at Manager permission level |
Preview Source Data
This action fetches data referenced by Source Data Expression and presents this data to the user using Edit Data UI Procedure. It is very useful for debugging a report because it shows the raw data used to fill in report template.
Action Name: | viewData |
Non-Interactive Mode : | Not Supported |
Permissions: | Accessible at Observer permission level |
View History
This action is used to see all versions of this report that were filled earlier and saved in the database.
Deleting lines from a Report History table opened by this action will permanently purge selected historical reports from the database.
Action Type: | |
Action Name: | viewHistory |
Permissions: | Accessible at Manager permission level |
Export to Server File
This Call Function Action saves filled report to a file on Iotellect Server machine. Report is filled with data at the moment of execution of this action and, thus, always contains up-to-date data.
Reports may be saved in one of the following formats:
Printable Document Format (PDF)
Microsoft Excel (XLS)
Rich Text Format (RTF)
Character Separated Values (CSV)
Extensible Markup Language (XML)
Open Office (ODT)
It's also possible to choose a field delimiter if CSV format is selected.
Action Type: | |
Action Name: | export |
Permissions: | Accessible at Operator permission level |
Export to Client File
This Call Function Action opens a filled report as a Data Block, allowing to save it to a file on Iotellect Client or web user's local machine. Report is filled with data at the moment of execution of this action and, thus, always contains up-to-date data.
Reports may be saved in one of the following formats:
Printable Document Format (PDF)
Microsoft Excel (XLS)
Rich Text Format (RTF)
Character Separated Values (CSV)
Extensible Markup Language (XML)
Open Office (ODT)
It's also possible to choose a field delimiter if CSV format is selected.
Action Type: | |
Action Name: | exportRemote |
Permissions: | Accessible at Operator permission level |
Send Report By E-Mail
This Call Function Action sends report by e-mail to the recipients specified as a comma-separated list of e-mail addresses. Report is filled with data at the moment of execution of this action and, thus, always contains up-to-date data.
Reports may be sent in one of the following formats:
Printable Document Format (PDF)
Microsoft Excel (XLS)
Rich Text Format (RTF)
Character Separated Values (CSV)
Extensible Markup Language (XML)
Open Office (ODT)
It's also possible to choose a field delimiter if CSV format is selected.
 | It may be very convenient to schedule this action to enable periodic (e.g. daily or weekly) sending of report by e-mail. |
Action Type: | |
Action Name: | sendByMail |
Permissions: | Accessible at Manager permission level |
Show Report
( Default Action )
This action is used to build and view the report.
Action Flow:
[Optional] User is prompted to enter report parameters using an Edit Data UI Procedure.
A report template is compiled on the server and filled with data.
The report is shown to the user using Show Report UI Procedure.
Action Name: | show |
Action Icon: |  |
Non-Interactive Mode : | Not Supported |
Permissions: | Accessible at Observer permission level |
Execution Parameters : | Report Window Location Report Dashboard Properties |
Schedule Report
This Call Function Action creates a new scheduled job for periodic sending of filled report by e-mail in a user-defined format.
See Send Report by E-mail for details.
Action Name: | schedule |
Action Icon: |  |
Permissions: | Accessible at Manager permission level |
Common Actions
[ ? ]
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
Icon | Code | State |
 | 0 | This report is relative. |
 | 1 | This report is absolute. |
Advanced Information |
Context Information
Context Type: report
Context Name: pre-defined, different for every report
Context Description: pre-defined, different for every report
Context Path: users.USER_NAME.reports.REPORT_NAME
Context Mask: users.*.reports.*
Context Permissions
[ ? ]
Level | Description |
None | No access allowed. |
Observer | Report launching. Report source data viewing. Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Report configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[ ? ]
Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)
Report Properties
See description of the variable and its fields here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1 - 50 characters |
description | String | 1 - 100 characters |
expression | String | |
template | String | |
type | Integer | |
validityExpression | String | |
validityListeners | Data Table | |
defaultContext | String |
Report History
Provides access to the instances of this report that were filled earlier and saved in the database. A new record in this table is created every time the report is filled, but only when a Save History flag of the report is enabled.
System operators can delete historical reports by simply removing necessary records from this table and saving changes to the server.
Variable Name: | history |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
date | Date | Report creation date. |
user | String | System user who has filled the report. |
report | Data Block | Report data. Can be opened in the Report Viewer. |
Additional Report Parameters
See description of the variable and its fields here.
Variable Name: | parameters |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
parameter | String | |
value | String |
Public Functions
[ ? ]
Export to Server File
Saves report to a file located on Iotellect Server. The file will be located in Iotellect Server installation directory unless specified path is absolute.
Function Name: | export | ||
Permissions: | Accessible at Manager permission level | ||
Input Records: | 1 | ||
Input Format : | Name | Type | Description |
file | String | Absolute or relative path of file on the server, with or without extention | |
format | Integer | Report Format. Indicated by one of the Following report types:
| |
fieldDelimiter | String | CSV Field Delimiter. The character literal to delimit fields in the report. Must contain a comma, semicolon, space, or tab. | |
targetContextMask | String | Mask of contexts for which to generate a Relative report. | |
Output Records: | 0 | ||
Output Format : | None | ||
Export Report to Client File
Creates downloadable report Iotellect Server.
Function Name: | exportRemote | ||
Permissions: | Accessible at Manager permission level | ||
Input Records: | 1 | ||
Input Format : | Name | Type | Description |
format | Integer | Report Format. Indicated by one of the Following report types:
| |
targetContextMask | String | Mask of contexts for which to generate a Relative report. | |
Output Records: | 1 | ||
Output Format : | None | ||
Name | Type | Description | |
value | Data Block | Generated report file. | |
Send Report By Email
Fills report with data and sends it by email.
Function Name: | sendByMail | ||
Permissions: | Accessible at Manager permission level | ||
Input Records: | 1 | ||
Input Format : | Name | Type | Description |
recipients | String | E-mail Recipients (separated by commas) | |
format | Integer | Report Format. Indicated by one of the Following report types:
| |
fieldDelimiter | String | Field Delimiter. The character literal to delimit fields in the report. Must contain a comma, semicolon, space, or tab. | |
targetContextMask | String | Mask of contexts for which to generate a Relative report. | |
subject | String | E-mail subject | |
message | String | E-mail message body. | |
html | Boolean | Flag to indicate whether message body is HTML. | |
fileName | String | File name for the attached report. | |
Output Records: | 0 | ||
Output Format : | None | ||
Public Events
[ ? ]
Common Events: info (Information)
Was this page helpful?