Zoomdata Version

Preparations to Upgrade Zoomdata to v2.3

Before upgrading Zoomdata to v2.3, please review this article in its entirety before proceeding. Fundamental architecture changes have been made for v2.3 and the installation process has also changed.This article walks you through these changes and the preparations needed to ensure a successful upgrade.

The upgrade guidance presented here and in the subsequent upgrade articles pertain to upgrading Zoomdata from v2.2 to v2.3. If you need to upgrade from an earlier version of Zoomdata (v2.0 or earlier), then contact Support .

Preparation: What's Changed in v2.3

New Metadata and Data Profile Store

Previously, Zoomdata (v2.2 and earlier) used MongoDB to store metadata, additional visualization information and Scheduler information. Starting with v2.3, Zoomdata is switching over to PostgreSQL, an open source relational database management system.

Zoomdata automatically installs PostgreSQL v9.5 in its environment during the installation process.

Migration Tool

The installation package for v2.3 includes a Migration Tool that will help you migrate metadata and data profile information stored in MongoDB over to PostgreSQL. This tool should be executed after Zoomdata v2.3 is installed on the server.

Configuration (Property) Files

Zoomdata leverages different configuration files to ensure successful deployment in your operating environment. In particular, one file - zoomdata.conf - was renamed to zoomdata.properties beginning in Zoomdata v2.2. The old filename - zoomdata.conf - has been depricated in Zoomdata v2.3 and is no longer used by the Zoomdata Server. If you have configurations in the zoomdata.conf file, you will have the opportunity to copy them into zoomdata.properties during the upgrade process to ensure your existing configurations are maintained in v2.3.

Access the article Zoomdata Configuration Properties for information.

Flat Files

Flat files including CSV, TSV, XML and JSON files that are cached in MongoDB will be converted into MongoDB sources (you will see the MongoDB icon in v2.3 instead of the Flat Files icon). However, if you choose to remove MongoDB from the Zoomdata environment, you will need to upload your Flat Files again.

Access the article Uploading a Flat File for instructions to use flat files in Zoomdata.

Server-Level Variables for Connectors Moved to Dedicated Connectors Page

The ability to toggle connector variables has been moved from the Advanced page (when logged in as the Supervisor) to the dedicated Connectors page.

Access the articles Configuring Key and Value Settings and Managing Connector Services for more information.


A new version of SAML is used in Zoomdata v2.3. As a result, after upgrading from Zoomdata v2.2 to v2.3, you will be unable to use SAML to log into Zoomdata v2.3. To resolve this issue, generate the metadata file again in Zoomdata v2.3 and replace the outdated version in your SAML provider account.

Real Time Sales Demo Source

The real time sales demo source for v2.2 will be removed during the upgrade process. This demo source was refactored for greater efficiency in the use of system resources in v2.3. During v2.3 installation, a new version is installed, but not enabled. If you would like to use this demo source in v2.3, you will need to manually enable it. Access the article Enabling the Real Time Sales Demo Source for guidance.

For a breakdown of new and changed features in Zoomdata v2.3 as well as a list of Known Issues, access the article What's New for v2.3 .

Overview of the Upgrade Process

Prior to starting the upgrade process, Zoomdata strongly recommends that you back up the data in MongoDB. Otherwise, you run the risk for data loss during the upgrade process. You will also be deleting the Zoomdata v2.2 instance before installing v2.3.

Starting in v2.3, the installation process has been automated and all you need to do is run an installer script. This script will access a dedicated Zoomdata repository (via the Internet) and automatically download all the necessary components to (1) install and then (2) start your Zoomdata service. Once the installer script has completed execution, you will run the Migration Tool to move your metadata that is stored in MongoDB in Zoomdata v2.2 to PostgreSQL, the new metadata store in Zoomdata v2.3. There are additional optional steps to ensure that all pertinent information has been transferred to Zoomdata v2.3. Once Zoomdata v2.3 has been set up as needed, you can access Zoomdata as normal in your browser window.

Upgrade steps:

  1. Back up the data stored in MongoDB
  2. Stop your current Zoomdata Server
  3. Uninstall your current Zoomdata Server
  4. Run the installer script for v2.3
  5. Check the zoomdata.conf file and copy any configurations over to the zoomdata.properties file
  6. Run the migration tool script to transfer data from MongoDB to PostreSQL

OPTIONAL: Enable the Real Time Sales demo source.

Access the article Upgrade Instructions for step-by-step details.