How to use “Include description in in report” in Analytics
When the contents of the Description field need to be embedded in report output from Analytics Module, use the “Include description in report” option in Report Designer. This feature allows users to include the description text defined in a report’s properties within the generated output file (Excel, PDF, Word, or XML). It is also useful for providing context or notes about the report directly in the exported file or scheduled report attachments.
The description is only embedded when the report is generated through “Run” function or through a scheduled task that delivers the output file attachment; it is never added when the Export To function is used.
Configure the Report
Open the report in Report Designer in Design mode.
In Report Properties, complete the following:
· Enter the desired text in the Description field.
· Tick the Include description in report checkbox.
· Select the desired Output format (Excel, PDF, Word, or XML).
Save the report configuration.
Output Behavior
When running the report (“Run” in Report List):
The description will be included in the exported file (Excel, PDF, Word, or XML).
When using “Export To”:
The description will not be included in the downloaded file, regardless of the output format.
When scheduled as an email task:
If the report is sent as an email attachment (emailAttach=True), the description will appear in the attached output file (Excel, PDF, Word, or XML).
If the report is sent without an attachment (emailAttach=False), the description will not appear in the email body.
Additional Notes
The Include description in report option works across all supported output types: Excel, PDF, Word, and XML.
The description will appear near the top or header section of the generated output, depending on the report layout.
Ensure Output Report Settings is ticked; otherwise, the description may not appear in the file.
For consistent inclusion of the description in automated reports, verify the scheduled task uses emailAttach=True.