| Info |
|---|
This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/snaps/snaps-analytics/sp-tableau/snap-tableau-hyper-formatter.html. |
In this Article
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
You can use this Snap to convert the incoming documents into a Tableau hyper extract file and send the extract to the binary output view.
The Tableau Hyper Formatter Snap requires additional time to convert a temporary CSV file into a Hyper Extract file. When the Snap processes a larger number of input documents, the time taken to generate the hyper file will naturally increase. This behavior is expected and is inherent to the functioning of the Snap.
...
You can configure multiple input views in this Snap as the hyper file contains multiple tables. The table names for the hyper file is taken from the View Labels that you configure in Views.
...
...
| Multiexcerpt macro | ||||||
|---|---|---|---|---|---|---|
| ||||||
Prerequisites
|
...
To run the Tableau hyper Pipelines in a plex, you must set the environment or system property TABLEAU_HYPER_LIBS to hyper/ (excluding hyper folder) where the jcc is running.
|
...
|
...
| Appsplus panel macro confluence macro | ||
|---|---|---|
| {"features":["title","icon","rounded"],"title":"Tableau Hyper lib setup","titleColor":"#FFFFFF","titleColorBG":"#4c9aff","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#e6eeea","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} | ||
Tableau Hyper is Tableau's in-memory data engine technology optimized for fast data load and analytical query processing on large or complex data sets. In Tableau 10.25, new extracts use the
Unzip the Tableau package and place the native Hyper API library in a directory or folder accessible by the Java application. Move the
If you move the Method-1
Method-2
| ||
|
Support for Ultra Pipelines
Does not work in Ultra Pipelines.
Limitations
...
None.
and Known Issues
None.
Snap
...
Input/Output
...
Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| Data in document format. |
Output | Binary |
|
| Document in binary format. |
Snap Settings
Field Name | Field |
|---|
Type | Description |
|---|---|
Label* |
| String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. |
Schema Name
|
Extract |
Schema Name
Extract | String/Expression | Specify a schema name for the Tableau extract. If this field is left |
blank, the Snap uses the default schema |
Extract. |
Snap Execution Default Value: |
Validate & Execute |
Snap Execution
N/A
Execute only | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
|
Default Value: Validate & Execute
Example: Execute only
|
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
| The
| When you encounter this error, follow these steps to resolve the issue:
If the issue still persists, contactsupport@snaplogic.com. |
Example
Transforming Data
...
into Hyper Format and Publishing
...
the Datasource
This example Pipeline demonstrates how we can to transform data into hyper extract format and publish the datasource data source in the Tableau server.
Publishing a datasource data source in the Tableau server is essentially a threefour-step process:
Transform data into hyper extract
Initiate file upload
Append
...
file upload
Publish
...
data source
We have three Tableau REST Snaps in this Pipeline, each calling these threeAPIsthree APIs: initiate_file_upload, append_file_upload, and publish_datasource.
...
Initially, we pass the following parameters in the Pipeline as key-value pairs:
Key | Value |
|---|---|
projectid | 87473786-9edd-495d-9820-c9ecbc928fe1 |
siteid | b3013847-c198-4a1e-8650-9f43f9d5e9f2 |
hyperfilename | test.hyper |
...
Transform data into hyper extract
Step 1: Configure the JSON Generator Snap to pass product information with the required following sub elements, such as : Category, Product ID, Product Name,and Sub-Category.
...
Upon validation, we get the product data in the output preview of the , and validate the Snap.
...
Data Configuration | Data Output |
|---|---|
 |  |
Step 2: Configure the Hyper Formatter Snap to format the JSON data output into Tableau hyper format. We configure Configure the views with one input view Table_name_product. This view label name will be is used as the table name in the hyper file in the output.
Hyper Formatter Snap Configuration | Hyper Formatter Views |
|---|---|
 |  |
Next, we configure Step 3: Configure the File Writer Snap to write the transformed hyper format data file, test.hyper to the SL database. Upon validation, the hyper data file test.hyper is written to the SL database.
File Writer Snap Configuration | File Writer Output |
|---|---|
 |  |
...
Initiate File Upload
Step 1: Configure the Mapper Snap to pass the datasource Type and SiteId inputs for initializing the file upload . Hence, we pass the datasource Type, SiteId, and specify whether the file should be overwritten.
...
Upon validation, we get the following data in the output preview of the Snap.
...
Next, we configure and validate the Snap.
 |  |
Step 2: Configure the Tableau REST Snap to initiate the file upload operation using the REST operation.
...
Upon validation, the Snap Step 3: Validate the Snap—it establishes an upload session and creates a unique session ID. Since Because the file is not uploaded in this operation, the value of the $filezSize field is 0. A preview of the output from the Tableau REST Snap is as shown below:
...
...
Append to file upload
Step 1: Configure the Mapper Snap to append the uploaded file. Hence, we We pass the fileSize, uploadSessionId, and siteId values to the downstream Tableau REST Snap.
...
Upon validation, we get the following output (fileSize, uploadSessionId, and siteId).
...
Next, we configure Step 2: Validate the Snap—the following output is displayed:
...
Step 3:Configure the Tableau REST Snap to append the file to Tableau Online Site (repository/folder) in which the appended file will be placed. Hence, we We use the REST operation append_file_upload to append the test.hyper file and also provide the target file’s name. This operation creates a resource location for the uploaded file (test.hyper).
...
Upon validation, the Step 4: Validate the Snap—the file is uploaded in chunks to the site (based on $siteId). In the Snap's output preview we can notice that the session ID of the upload session is the same as that generated in the "Initiate" step.
...
...
Publish data source
Step 1: Configure the Mapper Snap to map the fields from the output of the second Tableau REST Snap to use be used in the downstream Snap. So, we pass the datasource type, uploadSessionId, siteId, hyperfilename and projectId, and specify whether we want to overwrite the file.
While .
Note: uploadSessionId is an input from the previous REST operation, whereas the siteId, hyperfilename, and projectId are the hardcoded values passed in the Pipeline parameters.
...
Upon validation, we get Step 2: Validate the Snap—it displays the following output in the preview of the Snap.:
...
Next, we configure Step 3: Configure the last Tableau REST Snap to publish the datasource data source to Tableau instance. This Snap uses the inputs from the upstream Snap to determine how to publish the file online. We use the REST operation publish_datasource to accomplish this task.
...
Upon validation, we get Step 4: Validate the Snap—it displays the following output in the preview of the Snap.
...
Upon executing Step 5: Execute the Pipeline, the hyper extract file test.hyper is uploaded to Tableau instance and stored under the External Assets group.
...
Once After the file is uploaded to Tableau, we you can use this data for visualization of product information in terms of as graphs or pie charts.
Download this Pipeline. attachments
Downloads
...
| patterns | *.slp, *.zip |
|---|
Snap Pack History
...
Release
...
Snap Pack Version
...
Date
...
Type
...
Updates
...
4.26
...
main11181
...
...
Stable
...
Added the following Tableau Snaps to support hyper extract files for Tableau 10.25 and later versions.
Hyper Formatter: Converts the incoming documents to Tableau hyper extract format and sends the output (extract) to the binary output view.
Hyper Parser: Parses Tableau hyper extract files and converts them to a document format.
Hyper Write: Creates a hyper file in a temporary location (local disk) for incoming documents and publishes it to Tableau Server/Online without packaging it into a data source.
...
4.25
...
main9554
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.24
...
main8556
...
...
Stable
Fixes an issue when updating user information in the Tableau REST Snap by not overwriting the site ID or user ID if the entries already exist.
| Info |
|---|
Behavioral Change In the 4.23 release, the Tableau REST Snap had a defect where it used site ID and user ID from the Tableau Account even if the selected REST operation required a site ID and/or user ID from the input document. This issue is fixed in the 4.24 release, so that the Snap uses values for the said IDs from the input document when available. Since this fix changes the Snap behavior, it is possible for production Pipelines to fail after the 4.24 release. Hence, you need to reconfigure the Tableau REST Snap using the site ID and user ID values from the input document. |
...
4.23
...
main7430
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.22
...
main6403
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.21
...
snapsmrc542
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.20
...
snapsmrc535
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.19
...
snaprsmrc528
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.18
...
snapsmrc523
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.17
...
ALL7402
...
...
Latest
...
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
...
4.17
...
snapsmrc515
...
...
Latest
...
Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
...
4.16
...
snapsmrc508
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.15
...
snapsmrc500
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.14
...
snapsmrc490
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.13
...
snapsmrc486
...
...
Stable
...
Enhanced Tableau Snap Pack to support Tableau version 10.5 (Server version), this includes support for refresh task related REST API calls in the Tableau REST Snap.
...
4.12
...
snapsmrc480
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.11
...
snapsmrc465
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.10
...
snapsmrc414
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.9
...
snapsmrc405
...
...
Stable
...
Extended the support for Tableau 9 and 10 REST Snap to access the TDE files on S3 (using the IAM role on the Snap Account).
Support extended for Tableau 10.1 server version.
Updated the Snap account with the properties, XML Schema URL and API version (other).
Updated the Snap account with Access Key ID, Secret Key and IAM role to support access to files on S3.
Tableau REST Snap extended support to access the TDE files on S3.
...
4.8
...
tableau92770
...
...
Latest
...
Addressed an issue where the TDE Formatter threw a Field conversion failed error.
...
4.8
...
snapsmrc398
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.7
...
snapsmrc382
...
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.6
...
snapsmrc362
...
...
Stable
...
Enhanced to support chunking when publishing large files for the Tableau 9&10 REST Snap.
Enhanced error reporting when fields are improperly mapped from input Tableau 9&10 REST Snap.
Enhanced error handling to appropriately route errors in the Tableau 9&10 Write Snap.
Enhanced error handling to appropriately route errors in the Snap for the TDE Formatter Snap.
Extended the TDE Formatter Snap support for Linux Snaplexes.
Doc Enhancement: Examples added to Tableau 9 Snap documentation.
Resolved an issue in Tableau REST Snap that caused failures when publishing workbook and datasources.
Resolved an issue in TDE Formatter and Tableau REST Snap that cause errors on Windows Groundplex.
Resolved an issue in Tableau REST Snap that only made available 100 entries of datasource.
...
4.5.1
...
tableau91634
...
...
Latest
...
Initial release of the Snap Pack with Tableau 9&10 REST, Write and the TDE Formatter Snaps.
Supports Tableau 9.1 version of Tableau server.
...
| Info |
|---|
Important Steps to Successfully Reuse Pipelines
|
| Attachments | ||
|---|---|---|
|
Snap Pack History
| Excerpt |
|---|
...
Related Content
https://help.tableau.com/current/api/hyper_api/en-us/index.html
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
...