About: This article introduces the Report node, an Output node within Construct.
Location: Node panel
Table of Contents
Feature Overview
A Report node provides users with the opportunity to create reports on the results of a job. Unlike the Output node, a single Report node will accept data from multiple sources at the same time, combining them into a single report. Within this node you can:
- Timestamp each iteration of the report run
- Distribute the report via email during a run
- Publish the report to Bridge, a cloud based, scalability, sharing and data exploration platform
- Customize the report interface
Configuring a Report
The Report node is a versatile type of output that is used for formatting reports and distributing datasets. This node is split into two main sections: Header and Source Section Options.
Header
File Name
Using the ellipsis [...] to the right of the File Name allows users to define the location where the report should be saved, name the file, and select the file type (PDF, HTML, Word, Excel, Rich Text, etc.).
Title
The title will display within the report at the top of the document.
Note: Options for entering parameters and time stamps are available when configuring File Names and Report Titles.
Timestamp Report
Reports have the ability to be timestamped. This allows new report files to be created every time the report is run. New reports are saved in the same location as the previous legacy reports, but with the new timestamp appended to the file name.
Distribute Report
Reports have the ability to be emailed to end users. Email distribution must be configured for this feature to work. To learn more about email distribution set up, see below.
Publish to Bridge
The Report node allows user to publish datasets to Bridge, a cloud-based, scalable and data exploration platform.
Default Settings
Report settings allows users to customize the look of their report. These settings include:
- Formatting the Title, Header and Data
- Formatting data appearance
- Document margins
Source Section Options
Each data source that is fed into the Report node constitutes a "Section". The Source Section Options tab allows for customization of sections within the report. The default option selects a check box to Use Default Settings for all the sections within the report. Those default settings are determined by the settings on the Header tab. If this option is deselected, each section can be stylized by selecting the section from the Source Section dropdown, and customizing the Section Settings.
Section Title
Each section of the report can be given a unique name.
Data Table Modifications and Report Orientation
Data table modifications can be altered to add and remove empty rows and columns. Also, report orientation can be changed to portrait and landscape views.
Adding Data Sources to Reports
Almost any node can be applied to a report, although the most commonly used nodes in reporting are:
More specific Source Section Options may become available depending on the type of node entering the Report node to generate that section. For example a Chart node added to a report has additional options for Chart sizing and layout:- Chart Size - This governs the relative size of the graphic and how it will fit with other items in the report.
- Force New Section - This checkbox locates a chart to a new row in the report regardless of other spacing considerations.
Distribute Reports
Reports can be distributed whenever a job is run. This is similar to the feature of sending an email notification from a scheduled job. The difference is that this configuration is done within the report node, and will send the actual report extract via email to the recipient - rather than just sending a message that the job has run successfully.
To configure a report to distribute:
- Open the Report node and check the box to Distribute Report.
- Select Distribution Setup to see a current list of contacts available to distribute to. If this list is blank or you want to edit the list, you can add and remove contacts by selecting Edit Distributions in the top left of the window.
Tip: Multiple contacts can be grouped together to generate a group email. Simply add more than one email address to the Address List field. - Use the arrows to add or subtract contacts to the Distributions to send to field.
- Save the distribution and run the job.
Note: The email will only be sent when the Report node is run. If the node is disabled or if only part of the job is run, the email will not be sent.
Tip: You can insert contact names via a parameter for greater flexibility distributing among contacts.
Comments
0 comments
Article is closed for comments.