Data Administration and Architectural Enhancements

The following data administration and architectural enhancements were made in Zoomdata 3:

Unified REST API

Versions 1 and 1_1 of the Zoomdata REST API are now officially deprecated and will be removed from Zoomdata in the next 9-12 months. Version 2 of the REST API is available and should be used going forward.

If you already have permissions to access a data source, you can now refresh it using Zoomdata's REST API without switching accounts.

Chart Studio Deprecation

Chart Studio is no longer supported. Instead, use the Enhanced CLI to create custom charts.

Enhanced CLI

A new CLI version, 4.1.0, is released and supported by Zoomdata 3.7. You can install the latest CLI and review its README file at

  • The file structure of custom charts and some CLI commands changed in CLI 4, although the chart API has not changed. In addition, you can now easily share a custom chart without its source. For information about using the new CLI version, see Creating Custom Charts with CLI.

    The following CLI command changes are included in CLI 4:

    Command Update Made Description
    zd-chart add Removed Use the zd-chart import command instead.
    zd-chart init Added Use this command to create a new chart in a folder you specify. This command combines the functions of the zd-chart create and zd-chart pull commands.
    zd-chart edit Changed Updates the chart locally, but no longer pushes the updated chart to the server.
    zd-chart push Changed Pushes the new bundled format of a custom chart to the server.
    zd-chart import <zip-file-path> Added Imports a chart in a zip file.
    zd-chart watch Changed Watches changes in the src directory and pushes them to the server.
    zd-chart create Removed Use the zd-chart init command instead.
    zd-chart pull Removed Use the zd-chart init command instead.

    Zoomdata recommends that you install the new CLI version globally and migrate your existing custom charts to the new CLI 4 directory structure. See Migrating Custom Charts. If you prefer to continue supporting CLI 3 and its commands as well as working with CLI 4, Zoomdata suggests that you install the CLI 4 version locally but retain CLI 3 installed globally. See Using Previous and New Versions of the CLI on a Single Machine.

  • CLI 4 must be used with Zoomdata 3.2 and later. The following table lists the version of the CLI supported by different Zoomdata versions.

    CLI Version Supported Zoomdata Versions
    3.0 3.1 and earlier
    4.x 3.2 and later

    For information about migrating your existing custom charts to version 4.0 format, see Migrating Custom Charts. You can get additional information about the CLI at the following link as well:

  • In CLI 4, a custom chart is bundled before it is pushed to the Zoomdata server. Bundling can be accomplished using a tool such as webpack. This creates a /dist directory containing the necessary files required to send the chart to the Zoomdata server.

  • In CLI 3, you could zip up the entire custom chart directory to share the chart and its source with someone. You can still do this in CLI 4, but you can also easily share a custom chart without its source by simply zipping the files in the /dist directory within the custom chart directory. Note that this /dist custom chart zip file is not compatible with the zd-chart import command and cannot be imported using the Manage Custom Charts page in the UI. To import the /dist custom chart zip file, use the zd-chart push command instead.

  • This CLI version includes a new CHANGELOG in which you can find additional updates described, such as:

    • Obsolete chart name and description variables have been removed.
    • CSS modules are now enabled for newly created charts.
    • Support has been added for glob patterns within the watch command.

Configurable Encryption

You can now encrypt the values of properties that contain sensitive information. See Encrypting Configuration Properties.

Diagnostic and Tracing Enhancements

A new Zoomdata Service Monitor and Zoomdata tracing service have been introduced. You can use these services to diagnose and trace problems with Zoomdata. In addition, Zoomdata Support may request information from these services when assisting you with a problem. See Diagnosing Problems and Using the Zoomdata Tracing Service.

Spring Cloud Upgrades

  • The Spring Cloud library used by Zoomdata has been updated. This change requires that you delete the RabbitMQ messaging queues used by prior Zoomdata versions before you upgrade to Zoomdata version 3.3. In addition, a number of other things changed as a result of this update that will affect your use of Zoomdata 3.3 after it is installed. See Version 3.3 Upgrade Information.

  • An additional header specifying the media type on non-browser HTTP requests is now required. See Version 3.3 Upgrade Information.

  • The Spring Boot 2 platform is now used. This Spring Boot version adds several advantages such as speeding up page loads with HTTP/2, addressing compression limitations on WebSocket payloads, and integrations with spring tools for distributed tracing and runtime monitoring/alerting needs.

Screenshot Service Updates

The following Screenshot service updates were made:

  • Zoomdata's Screenshot service switched from using Firefox to using headless Google Chrome. The Chrome-based Screenshot service provides more capabilities than the Firefox-based Screenshot service. Screenshots produced using the Chrome-based Screenshot service include the entire dashboard and can be exported in PNG or PDF formats.

    In this release, Zoomdata replaced the zoomdata-xvfb service (which used Firefox version 45.7) with a new service called zoomdata-screenshot-service (which uses the latest version of Chrome).
    The Chrome-based Zoomdata Screenshot service provided cannot be installed in CentOS v6 environments because the Google Chrome dependencies do not support that platform.
  • Two new properties pool.thread.size and pool.queue.size, residing in the file have been added. These properties specify the upper limits for Screenshot service processing. When the number of screenshot requests exceeds the limits set by these two properties, you will receive HTTP 429 "Too Many Requests" errors. You can increase the values of these properties when you encounter too many failed screenshots. However, do so with caution. See Configuration Properties and Options.