Zoomdata Version 3 Release Notes
These release notes cover changes and fixes made to releases under Zoomdata version 3. The latest updates are available in version 3.7.1. You can identify your release version on the login screen.
Zoomdata version 3 is the new long-term support (LTS) Active Support release. Zoomdata version 2.6 is the LTS Passive Support release. At this time, no Zoomdata rapid release model is available. For more information, see Zoomdata Release Vehicles and Licensing Management.
Due to the upgrade of the HashiCorp Consul (service discovery) version from 0.7.5 to 1.2.2, custom connectors built before Zoomdata 3.2 ( built for versions 3.1 or earlier versions) will not appear in Zoomdata after you migrate to Zoomdata 3.7. This is caused by incompatibilities between old connectors and the new Consul. To make your custom connectors compatible with Zoomdata 3.7 (and later versions), you must migrate them as described in Version 3.7 Custom Connector Migration Information.
This migration step is required only for custom connectors built with Zoomdata versions earlier than 3.2 or for connectors that were present before Zoomdata 3.2 but that are now deprecated (for example, the Hive on Tez connector, which was replaced by the Hive connector in Zoomdata 3.7).
|If you have used Zoomdata versions earlier than 3.3, you must delete the RabbitMQ queues before you upgrade to Zoomdata 3.3 or later. In addition, an additional header specifying the media type on non-browser HTTP requests is now required. These changes are required because in Zoomdata version 3.3, we updated the Spring Cloud library underlying our application. See Version 3.3 Upgrade Information.|
|Zoomdata version 3.2 and later versions use headless Google Chrome instead of Firefox for Zoomdata's Screenshot service. The Chrome-based Screenshot service cannot be installed in CentOS v6 environments because the Google Chrome dependencies do not support that platform. See Setting Up the Screenshot Feature.|
For information about Zoomdata's end-of-life policy for third-party software, see Zoomdata's Third-Party End-of-Life Policy.
A high-level summary of the changes between Zoomdata version 2.6 to Zoomdata 3.7 is provided in Zoomdata Version 3 Release Summary.
Resolved a problem in which bookmarks and dashboards could not always be exported using the REST API for admin users in multiple accounts. REST API exports were only successful for the default account. They are now successful for any account to which the admin user belongs.
Restored the Screenshot (png) and PDF export options for an embedded dashboard that includes a map chart.
The Zoomdata client (
zoomdata-client) for 3.7.0 is incompatible with Zoomdata servers for 3.7.1 and later.
If you simply use Zoomdata with the out-of-the-box web application, you do not need to do anything after upgrading to 3.7.1. However, if you have built custom web applications as a client to Zoomdata, you will need to ensure the version of the npm
zoomdata-client and the Zoomdata server are the same when upgrading to 3.7.1 and later.
Zoomdata Version 3.7
What's New or Changed?
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.
A new CLI version, 4.1.0, has been released in conjunction with Zoomdata 3.7. This CLI version contains significant changes, but is fully compatible with previous version 4 releases (see CLI Support Table). It includes a new CHANGELOG that lists the following updates:
- 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
You can install the latest CLI and review its README file at https://www.npmjs.com/package/zoomdata-chart-cli.
In the Zoomdata UI, the Configure Pivot Table sidebar changed its appearance in this release. Its new look makes it more consistent with other widgets in the product. You can now select and manipulate the sidebar using keyboard controls in addition to a mouse. You can also change the aggregation type for metrics and the granularity of time fields using the new sidebar. See Pivot Tables.
The Configure Raw Data Table sidebar changed its appearance in this release. Its new look makes it more consistent with other widgets in the product. You can now select and manipulate the sidebar using keyboard controls in addition to a mouse. See Raw Data Tables (RDT).
You can now add, modify, duplicate, or remove derived fields and custom metrics from the:
- Metric selection sidebar for a chart
- Group selection sidebar for a chart
- Color sidebar for a chart
- Filters sidebar for a chart or dashboard.
Color palettes supplied in Zoomdata that are colorblind-friendly are now identified. If a palette is colorblind friendly,
-accessibleis appended to its name. See Zoomdata Color Palettes.
This release introduces the Zoomdata Service Monitor and Zoomdata tracing service. 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.
You can now encrypt the values of properties that contain sensitive information. See Encrypting Configuration Properties.
This release introduces a new Snowflake connector that allows you to connect to Snowflake data stores. See Managing the Snowflake Connector.
The default JDBC driver for MySQL and MemSQL changed. It is now a native MySQL JDBC driver. Before you can use the Zoomdata MySQL and MemSQL connectors provided with this release, you must download and install the latest driver and update the connector property files. Instructions are provided in Managing the MemSQL Connector and Managing the MySQL Connector.
This release changes support for Hive data stores. Zoomdata now supports versions 2.1 - 3.1. In addition, the name of the Zoomdata connector changed from Hive on Tez to Hive. This has the following consequences:
- The properties file for the Hive connector changed names from
- When you restart the Hive connector, the connector name referenced in the command should be
zoomdata-edc-tez. For example
sudo systemctl restart zoomdata-edc-hive.
- If you want to continue to use your existing Hive data source configurations and connections, they must be migrated. See Migrating Your Hive Connectors for Zoomdata 3.7.
- The properties file for the Hive connector changed names from
This release provides full support for derived fields for MongoDB data sources. You can now create derived fields that use any row-level functions. However, there are some restrictions, described in Managing the MongoDB Connector.
Support for Cloudera Impala version 2.12 has been added in this release. In addition, the Zoomdata Impala connector now supports Kudu 1.7 storage formats and, consequently, supports Kudu DECIMAL types.
Corrected the Volume metric label in exported CSV files to use the custom metric label, when one is specified.
Fixed the Export Raw Data link when exploring an embedded dashboard.
Enabled the saving of dashboards that contain one ore more bar charts with Bar Color = None set.
Corrected KPI charts to show three dots (...) while loading large quantities of data instead of the word "Null."
Corrected custom metric (calculation) exports so the custom names are used in the export, and not a name in the format
Revised error messages produced when creating a new user so that enough information is provided to debug the error without displaying sensitive user information.
Zoomdata Version 3.6
What's New or Changed?
This release enhances Zoomdata's data fusion capabilities and processing in the following ways:
You can now explicitly specify the kind of join that occurs: inner join, left outer join, or full outer join. The join type can be selected for the fields on which the join occurs. In past releases, full outer joins were not supported and left outer joins were assumed unless you specified otherwise for specific fields in the fused data.
Joins are usually performed in-memory. However, if a data connector supports push down joins and the data to be joined comes via the same data connection, Zoomdata pushes the join operation to the underlying data engines and allows those data stores to join the data instead.
In addition, if the data connectors support push down joins, the Zoomdata engine intelligently pushes aggregate queries to the underlying data engines when joining data from different data sources as well, thus reducing the amount of data that needs to be processed.
This capability is currently supported only for Impala and Hive data stores.
Because most joins are performed in-memory, a new configurable limit has been placed on the number of records that can be processed from each joined source. This limit is initially set at 1,000,000 records per joined data source and can be configured by your Zoomdata administrator or supervisor using the
qe.zengine.edc.rows.limitproperty in the
query-engine.propertiesfile. See Managing the Zoomdata Query Engine. If you find you are hitting this limit, use filtering to reduce the number of records to be fused.
In the UI, fused attributes are now referred to as join definitions. Only a single join definition is allowed between two data sources. The join definition can contain multiple join conditions (mappings), previously called forms. Join definitions must adhere to specific rules.
Your Fusion data sources from past releases are not automatically upgraded. You must manually edit them and reconfigure them after upgrading to this version. In addition, preexisting dashboards that used your Fusion data sources from previous versions will not work and will need to be recreated.
Rules and limitations of the new data fusion processing introduced in this release are described in Data Fusion Join Rules and Data Fusion Limitations. For complete information about data fusion, see Fusing Data Sources.
A new option to refresh the data in the charts on a dashboard has been added in this release. The option appears on the dashboard menu and is called Refresh Data. For more information, see Refreshing Data on a Dashboard.
This release introduces smart loading of charts on a dashboard. Smart loading improves the performance for loading charts on a dashboard. This is especially important with dashboards containing many charts.
Without smart loading, charts cannot be used until all of the charts in a dashboard are loaded. With smart loading, an initial maximum number of charts are loaded simultaneously. The rest of the charts are put on hold. After one or more initial charts are loaded, other charts in the dashboard are taken off hold and loaded, but only up to the set maximum. As charts are loaded, they can be used immediately, without waiting for all of the dashboard charts to load.
Charts are loaded from the top down. The immediately viewable charts (the ones at the top of the dashboard) are loaded first, up to the set maximum. If you scroll down through a dashboard, a chart that is on hold and is placed farther from the top of the dashboard is started at a higher priority than other charts on the dashboard.
For information on managing smart loading, including changing the maximum number of charts that are loaded simultaneously (the default is eight charts), contact Zoomdata Technical Support.
The supported versions of MongoDB have changed. Zoomdata now supports MongoDB versions 3.4 - 4.0.
This release adds partial support for derived fields for MongoDB data sources. You can create derived fields that use arithmetic and text row-level functions. If you are running a version of MongoDB prior to version 4.0, the following text row-level functions are not supported (these functions work for MongoDB version 4.0 and later):
Other row-level functions are not supported in derived fields for any MongoDB data sources.
This release adds full support for row-level expressions and derived fields for Apache Phoenix and Apache Phoenix Query Server data sources, with the following limitations:
- The filter IS NULL does not work properly on grouped fields.
- The LOCATE text row-level function only supports a constant as a argument.
- A COALESCE conditional row-level function specified with and empty argument does not work properly.
- If the CASE conditional row-level function returns a null value as a an argument of another function, a NullPointerException may occur.
- The LPAD and RPAD text row-level functions are not supported.
The supported versions of Teradata have changed. Zoomdata now supports Teradata version 16.20 only.
This version of Zoomdata supports the graceful shutdown of a connector. When a connector is shut down, it gracefully completes queries that are in-flight and notifies clients that the connector is terminating. Three new connector properties have been introduced to support graceful shutdown processing. See Connector Graceful Shutdown.
Corrected a problem in which colors could not be applied on charts with attribute values that were null.
Corrected a problem in which all bar chart colors were grey when the color attribute was set to None. Now, when you set the color attribute to None, all the bars use the first color in the color palette selected for the chart.
Corrected a problem in which a Line Trend: Attribute Values chart was blank when a group filter was applied that excluded all the data. Such charts now produce the message "No Data Available."
Corrected an error that occurred for an Elasticsearch raw data table that included more than 1025 filtered records.
Corrected a problem in which an LDAP user's group-only configuration was changed to a regular user configuration after the user's initial login to Zoomdata.
Zoomdata Version 3.5
What's New or Changed?
Chart modification and management options have been made more consistent. In past versions, most chart modification and management options were available on the left-rail menu only when a chart was maximized. With this release, all the modification and management options have been moved to a chart drop-down menu that is available in both maximized and normal view. As a consequence, the left-rail menu has been removed because it is no longer needed. In addition, the workflow for each of the chart modification and management functions changed. Note that when you select some options from the chart drop-down menu, a new sidebar may appear to assist with the option you selected.
See Using the Chart Drop-Down Menu for more information. In addition, refer to the documentation on each chart modification and management option for updated instructions on how to perform the function.
You can now copy charts in a dashboard. See Copying Charts for more information.
Wild card filters are now supported as chart filters. Wild card filters are row-level filters that allow you to filter and analyze the data in a chart that matches specific combinations of character patterns. See Applying Wild Card Filters to a Chart or Dashboard.
You can now apply the LAST VALUE function when a time-derived field is selected on the time bar. The LAST VALUE function is now supported for numeric-derived fields as well. See Connector Feature Support to determine which connectors support the LAST VALUE function and derived fields.
The way in which keysets are applied to a filter and the way in which they are deleted have changed in this release. The processes are now consistent with the processes for other types of filters. See Using Keysets for updated instructions.
Support for SAP IQ data stores has been added. A new SAP IQ connector is provided in this release. In addition, this connector supports Kerberos authentication. See Managing the SAP IQ Connector.
Zoomdata now provides a way for you to collect bundles of log files and trace data to assist with diagnostics. Please contact Zoomdata Technical Support ([email protected]) for additional information.
Fixed a problem in which users could not successfully execute PUT, PATCH or POST API requests when X.509 authentication was configured and enabled.
Fixed a problem in which dashboards could not be opened after upgrading to version 3.4 from 2.6.10.
Fixed a problem in which existing custom charts did not work after upgrading to version 3.5 from 2.6.10.
Zoomdata Version 3.4
What's New or Changed?
This release enhances Zoomdata's support for keysets. With keysets, you can perform multipass and multisource exploration of your data. The keyset creation flow has been improved. They can now be defined directly from charts and from data points in a chart using the radial menu (the radial menu changed as a result). In prior releases, keysets could only be added within the Save Filters dialog. For complete information about keysets, see Using Keysets.
The following changes were made to raw data tables in this release:
You can now sort a raw data table by multiple columns. This allows you to organize the data in the table more effectively. For more information, see Raw Data Tables (RDT).
The default width of a column in a raw data table is now a fixed width of 100 px. You can adjust the width of any column, but your changes are not saved. This change was introduced to improve the performance of raw data tables.
Dashboard controls have changed in this release:
The following controls have moved under the menu in the header: Share, Export, and Dashboard Links. In addition, the buttons for these functions have been removed from the dashboard header.
The dashboard controls that remain in the dashboard header have been rearranged. In addition to other moves, the filter button () has moved to the left of the dashboard title and the favorites button () and menu have moved to the right side of the dashboard header. Here's how the current header appears:
You can no longer request that your filter specifications show as a subheader for a chart. The Show Filters as Subhead option has been removed. A chart's subheader was only visible if it was the only chart in your dashboard or if you expanded (using the button) the chart in the dashboard.
Support has been added for Amazon Redshift versions up through version 1.2.16.
Kerberos support was added for Apache Phoenix 4.7 (or later) connectors. It is not provided for any version of the Phoenix QueryServer connector. See Enabling Kerberos Authentication for Apache Phoenix Connectors.
Support for row-level expressions has been added for Teradata data sources.
The last value function has been added for Elasticsearch.
- A new data type, IP Address, was added for Elasticsearch data connectors. Fields of this type are treated as ATTRIBUTEs and can be used in:
- An Elasticsearch text search box. When searching via the text search, Zoomdata also supports the CIDR notation for IP addresses as described in the Elasticsearch documentation (https://www.elastic.co/guide/en/elasticsearch/reference/current/ip.html).
- The Group By selection box.
- Filters, although Zoomdata does not support CIDR notation in filters for an IP address field. An exact match is required.
- Row-level expressions. In row-level expressions, Zoomdata treats IP addresses as strings and expect an exact match.
- Corrected a problem in which the
zoomdata.source.update.timeoutSecondsconnector property was not being processed properly.
- Corrected a problem in which Amazon Redshift connections were not being properly closed.
- Corrected a problem in which the custom CSS style sheet was not properly applied to the Zoomdata UI.
Zoomdata version 3.3
What's New or Changed?
The Spring Cloud library used by Zoomdata has been updated in this release. 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 workflow for creating a new dashboard in the Zoomdata user interface (UI) changed.
The Chart & Dashboards option on the New menu on the home page has been renamed Create Dashboard. After you select this option, an untitled, empty dashboard is created and you are prompted to select a data source and a chart type for it. In past releases, you were prompted to select a data source and a chart type before the dashboard was created. For more information, see Creating Dashboards.
The radial menu and the Apply Filter to dialog for charts in the Zoomdata UI have changed in the following ways:
- The radial menu no longer includes the Filter All and Unfilter All options. Instead, a new Select All checkbox has been added to the Apply Filter to dialog. When you select Filter on the radial menu, you can now apply the filter to all linked charts in a dashboard by clicking Select All on the resulting Apply Filter to dialog.
- The list of charts you can select on the Apply Filter to dialog are now listed in alphabetic order. If there are more charts listed on the dialog than easily fit on it, you can now scroll through the list.
- You can now cancel a filter using the new Cancel button on the Apply Filter to dialog.
- The Apply Filter to Selections button has been shortened to Apply on the Apply Filter to dialog.
For more information about the radial menu, see Using the Radial Menu. For information about applying filters to linked charts on a dashboard, see Using Cross-Source Links for Cross-Source Filtering.
A number of changes have been made that improve the cross-source link definition workflow:
- The Cross-source Links dialog now supports autocompletion and contextual searches when you are selecting data sources and fields for a link. If you enter a partial data source or field name, the list of sources and fields that you can select reduce to match the partial string you provided.
- The cross-source link data you supply on the Cross-source Links dialog is now validated. If you forget to supply some information, error messages display.
This release introduces administrator-defined functions that allow you to create functions at the connector level from SQL strings. These functions can be referenced later in data source configurations that use the connector. This support is provided only for SQL-based data sources that support row-level expressions in derived fields and custom metrics. See Admin-Defined Functions.
Derived time fields can now be used for the default time bar configuration.
Zoomdata now supports row-level calculations and derived fields for Drill connectors, except for the
Two new properties
pool.queue.size, residing in the
screenshot-service.propertiesfile 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.
If you used the Screenshot feature in versions of Zoomdata prior to 3.3, we recommend you upgrade to 3.3 to obtain fixes that were applied in 3.3.
In this release, Zoomdata replaced the
zoomdata-xvfbservice (which used Firefox version 45.7) with a new service called
zoomdata-screenshot-service(which uses the latest version of Chrome).
Support has been added for Apache Solr versions up through version 7.4.
Support has been added for Apache Drill versions up through version 1.13.
Charts are now exported correctly when using a custom pivot table.
Attempts to create a user visualization with the same name or type as a Zoomdata-supplied (built-in) visualization are now rejected with appropriate error messages.
Zoomdata Version 3.2
What's New or Changed?
Added the ability to link fields from different data sources on a dashboard. You can now simultaneously apply filters to all charts on a dashboard that use data sources with linked fields. In addition, you can simultaneously apply the same time filter using cross-linked fields in the time bar.
This new feature introduces a new dialog and new options on the time bar and filter menus. See Using Cross-Source Links.
Zoomdata now supports row-level calculations and derived fields for Redshift connectors.
You can now use the Manage Custom Charts page in the Zoomdata user interface to enable, download, import, and delete your custom charts. See Managing Custom Charts. Support for Chart Studio has been removed.
Added support for Custom Chart CLI version 4. 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.
CLI 4 must be used with Zoomdata 3.2 and later. CLI 3 should be used with Zoomdata 3.1 and earlier.
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
/distdirectory 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
/distdirectory within the custom chart directory. Note that this
/distcustom chart zip file is not compatible with the
zd-chart importcommand and cannot be imported using the Manage Custom Charts page in the UI. To import the
/distcustom chart zip file, use the
zd-chart pushcommand instead.
The following CLI command changes are included in CLI 4:
Command Update Made Description
Removed Use the
zd-chart importcommand instead.
Added Use this command to create a new chart in a folder you specify. This command combines the functions of the
Changed Updates the chart locally, but no longer pushes the updated chart to the server.
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.
Changed Watches changes in the
srcdirectory and pushes them to the server.
Removed Use the
zd-chart initcommand instead.
Removed Use the
zd-chart initcommand 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.
In version 3.2, 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.
The Chrome-based Zoomdata Screenshot service provided with Zoomdata v3.2 and later Zoomdata versions cannot be installed in CentOS v6 environments because the Google Chrome dependencies do not support that platform.
- Resolved a problem with newly created and time-shifted Impala sources that used partition-linked timestamps.
- Resolved a problem in which zip code areas in the US map were not colorized when you drilled to them.
Zoomdata Version 3.1
- Added the ability to specify any number of filter conditions for a data source field. Users will be able to combine conditions for the same numeric or attribute field using different numerical or text based operators (e.g. <, =, >, <>, include, exclude etc.) respectively.
- Introduced more intuitive logic that the application uses to combine filters that affect the same numeric or attribute field.
- Added user delegation support for Hive on Tez / LLAP connector.
- Added a new dashboard export service for taking PDF and screenshot image exports of a dashboard, and switched creation of dashboard thumbnails to use this service. The new service removes the dependency on separate installation of an older Firefox browser and Selenium drivers. Instead, the service uses headless Chrome which is included in the installation.
- Upgraded platform to use Spring Boot 2 which 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.
- Reduced the default for number of rows loaded per fetch to 250 for the raw data table in order to speed up performance for very wide tables. The new setting will only affect newly created data sources and continues to be configurable for each data source.
- Addressed a bug with Color range selector control where the slider movement didn’t take effect.
- Modified the Teradata connector to allow the query used to retrieve the list of collections from the data source to be configured.
- Fixed an issue where certain fields in Apache Solr and Elasticsearch, which should be allowed to be used for metrics were not correctly detected.
- Resolved a minor problem where an axis label was shifted on Histogram charts.
Zoomdata Version 3.0
- Elasticsearch 5 connector now supports derived fields (row level calculations). For more information, see Creating Calculations in Zoomdata.
- Oracle connector now supports derived fields (row level calculations).
- MySQL connector now supports derived fields (row level calculations).
- MemSQL connector now supports derived fields (row level calculations).
- Aurora connector now supports derived fields (row level calculations).
- Updated Visualization API documentation to list the set of objects, methods and APIs that developers should use when developing custom charts. This documentation is accessible by adding the following relative path
/zoomdata/sdk/docs/controller.htmlto your base Zoomdata server host URL in a standard installation. Contact your administrator if you are unable to access this documentation.
- Fixed an issue with importing of dashboards that use a flat file data source for one or more charts on the dashboard.
- Addressed a problem that occurred when the PostgreSQL connector is disabled and a user tries to setup a flat file or upload API data source.
- Resolved a bug where file data was loaded again when user went back in the source creation workflow for a flat file data source.
- Applied security fixes and updates.
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: https://www.npmjs.com/package/zoomdata-chart-cli.
Was this topic helpful?