Was this page helpful?
Yes No

Extract Upgrade to .hyper Format

Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the tabadmin command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.

Beginning in version 10.5, new extracts use the .hyper format instead of the .tde format. Extracts in the .hyper format take advantage of an improved data engine, which supports the same fast analytical and query performance as the data engine before it, but for even larger extracts.

This article covers what you and your users should be aware of as a result of the extract format change in version 2019.1 and how the change impacts your users.

Changes to extracts in version 10.5

With the introduction of Tableau's improved data engine technology, Hyper, comes a change to the extract format. As mentioned above, extracts created in version 2019.1 use the .hyper format. Though Tableau version 2019.1 can continue to read .tde extracts, it cannot create new .tde extracts. The impact of this format change means that when certain extract tasks are performed either by a user or by Tableau Server, such as an extract refresh or append data, the .tde extract is automatically upgraded and converted to a .hyper extract.

After an extract is upgraded to a .hyper extract, your users can interact with the .hyper extract as they would a .tde extract. However, your users should be aware of the following backward limitations:

  • The upgrade can't be reversed. An upgraded extract can't be converted back to a .tde extract.

  • The upgraded extract can't be opened in Tableau Desktop 10.4 and earlier.

  • Workbooks that contain upgraded extracts can't be published as an older version from Tableau Desktop to Tableau Server.

  • Workbooks that contain upgraded extracts can't be downgraded as an older version in Tableau Desktop.

  • Workbooks that contain an upgraded extract, which are downloaded from Tableau Server using the Download Tableau Workbook option, cannot be opened in Tableau Desktop 10.4 and earlier.

Tasks that cause extract upgrade

There are three distinct ways a .tde extract can get upgraded to a .hyper extract: 1.) during an extract refresh (full or incremental), 2.) when appending data to an extract, and 3.) when an extract is upgraded manually using Tableau Desktop 2019.1. After an extract has been upgraded, the original .tde extract is automatically removed from Tableau Server if it's not being reference by other workbooks.

The followings tasks on Tableau Server automatically upgrades and converts a .tde extract to a .hyper extract:

  • Manual extract refresh

  • Scheduled extract refresh

  • Automated refresh task that's performed through tabcmd

  • Automated refresh task that's performed through the Extract Command-Line Utility

  • Automated append data to an extract using tabcmd

  • Automated append data to an extract using the Extract Command-Line Utility

Impact of extract upgrade

Tableau recommends that the Tableau Desktop version in your environment be upgraded to match Tableau Server 2019.1. If they don't match, extract compatibility can be an issue depending on the task your users want to perform.

To get a better understanding of when extract upgrades can occur and potential compatibility issues your users might experience, review a detailed explanation of the extract compatibility scenarios on the Tableau Support page or a summary explanation below.

Note: In the tables below, "10.4" represents Tableau 10.4 and earlier and "10.5" represents Tableau 10.5 and later.

Performing tasks on Tableau Server 10.5

When working with extracts created in Tableau Desktop 10.4 and earlier, your users should be aware of the following extract-related compatibility scenarios around common tasks performed on Tableau Server 10.5.

 

Task

10.4 workbook 10.5 workbook
.tde extract .tde extract .hyper extract
Publish from Tableau Desktop 10.4 Not possible Not possible
Publish from Tableau Desktop 10.5
Refresh, scheduled refresh, or append Workbook version remains unchanged, but extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format
Edit/save in web authoring Workbook version changes to 10.5, extract remains in .tde format
Edit/save in web authoring then refresh or append Workbook version changes to 10.5, and extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format

Downloading from Tableau Server 10.5

When working with extracts created in Tableau Desktop 10.4 and earlier, your users should be aware of the following extract-related compatibility scenarios when downloading from Tableau Server 10.5.

 

Task

10.4 workbook 10.5 workbook
.tde extract .tde extract .hyper extract
Download and open in Tableau Desktop 10.4 Can't open workbook; you see a "this workbook uses a .hyper extract and is not compatible with this version; open the workbook in version 10.5 or later" error message, and then asked to locate the extract Can't open workbook; you see a "this file was created by a newer version; upgrade Tableau" error message
Download and open in Tableau Desktop 10.5
Export As Version from Tableau Desktop 10.5 Option is greyed out

Automating refresh and append tasks

When working with extracts created in Tableau Desktop 10.4 and earlier, your users should be aware of the following extract-related compatibility scenarios around automating refresh and append tasks using tabcmd or the Tableau Command-Line Utility.

 

Task

10.4 workbook 10.5 workbook
.tde extract .tde extract .hyper extract
Refresh or append using 10.4 tabcmd Workbook version remains unchanged, but extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format
using 10.5 tabcmd Workbook version remains unchanged, but extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format
Publish using 10.4 tabcmd Not possible
using 10.5 tabcmd Not possible Not possible
Refresh or append using 10.4 Tableau Command-Line Utility Not possible Not possible
using 10.5 Tableau Command-Line Utility Workbook version remains unchanged, but extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format

Why keep an extract in .tde format?

If the version of Tableau Desktop cannot be upgraded to match Tableau Server 2019.1, your users will need to keep their extracts in .tde format.

How to keep an extract in .tde format

To keep an extract in the .tde format, the extract should not be upgraded. To help your users keep their extracts from upgrading, advise them against performing any of the tasks listed above in the Extract Upgrade to .hyper Format section. Then, consider the following suggestions to maintain a .tde version of an extract:

  • Disable existing extract refresh schedules on Tableau Server until you can identify which extracts should and shouldn't be upgraded.

    Note: To access an extract’s refresh schedule, you must be a data source owner, or be a server administrator, site administrator, or Project Leader. For more information about which site roles allow full Project Leader capabilities, see Project-level administration.

  • Continue to perform extract refresh and append data tasks using Tableau Server 2019.1, but maintain an earlier version of Tableau Desktop and the ability to connect to the original data in case you need to recreate the .tde extract.

  • Use an earlier version of Tableau Desktop to perform extract tasks, such as extract refresh or append data.

What to expect after extract upgrade

After an extract upgrade has taken place, your users should expect some additional changes when working with extracts in version 2019.1. For more information, see After an extract upgrade section in Tableau Help.