Other Useful Features in Report & Chart

PostedJune 14, 2023

Overview

Prolaborate provides advanced reporting and charting capabilities by allowing users to download, search, and filter data while optimising performance using cached data.

This guide explores key features that enhance data exchange, filtering, and performance within Reports & Charts.

Exchange Model information via Excel

Prolaborate enables users to download dynamic reports generated from Enterprise Architect (EA) models as Excel files for offline analysis.

Excel download is available from Prolaborate V4.5.0 onwards, replacing the CSV download introduced in V4.4.1.
From Prolaborate V5.5.0, users can download entire reports and charts, regardless of pagination, for both Designer and Query configurations.
From Prolaborate V5.6.0, excel reports are generated in the backend, so you don’t need to stay on the download page until the process completes.

Note:

For versions 5.4.0 and below, downloads are limited to the number of rows per page, with a maximum of 100 rows for reports and charts created using Designer configuration.

No download limitations apply to reports and charts created using SQL queries—users can download the entire dataset.

Downloading Data from Charts

Prolaborate has improved its capacity to allow users to download/exchange model data or reports from the charts by clicking the download icon. To know more about creating charts, click here.

Users can download reports generated from charts by following these steps:

Open the dashboard containing the chart. Click on a chart section to generate a detailed report below.

Click the Download icon to initiate the download process.

Enter a suitable file in the modal window and click Download to initiate the process.

You will receive a notification once the file is processed successfully.

Click the notification or click the Reports Download Center in the Monitor & Audit Console to navigate to the download center.

Click Download to download the file.

Once the file is downloaded, users can then share it with their team for offline analysis.

To learn more about Reports Download Center, click here.

Note:

Users can download data only for a specific chart section (filtered view).

Downloading Data from Reports

Dynamic reports created using report widget can be downloaded by clicking the download icon.

Click here to know more about creating reports.

Reports created using the Report Widget can be downloaded by following these steps:

Open the dashboard containing the report. Click the Download icon to initiate the download process.

You will receive a notification once the file is processed successfully.

Click the notification or click the Reports Download Center in the Monitor & Audit Console to navigate to the download center.

Click Download to download the file.

Once the file is downloaded, users can then share it with their team for offline analysis.

To learn more about Reports Download Center, click here.

Filtering Content Before Download

Reports generated from charts and reports can be further customized before downloading. It can be achieved by filtering,

Using the stereotype dropdown
Using show/hide columns
Using individual column search

Filter Rows by Artifact Stereotype

Users can filter the output using the Stereotype dropdown if reports contain multiple artifact types. They can filter rows by selecting a different stereotype from the dropdown menu.

Note:

This option will be available only if MDG Based Report is enabled for charts and reports during configuration.

In report widget, this option will be available in Maximize view and detailed report view.

Filter Columns using Display Columns

Users can filter the columns that are to be printed on a report by using the Display Columns dropdown.

Clicking the dropdown shows the list of columns currently displayed. Users can remove a column by unchecking the checkbox and it automatically hides the column from the view.

Once the changes are reflected, users can download a report with filtered columns by clicking the Download Icon.

Note:

In report widget, this option will be available in Maximize view and detailed report view.

Filter Result using Individual Column Search

Users can further filter the columns that are to be printed on a report by using the Search filter available for each column. This feature is available from V4.5.0 onwards.

Click the Filter icon next to the column name in the header and enter the required information to filter the output result.

The list of values is shown as a dropdown option for the Enum and Boolean column types. Upon selecting the value(s), the result is filtered and displayed accordingly.

Once the changes are reflected, users can download a report with filtered columns by clicking the Download Icon.

Improve Performance of Report

The ‘Cache Data’ option is introduced for Reports and Charts to improve the overall performance of Prolaborate. The ‘Cache Data’ option is applicable for EA Reports which are created using Query method with MDG Based Report toggle switched to OFF.

EA Report (Created using)	Support
Query with MDG OFF	Yes
Query with MDG ON	No
Designer	No

Note:

Yes – Data Cache Available

No – Caching cannot be done because of technical limitations or Invalid Scenario

Enable/ Disable Data Cache in Reports

Cache can be enabled when creating a new report or modifying an existing report. In the configuration page, toggle Cache Data to enable the data cache.

Complete the configuration and save the report. Hover over the refresh icon to see when the report is last cached.

Click the Refresh icon to display live data which also replaces the existing cached data.

To disable the data cache, edit the report and toggle the Cache Data option to disable it.

Improve Performance of Chart

The ‘Cache Data’ option is introduced for Charts to improve the overall performance of Prolaborate. The ‘Cache Data’ option is applicable for Charts which are created using Designer and Query method. However, the sub-report will always display live data irrespective of cache setting.

Chart (Created using)	Support
Query with MDG OFF	Yes
Query with MDG ON	Yes
Designer with MDG OFF	Yes
Designer with MDG ON	Yes

Note:

Yes – Data Cache Available

Yes* – Chart rendered based on cached data, but sub report of chart always shows live data

Enable/Disable Data Cache in Charts