| Appanvil karma designer | ||||
|---|---|---|---|---|
|
🗣️ icon is used to highlight the Customer Request tickets
The 2024_09 release contains x1 Schema change
NEW FEATURES
Custom Fields (BETA) 🗣️
-
29554
Custom Fields
We’ve added an innovative way to unlock key-value data in your databases which has traditionally been difficult to report on.
Known as Custom Fields, you can now provide additional configuration to have the Dashboard create objects automatically from the key-value data where previously you would have needed to manually create these for each item. Click HERE for more information on the Custom Fields feature.
| Info |
|---|
When opting to use a BETA feature, we always recommend doing so in a Test environment first, ensuring you are familiar with the feature before you use it in your Production instance. We would encourage you to reach out to your Customer Success Manager to discuss such features, and arrange additional support from our Professional Service team, who can assist with introducing the features into your instances. |
Single Chart Word Export - Performance Improvement (BETA) 🗣️
pi#2438
29822 & 32731
Exporting - Word
We’re excited to offer a completely rebuilt Word (docx) export functionality which is almost instant and reflects any changes you make to charts on your screen (including legend selection).
You can try it out by enabling the beta feature BROWSER_WORD_EXPORT (in pancredit_parameters table) and we’d love to hear your feedback and incorporate feedback into our upcoming releases. At present it only supports certain chart types (highcharts) which doesn’t include tables, card charts, maps. Any unsupported will simply fall back to the existing export functionality.
Example of the section from the new Word output:
Improved Preview Of Chart Headings - When Categories Load/Refresh 🗣️
pi#2532
31377
Category Preview
Before charts are fully rendered, we populate the cell with the Chart Title to give an indication of what is loading in. Previously, this was just the Chart Name but now this preview will more closely resemble the panel heading that will appear when the chart fully loads. It will show some of the icons that will be displayed as well as the title/subtitle appropriate for that chart. Replacement cannot be done at this stage meaning any form of replacement within the title/subtitle will result in the preview not including that element. Translations, however, are available so you can expect any translated values to be represented in the accurately.
New User/Role Permission (For Admin Users) - To Access The API Configuration Tab 🗣️
pi#2524
24595 & 31607
User/Role Permissions
A new User/Role permission has been added at the Admin level, to determine whether or not the User is allowed to access/edit the configuration within the APIs tab. The new “edit apis” permission defaults to ‘True’ for Admin users at the User Permission level and ‘False’ for Roles.
JDBC Driver - Class Isolation 🗣️
pi#2489
31482
Drivers
JDBC drivers are now loaded into a separate class-loader from system libraries, significantly improving the chances of untested drivers being compatible. As part of this, the Apache Drill driver has been included in the default distribution since this was a driver which had such an issue previously.
CHANGES
Exporting - Enhanced Single Chart PDF & PowerPoint (Performance Improvements) - REMOVED FROM BETA
pi#2600
-
Exporting - PDF & PowerPoint
Our greatly enhanced, rebuilt pdf and ppt exports for single charts have been enabled by default in this release. If you experience any issue please let us know, for a limited time you can switch back to the old mode by using the beta flag OLD_PDF_EXPORT and OLD_PPT_EXPORT.
Exporting - Enhanced Single Chart PDF & PowerPoint - A Drill Down Chart
pi#2599
-
Exporting - PDF & PowerPoint
Resolved a Known Issue with exporting drilldown-level charts, when using the enhanced Single Chart PDF & PowerPoint export functionality - a Known Issue with the August 24 release.
When a user exports a chart at a drilldown level, the export will now correctly capture the chart from the appropriate hierarchy level, provided the chart type is supported. If the chart type is unsupported, the export will automatically revert to using the renderer service.
Editable Tables - Improved Performance When Sending All Data 🗣️
pi#2545
32019
Editable Tables
By removing some additional variable replacement that wasn’t useful we’ve improved the performance of editable tables. Especially when sending large volumes of data.
Editable Tables - Page Resize & Other Changes Causing Duplicate Data To Be Sent 🗣️
pi#2550
32019
Editable Tables
Resolved an issue where page actions such as a resize could result in duplicate rows of table data could be sent to the editable tables endpoint.
Reports - All Charts Load In Parallel - Improved Performance 🗣️
pi#2539
31184
Reports - Performance
Improved report performance by allowing each chart within a report to load in parallel. This does not affect how the charts are rendered, only how they are returned from the back end. Report performance logs have been updated to display the loading times for each individual chart, as well as an overall loading time, which will now be lower due to the requests for individual charts being asynchronous.
scheduler#88
31192 & 31778
Scheduler & Exports
Enhanced the reliability of scheduling tables in Excel format by implementing additional checks to ensure the file's integrity before returning it to the scheduler, along with improvements in naming conventions, increased logging, and better error handling.
Analytics - Unable To Save Analytics Model
pirana#52
31872
Analytics
Despite having the necessary permissions, Admin Users (other than Super Admin) were unable to save Analytics models to the Data Connection, due to a CORS setting issue.
Analytics - Encoded Values Appearing On Analytics Charts
pi#2536
31871
Analytics
Comparators like ‘>=' and special characters like '&’ would appear HTML encoded on Analytics Charts.
Password Reset - Invalid Details Led To Exception
pi#2634
-
Password Reset
Using the password reset function with invalid details previously lead to an exception being displayed.
Organisation - Incorrect Organisation Name Showing In The Configuration Panel
pi#2648
33177
Organisations
Within the Organisations Configuration Panel dropdown list, users will now only see Organisation values where they are either an admin or have 'schedule' permission for those Organisations. If they are an admin, all content will be displayed relating to those Organisations, otherwise an error will be returned that informs the user that they do not have access.
Security - Resolved some issues with CORS settings
pi#2615
Security
Resolved an issue where the CORS settings were not being applied correctly. Note if you are using CORS (browser based api access) it will not support wildcard hosts defined in the trusted hosts. We recommend api access is done via a server side technology which is not affected by this change.
Performance - Made several performance improvements
pi#2666, pi#2625
Performance
A number of areas of performance improvement were identified and implemented
| Warning |
|---|
Consideration before the release notes are finalised - DO NOT RELEASE WITH THIS SECTION INCLUDED |
No Entries on the Release Notes currently for;
Organisations turned on by default (pi#2541) - ONE FOR KEN/NEIL TO CONFIRM
NM - We moved to October release after internal discusions - https://gitlab.panintelligence.cloud/panintelligence/dashboard/pi/-/issues/2639. I will remove out of date tags, Greta has done the release notes for Oct
This is currently showing in the September milestone in GitLab, but on the October Draft Sprint Plan - should it be on the September release notes?
If so, something will need adding with narrative that explains what this means for exisiting and new installations.
Chart title with object replacement not translating successfully (pi#2660) - WITH NEIL
NM - Test case wasn’t valid and issue much bigger than described and a bug not a defect, i’ve removed the tags
Understood to be in the release - an entry will need to be added
Performance - Encrypted Variables (pi#2656) - WITH NEIL
NM: Added
Understood to be in the release - an entry will need to be added
Do we need to add other entries for the other performance changes we have addressed around Performance as part of the Cycle 6+ builds? ONE FOR KEN/NEIL TO CONFIRM
Are there any changes needed to the Technical Datasheet due to the performance changes - raised with KEN
Cross-origin Resource Sharing (pi#2615) - WITH NEIL
NM: Now added
Unclear if this has been included based on GitLab tag (still at Code Review).
Did this get included, if so, an entry will need to be added
Other Translations changes - ONE FOR KEN/NEIL
NM: I think these all relate to data translation, I would put a generic note about data translation edge cases and include any tickets confirmed to be working by test. Current status is quite vague because i’ve had differing reports on what is fixed. The fix work was done by Ming as part of another ticket when he noticed it wasn’t working and prior to these tickets coming in I think.
the Dev team have addressed lots untranslated field/strings, however we dont appear to have a ticket for this in GitLab, and so there is nothing on the release notes currently
If we dont have a complete list of the items changed, we should at least have a placeholder on the release notes, to acknowledge the fact that translations have been improved throughout.
We will need something on there, to simply address the fact that we have addressed some of Phil tickets (see below), as he is bound to ask about them if there is no reference to them, even though he knows they have been addressed
We shouldnt be making changes and not mentioning them on Release Notes, especially when there is customer impact
|
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
🗣️ icon is used to highlight the Customer Request tickets
The 2024_09 release contains x1 Schema change
NEW FEATURES
Custom Fields (BETA) 🗣️ | - | 29554 | Custom Fields | ||
|---|---|---|---|---|---|
We’ve added an innovative way to unlock key-value data in your databases which has traditionally been difficult to report on. Known as Custom Fields, you can now provide additional configuration to have the Dashboard create objects automatically from the key-value data where previously you would have needed to manually create these for each item. Click HERE for more information on the Custom Fields feature.
| |||||
Single Chart Word Export - Performance Improvement (BETA) 🗣️ | pi#2438 | 29822 & 32731 | Exporting - Word |
|---|---|---|---|
We’re excited to offer a completely rebuilt Word (docx) export functionality which is almost instant and reflects any changes you make to charts on your screen (including legend selection). You can try it out by enabling the beta feature BROWSER_WORD_EXPORT (in pancredit_parameters table) and we’d love to hear your feedback and incorporate feedback into our upcoming releases. At present it only supports certain chart types (highcharts) which doesn’t include tables, card charts, maps. Any unsupported will simply fall back to the existing export functionality. Example of the section from the new Word output: | |||
Improved Preview Of Chart Headings - When Categories Load/Refresh 🗣️ | pi#2532 | 31377 | Category Preview |
|---|---|---|---|
Before charts are fully rendered, we populate the cell with the Chart Title to give an indication of what is loading in. Previously, this was just the Chart Name but now this preview will more closely resemble the panel heading that will appear when the chart fully loads. It will show some of the icons that will be displayed as well as the title/subtitle appropriate for that chart. Replacement cannot be done at this stage meaning any form of replacement within the title/subtitle will result in the preview not including that element. Translations, however, are available so you can expect any translated values to be represented in the accurately. | |||
New User/Role Permission (For Admin Users) - To Access The API Configuration Tab 🗣️ | pi#2524 | 24595 & 31607 | User/Role Permissions |
|---|---|---|---|
A new User/Role permission has been added at the Admin level, to determine whether or not the User is allowed to access/edit the configuration within the APIs tab. The new “edit apis” permission defaults to ‘True’ for Admin users at the User Permission level and ‘False’ for Roles. | |||
JDBC Driver - Class Isolation 🗣️ | pi#2489 | 31482 | Drivers |
|---|---|---|---|
JDBC drivers are now loaded into a separate class-loader from system libraries, significantly improving the chances of untested drivers being compatible. As part of this, the Apache Drill driver has been included in the default distribution since this was a driver which had such an issue previously. | |||
CHANGES
Exporting - Enhanced Single Chart PDF & PowerPoint (Performance Improvements) - REMOVED FROM BETA | pi#2600 | - | Exporting - PDF & PowerPoint |
|---|---|---|---|
Our greatly enhanced, rebuilt pdf and ppt exports for single charts have been enabled by default in this release. If you experience any issue please let us know, for a limited time you can switch back to the old mode by using the beta flag OLD_PDF_EXPORT and OLD_PPT_EXPORT. | |||
Exporting - Enhanced Single Chart PDF & PowerPoint - A Drill Down Chart | pi#2599 | - | Exporting - PDF & PowerPoint |
|---|---|---|---|
Resolved a Known Issue with exporting drilldown-level charts, when using the enhanced Single Chart PDF & PowerPoint export functionality - a Known Issue with the August 24 release. When a user exports a chart at a drilldown level, the export will now correctly capture the chart from the appropriate hierarchy level, provided the chart type is supported. If the chart type is unsupported, the export will automatically revert to using the renderer service. | |||
Editable Tables - Improved Performance When Sending All Data 🗣️ | pi#2545 | 32019 | Editable Tables |
|---|---|---|---|
By removing some additional variable replacement that wasn’t useful we’ve improved the performance of editable tables. Especially when sending large volumes of data. | |||
Editable Tables - Page Resize & Other Changes Causing Duplicate Data To Be Sent 🗣️ | pi#2550 | 32019 | Editable Tables |
|---|---|---|---|
Resolved an issue where page actions such as a resize could result in duplicate rows of table data could be sent to the editable tables endpoint. | |||
Reports - All Charts Load In Parallel - Improved Performance 🗣️ | pi#2539 | 31184 | Reports - Performance |
|---|---|---|---|
Improved report performance by allowing each chart within a report to load in parallel. This does not affect how the charts are rendered, only how they are returned from the back end. Report performance logs have been updated to display the loading times for each individual chart, as well as an overall loading time, which will now be lower due to the requests for individual charts being asynchronous. | |||
Schedules - Improvement Reliability When Scheduling Tables (Excel Format) 🗣️ | scheduler#88 | 31192 & 31778 | Scheduler & Exports |
|---|---|---|---|
Enhanced the reliability of scheduling tables in Excel format by implementing additional checks to ensure the file's integrity before returning it to the scheduler, along with improvements in naming conventions, increased logging, and better error handling. | |||
Analytics - Unable To Save Analytics Model | pirana#52 | 31872 | Analytics |
|---|---|---|---|
Despite having the necessary permissions, Admin Users (other than Super Admin) were unable to save Analytics models to the Data Connection, due to a CORS setting issue. | |||
Analytics - Encoded Values Appearing On Analytics Charts | pi#2536 | 31871 | Analytics |
|---|---|---|---|
Comparators like ‘>=' and special characters like '&’ would appear HTML encoded on Analytics Charts. | |||
Password Reset - Invalid Details Led To Exception | pi#2634 | - | Password Reset |
|---|---|---|---|
Using the password reset function with invalid details previously lead to an exception being displayed. | |||
Organisation - Incorrect Organisation Name Showing In The Configuration Panel | pi#2648 | 33177 | Organisations |
|---|---|---|---|
Within the Organisations Configuration Panel dropdown list, users will now only see Organisation values where they are either an admin or have 'schedule' permission for those Organisations. If they are an admin, all content will be displayed relating to those Organisations, otherwise an error will be returned that informs the user that they do not have access. | |||
Security - Resolved some issues with CORS settings | pi#2615 | - | Security | ||
|---|---|---|---|---|---|
Resolved an issue where the CORS settings were not being applied correctly.
| |||||
Performance - Several Performance Improvements 🗣️ | pi#2666 & pi#2625 | - | Performance |
|---|---|---|---|
A number of areas of performance improvement were identified and implemented | |||
Translations - Several Improvements To Enable More Translations 🗣️ | - | 32769, 32816, 32821, 31377 | Multi Lingual |
|---|---|---|---|
A number of additional areas where translations occur in the dashboard have now been added. | |||
SCHEMA CHANGES
Description | GitLab | ZenDesk | Column |
|---|---|---|---|
Column ‘edit apis’
| pi#2524 | 24595 & 31607 | User Roles / Permissions |