November 2022 Dashboard Release Notes
Original Release Name - pi.2022-11-24
Patched Release Name - 2022_11_24.1
Patched Release Name - 2022_11_24.2
Original Release Date - Dec 8, 2022
Patched Release Date - Dec 16, 2022
Patched Release Date - Jan 26, 2023
We are pleased to present our latest offering of pi - our November release! This page helps summarise and familiarise you with the changes we have made and is supported (where applicable) with useful videos to help explain the changes we have delivered.
Before upgrading, we recommend taking a backup. You can find more information here.
Here’s what we’ll cover
- 1 Added
- 2 Changed
- 2.1 Patch.2 - The automatic licence manager (ALM) not calling back in some circumstances
- 2.2 Alpha tag removed for import/export (Zendesk#15681)
- 2.3 Implement the ability to provide filter values when scheduling reports (Zendesk#20260)
- 2.4 Added pagination for Report Filter and Category Filter Default Value Selection (Zendesk#20260,23230)
- 2.5 Temporarily disable captcha functionality (Zendesk#23411)
- 3 Fixed
- 3.1 Editable Tables can make use of Variables (pi#1487 / ZenDesk 23212)
- 3.2 Correct API status code is returned when using the Editable Tables feature (pi#1488 / ZenDesk 23948)
- 3.3 Editable tables data value 'undefined' every 2nd time you update a cell within a row (pi#1471 / ZenDesk 23857)
- 3.4 Sorts and Targets not being removed when changing to a chart type that doesn’t support them (Zendesk#8586)
- 3.5 Blank Pages in PDF (Zendesk#17619)
- 3.6 Shouldn’t be able to create schedules and reports with iframe, Url link, Drill to url and Drill to Category (Zendesk#17643)
- 3.7 Hourly and minutely schedules running at incorrect time after midnight (Zendesk#17742)
- 3.8 Licence details disappearing if you navigated away from the ‘Licence’ tab (Zendesk#19413)
- 3.9 Renderer not working with self-signed or invalid certificates when configured to access the Dashboard over HTTPS (Zendesk#19462)
- 3.10 Unable to convert excel file to database when using a database hosted on azure (Zendesk#20481)
- 3.11 Reset password link only appearing as localhost for non admin user (Zendesk#20499,21831,23552)
- 3.12 Speedometer targets appearing outside chart when the final set target is not the highest one (Zendesk#20689,22723,23049,23402,23486)
- 3.13 Tomcat logging should be ‘ERROR’ by default and should save correctly (Zendesk#21030)
- 3.14 Light Bulb charts not showing data value when small (Zendesk#21349,21479)
- 3.15 Cached ALM licence takes priority over invalid new licence (Zendesk#21939)
- 3.16 ALM request incorrectly states database type as ‘HyperSQL’ (Zendesk#21940)
- 3.17 Empty Tables break exports (Zendesk#22289,22884)
- 3.18 Table width not adhered to in Word on Windows (Zendesk#22381,22383)
- 3.19 Applying a pre-select value to a date range filter with the browser language set to ‘English (United Kingdom, Oxford English Dictionary spelling)’ does not allow you to display data (Zendesk#22517,22672)
- 3.20 Date range selector - doesn't allow you to set the ‘from’ date in the past when changing the ‘to’ date to a date in the past (Zendesk#22761,23101)
- 3.21 Renderer not working over HTTPS with Same-Site ‘none’ and secure cookies (Zendesk#22893)
- 3.22 Unable to update editable tables (Zendesk#23334)
- 3.23 Download and export buttons are available for: iframes, url link, drill to url and drill to category - even though they don’t work (pi#1406)
- 3.24 User created repository backups have “..” in their filenames(configuration-tool#116)
- 3.25 Unable to see all output in Configuration Tool (configuration-tool#117)
Added
Drill to URL with headers/payload - generating variables from external API requests (Zendesk#17237,20582)
URL Charts/ Configuration
It is now possible to build and send custom API requests to external APIs for the purpose of generating variables in the dashboard. These variables can then be used when drilling to a URL chart. This makes it possible to drill to a page using a generated token in the URL as a means of authentication – allowing users to drill to pages that would normally require a log in step.
Please see this page for more information.
Hide chart panel heading on card charts (Zendesk#21516)
Card Charts
Uers will now be able to hide the chart panel heading on Card Charts.
Please see this page in piDocumentation for more information.
Checkbox to skip pages with empty tables (Renderer#74)
Reporting
A new checkbox ‘Skip Pages With Empty Data Tables’ has been added to the reporting configuration panel, allowing the user to skip pages in the report, which contain only empty tables in its page content.
This covers different table types and will affect the reports exported or scheduled in pdf, PowerPoint or Word formats.
By default, the checkbox is unticked, allowing the reports to be exported in its original form.
If you try to export a report, containing only empty tables in its content and you have 'Skip Pages With Empty Data Tables’ ticked, an error will be thrown in the UI, asking you to check your ‘Skip Pages With Empty Data Tables’ configuration and no file will be returned. A similar error will also be displayed in the monitoring screen in the scheduler if you try to schedule such a report.
This functionality will not affect the preview, the preview will still display the report in its original format.
Changed
Patch.2 - The automatic licence manager (ALM) not calling back in some circumstances
Automated Licence Manager
In certain circumstances the Automated Licence Manger (ALM) is not calling back to the licencing server. This will only effect customers who use automated licence keys.
The licence manager should call back to the panintelligence licence server every 24 hours, this validates the site is licenced, and sets the limits of users, user types and modules accessible. If a call back has not happened for a determined period of time then the instance will believe it is no longer licenced. This locks users out of the system.
Users trying to access the dashboard in this circumstance will not be allowed to access the dashboard. Depending on your authorisation settings users may receive a warning message - or just an error.
In addition if no licence is found users where given the wrong error message.
This has also been resolved, now a user will be told explictly if no licence key has been found.
Alpha tag removed for import/export (Zendesk#15681)
Import/ Export
Alpha tag for import/export for data connections, schedules and reports has now been removed and replaced with a help icon and some help text, providing information on how to import/export between different dashboard versions.
Implement the ability to provide filter values when scheduling reports (Zendesk#20260)
Scheduling and Reports
Previously when scheduling reports, the reports were using the default filter values. This means that users would be unable to schedule the same report with different filter values unless the report was duplicated.
This change ensures that users can provide filter values to override the default definition when configuring a schedule, which means that the same report can be sent with different filters.
In order to achieve this, the following changes were made:
On the Schedules screens:
Each report attachment now has a button to launch a panel, which allows providing filter values associated to the attachment
The panel works just like category filter selection, which supports cascading filter values
The same report can now be added to the schedule multiple times with different filter values
On the Reports screens:
Editing report filters can cause the definition of the overriding values to be out of sync. The report filters screen now shows the affected schedules when editing the filters
If the schedules are affected by the change of report filters, they are disabled when saving the report. Users need to review and edit those schedules to correct the filter values accordingly, so that the reports can be sent out as expected
API changes:
Reports can now be downloaded using the API
Refer to the API documentation for details about downloading reports as docx, pdf, or pptx files
Added pagination for Report Filter and Category Filter Default Value Selection (Zendesk#20260,23230)
Report Filters, Category Filters
When creating/ editing Category Filters, for certain Category Filter types, the system offers a pop up for selecting the default value(s). The pop-up panel now has pagination, which improves performance when there are lots of values to be displayed.
The same implementation is done for selecting Report Filter Default Values.
You can more information on this page.
Temporarily disable captcha functionality (Zendesk#23411)
Dashboard
Due to some improvements we plan to make to the usability of the captcha login security feature we have temporarily disabled this functionality until our work is complete.
Fixed
Editable Tables can make use of Variables (pi#1487 / ZenDesk 23212)
Editable Tables
Previously when making an API request using the Editable Tables feature, the pi application didn’t make use of Variables.
This has been changed to enable usage of Variables, including the {{}} syntax and [[]] syntax.
[[VARIABLE]] can now be used for HTTP Call Parameters
{{Dimension}} or {{Measure}} now can be used for both name and value in HTTP Call Parameters
{{Dimension}} or {{Measure}} use the data from the table
[[SECURE_VARIABLE]] are submitted via the request unreplaced (can see it from the network), while the value received by the target system should get the replaced result. This allows making use of Secure Variables to set the credentials when making an API request
Correct API status code is returned when using the Editable Tables feature (pi#1488 / ZenDesk 23948)
Editable Tables
When using the Editable Tables feature, previously the system didn’t return the correct status code, so it’s hard to detect what’s wrong.
This has been fixed, so now depending on the situation, the status code is returned as part of the response, and the system attempts to provide status codes and messages as good as possible. With 2 codes returned to reflect the response for each request:
pi status code - an status code related to the pi application processing the request
target status code - an status code returned from the target API
So after editing the Editable table and submit the request,
If the request is successful, 200 is returned (pi: 200, target api: 200)
If something is created by making such an API call, 201 is returned (pi: 201, target api: 201)
If the data submitted is deemed to be invalid by the target API, 400 is returned (pi: 400, target api: 400)
If the target API is not available, 400 is returned (pi: 400, target api: 404)
If the target API has a system error, 400 is returned (pi: 400, target api: 500)
If the pi application has a system error, 500 is returned (pi: 500), in this case pi wouldn’t be able to include the status code from the target API
Editable tables data value 'undefined' every 2nd time you update a cell within a row (pi#1471 / ZenDesk 23857)
Editable Tables
Previously, there was a bug that occurred every 2nd time you edit any cell within a row in an editable table which some of the data values being sent to be ‘undefined’. This has been fixed so that the data values are saved properly and sent consistently.
Sorts and Targets not being removed when changing to a chart type that doesn’t support them (Zendesk#8586)
Chart Editor
Previously, when changing from a chart with Sorts and/or Targets to a chart type that doesn’t support them, errors may have been displayed due to the Sorts and Targets not being immediately removed. This has been resolved in this release of the Dashboard.
Blank Pages in PDF (Zendesk#17619)
Reports/ Renderer
Previously, the renderer was adding extra blank pages when a report with a table was exported in PDF. This issue only used to happen in certain scenarios usually where the table content was higher than the size of the page. An extra space of 40px has now been reserved in the report page to make sure no blank pages are created.
Shouldn’t be able to create schedules and reports with iframe, Url link, Drill to url and Drill to Category (Zendesk#17643)
Scheduler
Previously, users were able to create schedules and reports with iframes. We have now blocked the following 4 chart types from appearing on the dropdown menu for attachments in schedules and reports:
Iframe
Url Link
Drill to url
Drill to Category
If you have a schedule previously saved with any of these chart types attached, the attachment will now appear in red on the schedule editors screen to notify you that it needs to be deleted.
Hourly and minutely schedules running at incorrect time after midnight (Zendesk#17742)
Scheduler
Minutely and hourly schedules were re-adjusting to the incorrect time when running after midnight. For example, a time entered as 10:00 would be wrongly re-configured to 00:10. Now, the schedule correctly runs at the time defined by the user.
Licence details disappearing if you navigated away from the ‘Licence’ tab (Zendesk#19413)
Configuration Tool
The details of an XML licence that are displayed in the ‘Licence’ tab of the configuration-tool would disappear if they had not yet been applied via the ‘Apply and Run’ option and you navigated to a different tab. These details now persist between tab changes.
Renderer not working with self-signed or invalid certificates when configured to access the Dashboard over HTTPS (Zendesk#19462)
Configuration Tool/ Renderer
Previously, the renderer was not working with self-signed or invalid SSL certificates when connecting through a HTTPS ‘Dashboard URL’. There is now a new option present under the ‘Renderer’ tab of the Configuration Tool, ‘Ignore Https Errors’, which will allow the Renderer to proceed despite the certificate errors.
Unable to convert excel file to database when using a database hosted on azure (Zendesk#20481)
Excel Reader
Previously, you were unable to save an excel file to a database hosted on azure. This was due to some unnecessary escaping of characters upon saving. Now, ensuring that you have the database username credentials set up in the format ‘<username>@<server>’, you should be able to successfully save an excel spreadsheet to an azure database.
Reset password link only appearing as localhost for non admin user (Zendesk#20499,21831,23552)
Password Reset
Previously, the url generated by the reset password link would contain ‘localhost’ rather than the appropriate hosted url. It now always generates a url taken directly from the server.
Speedometer targets appearing outside chart when the final set target is not the highest one (Zendesk#20689,22723,23049,23402,23486)
Chart Viewer
Previously, the targets for a Speedometer chart would appear outside the chart under the following conditions:
You have multiple targets set up
The final target defined is not the one with the highest value (i.e. target one is 100-200, target two is 0-100)
This would cause a visual glitch where the target would appear outside the chart. The targets now retain their position inside the chart under these conditions.
Tomcat logging should be ‘ERROR’ by default and should save correctly (Zendesk#21030)
Settings
Previously, the Tomcat logging setting within the settings screen was set to ‘debug’ by default. It is now set to ‘error’ by default. Additionally, there was an issue where, upon changing and saving this setting, it would not save correctly and would revert back to its default setting. This has been fixed, allowing this setting to save and update correctly.
Light Bulb charts not showing data value when small (Zendesk#21349,21479)
Charts/ Reports
Previously, Light Bulb charts would hide their data value when this was smaller than a certain size even if it would have been perfectly legible.
Now, both Light Bulb and Traffic Light charts will display this value, on both the dashboard and in reports containing them, no matter how small they become.
Cached ALM licence takes priority over invalid new licence (Zendesk#21939)
Licencing
Previously, if you changed your UUID license to an invalid one the encrypted licence stored in the database would be used. This hid the fact that the new licence was invalid until the encrypted one expired.
Now, if the UUID licence is invalid you won’t be able to log in and the encrypted licence will be removed from the database.
ALM request incorrectly states database type as ‘HyperSQL’ (Zendesk#21940)
Licencing
Regardless of the type of database being run, the audit data sent to the ALM when using a UUID licence would state that it was a ‘HyperSQL’ database. Now, the database type is identified and reported correctly.
Empty Tables break exports (Zendesk#22289,22884)
Renderer
Previously, the renderer would display and an error and break when an empty table was scheduled to export or was exported in single chart mode or as part of a report.
Table width not adhered to in Word on Windows (Zendesk#22381,22383)
Renderer
Previously, the table width ratio was not being respected when exporting tables as Word on Windows. Now, if you create a table with varied column width/ratios, the set column widths will be adhered to when exporting tables in both single chart mode and reports.
Applying a pre-select value to a date range filter with the browser language set to ‘English (United Kingdom, Oxford English Dictionary spelling)’ does not allow you to display data (Zendesk#22517,22672)
Category Filters
Previously, when applying a pre-select value to a date range filter when the browser’s language was set to ‘English (United Kingdom, Oxford English Dictionary spelling)’ the data was not displaying on the chart. Now, it correctly processes the language setting, and the data displays as expected.
Date range selector - doesn't allow you to set the ‘from’ date in the past when changing the ‘to’ date to a date in the past (Zendesk#22761,23101)
Category Objects
Previously, when loading a category with a date range Category Object that contained either a default value or a value that has already been saved and you changed the ‘to’ date to a date in the past, it would not allow you to select a ‘from’ date before the previously selected ‘to’ date.
For example:
You load the category, and the date filter has ‘from’: ‘10/10/2022’, ‘to’: ‘15/10/2022’
You change ‘from' to '05/10/2022’
You cannot select a ‘to’ date before ‘10/10/2022' until after you save the change and re-load the category
This has been fixed, so you can now freely update the ‘to’ date on this filter to a date in the past.
Renderer not working over HTTPS with Same-Site ‘none’ and secure cookies (Zendesk#22893)
Renderer
Previously, a Renderer with default settings was unable to successfully communicate with a Dashboard served over HTTPS with secure cookies and Same-Site set to ‘none’.
Unable to update editable tables (Zendesk#23334)
Data Tables
Previously, users were unable to update editable tables when a non-data column was present. An example of a non-data column is having a ‘where clause’ within the object that the data for this particular table is taken from.
Download and export buttons are available for: iframes, url link, drill to url and drill to category - even though they don’t work (pi#1406)
Chart Viewer
The following chart types can now only be exported to PowerPoint and the button that allows users to schedule these charts has been removed from the Chart Viewer screen. We have disabled the buttons that allow you to schedule the following chart types, or export them as anything other than PowerPoint, from the chart viewer screen.
Iframes
Url Link
Drill to url
Drill to Category
User created repository backups have “..” in their filenames(configuration-tool#116)
Configuration Tool
Repository backups created through the ‘Create Backup’ button under the ‘Repository’ tab of the configuration-tool mistakenly had two adjacent dots as part of their filename. They now have a single dot as intended.
Unable to see all output in Configuration Tool (configuration-tool#117)
Configuration Tool
If an output message was wider than the ‘messages’ screen of the Configuration Tool, the overflowing contents would be hidden. This would happen relatively frequently as messages were rendered on a single line regardless of their length. Now, word-wrapping is applied to each message allowing them to be broken up into multiple lines as long as logical splitting points are present.
CUSTOMER NEWS - Our November 24 Release Is Now Available - Download It Now!