416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.5

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Upgrading Dundas Dashboard

Hide navigation
Modified on Thu, 03 Dec 2015 02:58 PM Categorized as Administration, Configuration, FAQs, Installation, Licenses
Click to return to: Documentation | Documentation in PDF | Installing and Administering Dundas Dashboard


These are the instructions for upgrading Dundas Dashboard. In order to upgrade to a new major release such as Dundas Dashboard 5.5, you will need to obtain a new license file as shown in the Upgrading Steps below. For more information about the different types of release versions, see Dundas Dashboard Versioning.

Tip: Always backup your Dundas Dashboard databases (datastore and sync) before upgrading to a new version.

Tip: Watch the how-to video: Upgrading Dundas Dashboard

Warning: Upgrading to a newer version is irreversible. You will not be able to rollback to your previous version after upgrade. Before upgrading, especially your Production environment, make sure you've simulated the upgrade on a Test environment first.

Upgrading Steps

  1. Read Important Notes about upgrading.
  2. For a new major release, you can download a new license file from the Dundas Support Site or contact your account manager to obtain a new license file. To download license files:
    • Go to the Your Account page on the Dundas Support Site.
    • Go to the Licenses tab and generate the license for the new version. Note that you must have a user account on the Support Site and also have the privilege to generate a license (obtained previously from your account manager).
  3. Download the Deployment Center installer from the Downloads page.
  4. Run the installer.
  5. Choose the “Advanced Installation” or “Upgrade Installation” option to be able to re-use your existing databases (data store and sync). The Installing Dundas Dashboard document can guide you through the installation.
  6. See Dundas Dashboard Licensing for instructions on applying your license file if needed.

Troubleshooting upgrade issues

If the upgrading process fails, then the installation log will show an error log that provides details about the cause. Give the upgrade another try and if you still get issues, the known reasons for failure are detailed in these articles along with the resolutions:

Important Notes

Database Permission Requirements

The connection string used for the upgrade will be determined by the selected instance’s Dundas Dashboard Configuration file through the AppDatabaseConnectionString and SyncDatabaseConnectionString keys. This login id must contain the following fixed server roles: DBCreator, SecurityAdmin, ProcessAdmin, and DiskAdmin.

Dundas Dashboard Add-ons

After upgrading to a new version of Dundas Dashboard, you will also need to upgrade (or install the newest versions of) add-ons that were installed in the previous version. The Deployment Center can upgrade add-ons for you when you use the Upgrade Installation option.

SDK installation folder

If you are using the Upgrade Installation option, note that the SDK installation folder will be deleted and replaced. If you have modified the contents of this folder (⪚ when trying out the SDK/samples), make sure you backup this folder before doing the upgrade. The default path for the SDK folder is: C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{InstanceName}\SDK.

Dundas Dashboard for SharePoint

If you upgrade an existing version of Dundas Dashboard that has the Dundas Dashboard SharePoint Web Part installed, you will also need to install the new version of the Web Part from the Deployment Center.

MySQL Connector/Net driver

When upgrading to a new version of Dundas Dashboard, note that a specific version of the MySQL Connector/Net driver may need to be installed on the server. Using the latest version from MySQL may not work as a specific version is expected by Dundas Dashboard. For more details and links to the required driver versions, see Data Provider - MySQL.

Upgrading to version 5.5

Review the following notes if you are upgrading from version 4.0:

  • The scheduled reports feature in version 5.0 or later replaces the scheduled notifications option in Dundas Dashboard version 4.0 or earlier. The upgrade process will automatically convert any existing scheduled notifications into corresponding scheduled reports.

  • If you modify the underlying database of a virtual table by adding a new column, the next time you re-discover the corresponding data connector, or edit the virtual table, the new column may be added automatically to the virtual table but it will be hidden by default. Prior to version 5.0, the new column(s) are visible by default.

  • Server API change: Prior to version 5.0, the Session extensibility class incorrectly reports datetime properties using local server time instead of UTC. This has been fixed in version 5.0 to properly use UTC time but be sure to update your application code after upgrading if it is relying on the previous behavior.

  • Server API change: Prior to version 5.0, when the AccountModificationsAllowed property of an IAccountServicesProvider implementation was set to false, this would also prevent the Dundas admin user from being able to save changes to the admin account. This behavior has been corrected in version 5.0 or later so that the Dundas admin user will always be able to make changes to its own account, regardless of the property value.

  • There is a change in how alignment works when applying a formula that returns a single value (⪚ Count formula) to a data grid. Prior to version 5.0, the formula result was repeated for each row in the data grid. In version 5.0 or later, the result is displayed for the first row only.

  • For range bar charts, if the start and end values are the same, the corresponding bar is not displayed. Prior to version 5.0, a vertical line would be shown. Note that a marker will still be visible, if enabled.

  • In version 5.0.1 or later, bars in a bar chart that are drawn on top of each other are no longer sorted automatically in descending order by measure value to prevent shorter bars from being hidden under taller bars. In these cases, a stacked bar chart can be used, or sorting can be used to set up the desired sort order.

  • In version 5.0.2 or later, there is a new privilege, May customize HTML Home screen, which lets administrators grant or deny the ability to customize the HTML Home screen for a user account or security group. If you are using a custom account and/or group provider, you will need to update your code. Specifically, the implementation of the method, void GetEveryoneGroupPrivilegeIds (out List grantedPrivilegeIds, out List deniedPrivilegeIds), from the interface IGroupServicesProvider needs to be updated to return the ID of the “May customize HTML Home Screen” privilege as part of grantedPrivilegeIds to preserve the existing behavior. The “May customize HTML Home Screen” privilege can be accessed using PrivilegeIds.CustomizeHTMLHomeScreen.

Upgrading the Image Creation Service

Before using the Deployment Center to upgrade an Image Creation Service instance, it is recommended to stop the service manually first:

  1. Access the list of Windows services running on your computer (⪚ run services.msc).
  2. Locate the Dundas Dashboard Image Creation Service (or Dundas Dashboard ICS) instance in the list.
  3. Stop the service (⪚ do a right-click and choose Stop).

Once the service has been stopped, launch the Deployment Center and go to the Extras screen in order to perform the actual upgrade.

Manually stop the Image Creation Service before upgrading it.

Manually stop the Image Creation Service before upgrading it.

Related topics

Click to return to: Documentation | Documentation in PDF | Installing and Administering Dundas Dashboard

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2016 Dundas Data Visualization, Inc.