- 19 Jul 2022
- 3 Minutes to read
- Updated on 19 Jul 2022
- 3 Minutes to read
A Report is a Designer Element that is used to collect, filter, and organize data. The data displayed on a report can be sourced from the System, Flows, Folders, integrated systems, and custom Data Structures.
Reports are created within the Decisions Studio using the Report Designer. This Designer provides a blank workspace for configuring the Report's Data Source, Data Fields, any desired Filters and View methods, and additional visual, style, and behavioral configurations.
After configuration, data from Reports can used in the following ways:
|Downloaded as a CSV file|
|Converted into a PDF file|
|Used as a Flow step|
|Embedded in a Page as a Report Viewer Control|
Report Designer Features
The Report Designer is the Designer Studio responsible for the creation of Reports. It can be accessed by selecting the CREATE REPORT button on the Global Action Bar within a Designer Project and subsequently selecting Report.
The primary method of creating Reports involves defining a Data Source and providing the desired Data Fields.
Selecting the Add button allows the option to add each respective item/feature to the Report.
|Data Sources||Allows users to provide data for the Report. After being configured in the remaining columns, the data is then displayed on the Report.|
|Data Fields||Allows users to define which Data Field/Property of the Data Source is displayed on the Report.|
Note: at least one Data Field is required for the Report to display the Data Source.
Once Data has been defined via the Data panel, Reports can be further configured using the Properties tab, as well as the Filters and Views panel.
These features allow filtration of the populated data, options to display Charts pertaining to the data, and provide additional methods of
|Properties||Provides additional configurations that affect how the data is displayed and used within the Report.|
|Filters||Allows users to apply specific Filters to filter out data based on specific Properties. Such Filters include: Rule Filters, Date Range Filters, Folder location Filters, and more.|
|Views||Allows users to display the data on the report in alternate layouts. These include: Matrix, Row Summary, Rich Text, Layout Based View, Calendar, Tiles, Hierarchical view, Columns view, and Chart view for Grouped Reports.|
|Slider||Allows adjustment of how the Report is organized. This includes Sort By, Group By, and Column settings,|
After a Report has been created, it can be Saved, tested, and tracked via the Top Action Bar and the Global Debugger Icon.
|Save||Saves the Report without closing the Designer. This action includes a window to write notes for the current Save State if needed.|
|Close (X)||Closes the Report Designer; upon Close users are provided the option to also Save the Page and provide Notes.|
|Checkpoint||Creates a Backup point for the Report at the point where the Checkpoint action is enacted, then stores it in the History Folder. This can be useful when making drastic changes that could affect the contents or design of the Report. For more information, please visit the Creating Checkpoints article.|
|Run Report||Runs the Report in a new window. Report will display as expected upon Runtime within a Page or Flow.|
|History||Displays the History and Documentation page for the Report. Displays each saved version of the Report and allows user; users can use this list of versions to Restore desired versions of the Report.|
|Dependencies||Offers a breakdown of which Designer Elements the Page depends on, as well as which Elements depend on the Page. For more information on Dependencies see Dependencies Overview.|
|Global Debugger||This introduces a new feature with Decisions v.7x. The Global Debugger is a Debugging interface that can see any Designer Element running in Decisions in real time.|
Reports serve a multitude of purposes as they can be displayed on a Page/Dashboard through the use of a Report Viewer, can be applied to a Folder to display information pertaining a Project or the environment, or can be used a step within a Flow, in addition to many other.
At runtime, after a Report has been created and configured as desired, it can be Downloaded/Exported as a .decobj for use in other Decisions-based environments, as a Pdf, or in Excel format.
Additional features such as Report Output Templates and Report Output Handler Flows can be used to define how the Report is saved and is displayed in the chosen file format.