Upgrade an instance

1. Overview

This article describes how to upgrade an installed instance of Dundas BI to a new version, then walks through using the Deployment application on a Windows server to perform an upgrade.

2. Review the release notes

Before upgrading, review the release notes as they may contain important information about changes in functionality with the latest release.

For example, the list of changes page may include a list of behavior changes that could potentially impact your existing content.

3. Review licensing

You may need a new version of the license, which can be applied during or after the upgrade procedure:

  • When upgrading between minor versions or revisions of Dundas BI: you do not need a new version of the license.
  • When upgrading between major versions: you do need a new license version. If your existing license is a subscription license, the license auto-update feature should detect, download, and install your new license version if the license validation feature is active and outgoing data traffic to update.dundas.com on port 443 is not blocked by any firewall. Otherwise, contact your Account Executive or Support.

For more information about Dundas BI version numbers, see Dundas BI versioning.

If you need to apply a new version of the license yourself, you may want to obtain it from Dundas beforehand so you can apply it during or immediately after the upgrade. For details on viewing and adding licenses before or after upgrading, see the article about managing licenses.

4. Download the latest version

To upgrade an existing instance of Dundas BI installed directly on one of your servers, first download the latest Dundas.BI.Setup program for Windows or the appropriate installer for Linux from the My Account page on this site.

Tip
On Windows, your current version of Dundas BI Deployment will also notify you of any new minor version or revision for that major version with the option to update the Deployment application automatically, but new major versions are installed side-by-side and need to be downloaded separately.

The following sections walk through the upgrade procedure on Windows. To upgrade an instance running on a Linux server, see Installing Dundas BI on Linux for details on installing and then running the Deployment Wizard, which can be used to upgrade your instance. Separate upgrade options are also provided for Docker and Kubernetes deployments.

5. Run the new Setup program

The Dundas.BI.Setup program for Windows that you downloaded from Dundas contains the new version of Dundas BI, and its name contains its version number.

When you run the setup program, it may ask you to upgrade the existing Dundas BI Deployment application that is already installed. Click Upgrade when you see this screen.

This is just a setup upgrade - your Dundas BI instance will be upgraded in a later step.

Dundas BI Setup Upgrade
Dundas BI Setup Upgrade

After the setup upgrade is complete, click Launch Deployment Application to open the Dundas BI Deployment application.

Click Launch Deployment Application
Click Launch Deployment Application

6. Upgrading an instance

You're now running the latest version of the Dundas BI Deployment application.

In the main screen, click Deployments on the left. Then click Upgrade an instance.

Upgrade an instance
Upgrade an instance

Tip
Besides upgrading, you can use the Deployment application to open existing instances by clicking View an instance and selecting the instance.

6.1. Prerequisites

The upgrade installation requires a number of prerequisites to be installed before it can proceed further. If your system has all of the prerequisites, simply click Next to continue.

If your system is missing some of the prerequisites, install the missing prerequisites. Then return to this screen and review the Prerequisite details again. Once all of the checks have passed, click Next to continue.

Prerequisites
Prerequisites

6.2. License agreement

You must agree to the terms of the Dundas BI License Agreement before proceeding. If you agree with the terms, select the given checkbox and then click Next to continue.

6.3. Select the instance for upgrade

In the Select an instance step, select the existing Dundas BI instance you want to upgrade.

Select an instance to upgrade
Select an instance to upgrade

Click Next to continue.

6.4. Upgrade database connection

In this step, you must decide whether to use the existing database connection settings for the Dundas BI application and warehouse databases, or enter different connection settings.

It is recommended to keep the existing settings but if you want to apply new settings, select that option and click Next. You will be allowed to enter the new settings exactly as if you were installing a new instance. See Installing Dundas BI for more details on setting up the Application Database and Warehouse Database.

Make sure the option to backup databases before upgrade is selected.

Upgrade Database Connection
Upgrade Database Connection

Click Next to continue.

6.5. License configuration

The License Configuration step only appears if you are upgrading to a different major version, find more details in the article Dundas BI Versioning.

In this case, indicate whether you want to use the Dundas BI evaluation license, or apply an actual license file obtained from Dundas.

Note that you can always apply a retail license after you've upgraded the instance (by going to the Admin screen). See Managing licenses for more details.

Paste the contents of the license file or browse for it
Paste the contents of the license file or browse for it

Click Next to continue.

6.6. Move federated authentication module

The Move Federated Authentication Module step appears only if you are upgrading an instance with an external Federated Authentication Bridge (usually early versions of Dundas BI 4.0).

In this case, indicate whether you agree to move the Federated Authentication Bridge to be underneath the Dundas BI website.

Upgrade Existing Extensions
Upgrade Existing Extensions

Click Next to continue.

6.7. Upgrade existing extensions

Select existing extensions to upgrade, such as the SAML 2.0 Protocol Extension.

Upgrade Existing Extensions
Upgrade Existing Extensions

Click Next to continue.

6.8. Getting started with Dundas BI

Indicate whether you want to include the Getting Started with Dundas BI project.

Getting Started with Dundas BI
Getting Started with Dundas BI

Click Next to continue.

6.9. Review upgrade details

Review all of the options you selected one more time before proceeding with the upgrade installation.

You can also print the list of upgrade details from this screen.

Review upgrade details before proceeding
Review upgrade details before proceeding

If everything looks fine, click Upgrade to begin the upgrade installation.

6.10. Upgrading instance has succeeded

When the upgrade installation completes, click the provided website link to begin using Dundas BI. This should be the same link as before.

You can also review the upgrade installation logs from this screen.

Upgrading instance has Succeeded
Upgrading instance has Succeeded

Click Finish to return to the Dundas BI Deployment application main screen.

7. Next steps

If you have a new Dundas BI retail license but did not apply it during the upgrade, log on to the upgraded Dundas BI instance as an administrator and apply the new license. See Managing licenses for more details.

If you just upgraded to a new major version and no longer need the previous version of Dundas BI Deployment, you can uninstall it from Windows Settings.

8. See also

 

Dundas Data Visualization, Inc.
400-15 Gervais Drive
Toronto, ON, Canada
M3C 1Y8

North America: 1.800.463.1492
International: 1.416.467.5100

Dundas Support Hours:
Phone: 9am-6pm, ET, Mon-Fri
Email: 7am-6pm, ET, Mon-Fri