February 2025 - Dashboard Release Notes
ย
ย
- 1 NEW FEATURES
- 1.1 Embedding - Open Report Editor - In Embedded Window
- 1.2 Docker Image - ARM Architecture Image Added For Dashboard
- 1.3 Caching - Ability To Exclude A Chart From Data Connection Cache
- 1.4 Organisations - Ability For Organisation Admins To โSave Default Layout For Each Categoryโ
- 1.5 Exporting To CSV - Performance Enhancements For Tables
- 1.6 Multi Lingual - Translations On The Chart Debug And Reporting Screens
- 1.7 Custom Fields - Index Field In A SubQuery For Custom Field
- 2 CHANGES & MAINTENANCE
- 2.1 Merged Charts - Legend Items On Merged Charts
- 2.2 Configuration Tool - Failing To Prevent The Dashboard Using systemd (โ--no-systemdโ Flag)
- 2.3 Exporting To Excel - Data Translations Not Appearing In Export Of Tables
- 2.4 Multi Lingual - Translation Of Report Import Button - Tooltip Not Translated
- 2.5 Multi Lingual - Translation On Report - Insert Image Dialogue
- 2.6 Observability - Software Version Details Being Logged At Startup
- 2.7 Licence - Updated User Counting Logic, For Validation
- 2.8 Licence - Automated Licence Manager (ALM) Callback Being Incorrectly Related To โGrace Daysโ Value
- 2.9 CSS - Improved Dashboard Display On Smaller Screens
- 2.10 Copy Charts - Unable To Copy Charts To A Target Organisation Without A Linked Data Connection
- 2.11 New Category Objects - Incorrect List Of Values Being Displayed
- 2.12 Library - Python Upgrade
- 2.13 Library - Go Upgrade
- 3 SCHEMA CHANGES
IMPORTANT NOTIFICATIONS
Scheme Changes - the release contains x1 schema changes - see HERE for more details
ย
NEW FEATURES
ย
Embedding - Open Report Editor - In Embedded Window | pi#2778 | 30721 | Embedding / Report Editor |
---|---|---|---|
New Release: pi-embed-actions library We are excited to announce the release of our new JavaScript library, pi-embed-actions, designed to simplify interactions with the embedded pi dashboard. It provides an intuitive API to execute actions directly within the dashboard, minimising manual effort and making integrating pi into your application easier. ย Open the Report Editor with Ease To open the report editor within the embedded window, simply add the pi-embed-actions library to your code, use the API, and provide the required reportId. Here's an example of how to use it: // Basic example of how to create a dashboard instance and embed a Report Editor:
// 1. Create a dashboard instance, providing a valid iframeId and dashboardUrl.
const dashboard = PiEmbedActions.createDashboard('iframeId', 'https://pi-dev.uk:8224/pi?lang=en_GB&editorDisplayMode=CONTENT');
// 2. Open a specific report in the editor, providing a valid report id.
dashboard.reportEditor.open(2); The library simplifies communication between the iframe and the dashboard by automatically sending instructions via post messages to open a specific report editor. This means you no longer have to manually manage this yourself in codeโeverything is taken care of seamlessly by the library! You can also explore a full code example of embedding the report editor using the pi-embed-actions library here:- api-embed-example/static_examples/embed_report_editor.html at main ยท Panintelligence/api-embed-example ย Future Updates Weโre committed to continuously improving the pi-embed-actions library. In the future, we plan to expand its API and capabilities to make embedding even easier and introduce exciting new features. Your feedback is invaluable in helping us make the library even better, so please feel free to share your experiences and suggestions with us! ย Additional Resources For more details about the library, check out the following links: |
Docker Image - ARM Architecture Image Added For Dashboard | dashboard-deployment#97 | 24971 | Docker Image / ARM Architecture |
---|---|---|---|
A separate ARM64 docker image has been added to the dashboard. Simply add the โ_arm64โ suffix to the end of the image you are trying to access to get the correct image for this architecture, for example;
ย N.B - the original AMD branch will still exist for each release without this suffix. This is currently only available for the dashboard project, but we will be adding more in the months to come. |
Caching - Ability To Exclude A Chart From Data Connection Cache | pi#2819 | 34266 | Caching |
---|---|---|---|
Within the Chart Configuration screen, an option for โExclude Chart From Cacheโ has been available. This option relates to the browser caching of charts - and NOT the configurable Data Connection caching, which had caused some confusion. This option has been renamed from โExclude Chart From Cacheโ to become โExclude Chart From Browser Cacheโ to clarify its purpose. To compliment this option, a new option called โExclude Chart From Data Connection Cacheโ has been added. The new option prevents a chart from being put into / retrieved from any Cache that has been configured for the relevant Data Connection. ย N.B - the new setting does not configure the short-term โbrowser cacheโ behaviour, therefore please ensure both are selected if you wish to always retrieve the data from the database for the chart in question. |
Organisations - Ability For Organisation Admins To โSave Default Layout For Each Categoryโ | pi#2862 | 32433 | Default Category Layout |
---|---|---|---|
Previously, only the Super Admin could see/use the โSave Default Layout For Each Category' button, in the โMore Optionsโ menu. This functionality has now been extended to the Organisation Admins too. Unlike with the Super Admin, this feature will not work on all categories, rather it works for categories that the user has access to in Organisation where they:
Whilst the ability to modify and save default layouts are Designer privileges, we have opted to restrict this functionality to users with a lot of access, as particularly across Organisations this feature can be very powerful. |
Exporting To CSV - Performance Enhancements For Tables | pi#2823 | 28672 | CSV Exports |
---|---|---|---|
We have implemented a more efficient CSV export functionality for tables, editable tables and rotated tables. The processing is now done in a more efficient manner reducing memory overheads and the chance of out-of-memory errors. In time the newer mode will apply to all CSV exports. If you experience any issue with this functionality you can temporarily switch back with the beta flag |
Multi Lingual - Translations On The Chart Debug And Reporting Screens | pi#2911, pi#2916 & pi#2917 | 38672 | Multi Lingual |
---|---|---|---|
Chart Debug Screen Added missing translations for the highlighted items below in the chart debug screen: The following key-value pairs have been added to messagesStatic.properties file to translate the content:
Reporting
|
Custom Fields - Index Field In A SubQuery For Custom Field | #2788 | 33214 | ย |
---|---|---|---|
The ability to use an Index Column in a Sub Query, for Custom Fields has been added. |
ย
ย
ย
CHANGES & MAINTENANCE
Merged Charts - Legend Items On Merged Charts | pi#922 | 19187 | Merged Charts / Legend |
---|---|---|---|
When merging charts that included the same legend values, this could result in the legend items being duplicated rather than being merged together as should be the case. All duplicated legend items will now be merged on all configurations where 2 or 3 charts are being merged. ย N.B - additional legend items can be generated on merged charts when they have different X axes, these have not been merged together as part of this change. |
Configuration Tool - Failing To Prevent The Dashboard Using systemd (โ--no-systemdโ Flag) | cfgtool#137 | ย | Configuration Tool |
---|---|---|---|
When passing the |
Exporting To Excel - Data Translations Not Appearing In Export Of Tables | pi#2845 | 34727 | Export To Excel |
---|---|---|---|
When performing an Export to Excel, when the Chart Configuration option of โExport As Excel Without Formatโ having been set, the Titles, Subtitles, Headers and Group Headers were all being successfully translated in the export, however the actual values for these column were not. |
Multi Lingual - Translation Of Report Import Button - Tooltip Not Translated | pi#2917 | - | Multi Lingual |
---|---|---|---|
When using a language other than English, when using the Reports module and navigating to the Import Report button, it was found that the Tooltip shown when hovering over the button was not being translated. |
Multi Lingual - Translation On Report - Insert Image Dialogue | pi#2916 | - | Multi Lingual |
---|---|---|---|
When using a language other than English, when using the Reports module and navigating to the Report Editor screen, it was found that should you click on the Insert Image icon a dialogue boix would appear - however the Cancel option was not being translated to the chosen language. ย |
Observability - Software Version Details Being Logged At Startup | pi#2875 | ย | Observability / Software Version |
---|---|---|---|
To further assist with issue investigations, the dashboard now logs the software version details into the standard log file as part of itโs startup procedure. |
Licence - Updated User Counting Logic, For Validation | pi#2877 & pi#2608 | ย 34504, 30678, 34155, 34707 & 34878 | Licence / User Count |
---|---|---|---|
The logic used to count licence users value has been updated to take into consideration Organisations users. ย N.B - as part of this review, legacy code to count Lite Users has been removed. |
Licence - Automated Licence Manager (ALM) Callback Being Incorrectly Related To โGrace Daysโ Value | pi#2863 | 34050 | Licence / ALM Callback |
---|---|---|---|
Whilst related to licencing, โGrace daysโ are not needed as a factor when monitoring the last time licences were checked against our ALM. Uses of โGrace daysโ in this area have been replaced with hardcoded equivalents of the previous defaults. A further issue with login being disabled prior to exceeding the callback window has also been addressed. |
CSS - Improved Dashboard Display On Smaller Screens | pi#2778 | 34050 | CSS / Styling |
---|---|---|---|
The dashboard styling has been to improved to aid the visibility of content primarily in the Dashboard Reporting and Dashboard Configuration screens. The |
Copy Charts - Unable To Copy Charts To A Target Organisation Without A Linked Data Connection | pi#2903 | ย - | Linked Data Connections |
---|---|---|---|
Users were unable to copy charts if the Organisation did not have a linked data connection. In this scenario, a parent data connection will be used to attribute the chart to from this version forward. |
New Category Objects - Incorrect List Of Values Being Displayed | #2861 | 34665 | New Category Objects |
---|---|---|---|
Addressed an issue with the New Category Objects, where incorrect filter values were being seen, when moving and selecting values between different category objects |
Library - Python Upgrade | pirana#57 | ย 33946 & 33948 | Library Upgrade |
---|---|---|---|
The Pirana project has been upgraded to Python 3.11, and the container has been re-based to Debian to reduce the size of the container - to address the CVE-2024-6345 vulnerability. |
Library - Go Upgrade | scheduler#95 & pirana#97 | ย 35104 & 35105 | Library Upgrade / Vulnerability |
---|---|---|---|
The Configuration Tool, Scheduler, and Excel Reader projects have received minor upgrades to their โGoโ versions (1.23.1 โ 1.23.6), to resolve the CVE-2024-45336 and CVE-2024-45341 vulnerabilities. |
ย
ย
SCHEMA CHANGES
Description | Columns / Items | GitLab | ZenDesk |
---|---|---|---|
Added | exclude_chart_from_data_connection_cache to mis_defined_charts | pi#2819 | 34266 |
ย | ย | ย | ย |
ย
ย