Hyper Write

In this article

Overview

You can use this Snap to create a hyper file in local disk for incoming documents and publish it to Tableau Server/Online without packaging it into a data source.

Prerequisites

  • Tableau 10.5 or later version.

  • Install Tabcmd tool with Snap user on Groundplex node to publish the file to Tableau Online or Tableau Server.

  • 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.

  • Tableau Hyper Snaps use Tableau Hyper API version 21.0.0.12982. You must have the Java Native Access (JNA) and shared libraries of the same API version for the respective Operating System on which you run your Tableau Pipelines. You can download the files for your operating system (Windows, Mac, and Linux) using this link: Hyper API 0.0.12982 .

Support for Ultra Pipelines

Does not work in Ultra Pipelines.  

Limitations

To publish hyper files without packaging them as a data source, the file must contain exactly one schema in one table.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min:1

  • Max:1

  • Copy

  • CSV Parser

Parsed CSV data stream.

Output

Document

 

  • Min:0

  • Max:1

  • Mapper

Creates a Hyper file.

Snap Settings

Field Name

Field Dependency

Description

Field Name

Field Dependency

Description

Label*

None.

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.

Default ValueELT Database Account
ExampleELT RS Account

Datasource

N/A

Specify the name of the Tableau data source on the server. If left empty, the Snap takes the current date and time as the default value.

Project

N/A

Specify the project name to which hyper file should be published.

Schema Name

N/A

Specify a schema name for the Tableau extract. If left empty, the Snap uses the default schema name Extract.

Default ValueExtract
ExampleExtract

Overwrite

N/A

Select this checkbox to overwrite an existing data source with the same name.

Append

N/A

Select this checkbox to append an existing data source with the same name.

Certificate Check

N/A

Select this checkbox to enable the tabcmd process to validate Tableau server SSL certificate.

Snap Execution

N/A

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

    Default Value: Validate & Execute
    Example: Execute only

Troubleshooting

None.

Example

Creating Hyper File And Writing On To Local Database

This example Pipeline demonstrates how we can use the Hyper Writer Snap to create a hyper file and write it on to the local database.

Initially, we configure the Pipeline with the File Reader Snap to read 123.csv file from the SL database.

Upon validation, we see the following binary data in the output preview of the Snap.

Next, we configure the CSV Parser Snap to parse the CSV file.

Upon validation, we see the parsed CSV data in the output preview of the Snap.

Next, we configure the Hyper Write Snap to create a .hyper file and publish it without packaging it into a data source.

Upon validation, we see the following hyper data in the output preview of the Snap.

Next, we configure the JSON Formatter Snap to read the hyper document stream and write the data to output.

Upon validation, we see the following output in the preview of the Snap.

Finally, we configure the File Writer Snap to write the hyper file to the SL database.

Download this Pipeline.

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

 

Snap Pack History

Release 

Snap Pack Version

Date

Type

  Updates

4.26

main11181

Aug 14, 2021 

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

May 8, 2021 

Stable

Upgraded with the latest SnapLogic Platform release.

4.24

main8556

Feb 13, 2021 

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.

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

Nov 14, 2021 

Stable

Upgraded with the latest SnapLogic Platform release.

4.22

main6403

Sep 12, 2020 

Stable

Upgraded with the latest SnapLogic Platform release.

4.21

snapsmrc542

May 9, 2020 

Stable

Upgraded with the latest SnapLogic Platform release.

4.20

snapsmrc535

Feb 8, 2020 

Stable

Upgraded with the latest SnapLogic Platform release.

4.19

snaprsmrc528

Nov 19, 2019 

Stable

Upgraded with the latest SnapLogic Platform release.

4.18

snapsmrc523

Aug 10, 2019 

Stable

Upgraded with the latest SnapLogic Platform release.

4.17

ALL7402

Jun 11, 2019 

Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17

snapsmrc515

Jun 11, 2019 

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

Feb 16, 2019 

Stable

Upgraded with the latest SnapLogic Platform release.

4.15

snapsmrc500

Dec 15, 2018 

Stable

Upgraded with the latest SnapLogic Platform release.

4.14

snapsmrc490

Aug 15, 2018 

Stable

Upgraded with the latest SnapLogic Platform release.

4.13

snapsmrc486

May 12, 2018 

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

Feb 17, 2018 

Stable

Upgraded with the latest SnapLogic Platform release.

4.11

snapsmrc465

Nov 11, 2017 

Stable

Upgraded with the latest SnapLogic Platform release.

4.10

snapsmrc414

Aug 12, 2017 

Stable

Upgraded with the latest SnapLogic Platform release.

4.9

snapsmrc405

May 13, 2017 

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

Mar 17, 2017 

Latest

Addressed an issue where the TDE Formatter threw a Field conversion failed error.

4.8

snapsmrc398

Feb 11, 2017 

Stable

Upgraded with the latest SnapLogic Platform release.

4.7

snapsmrc382

Nov 23, 2016 

Stable

Upgraded with the latest SnapLogic Platform release.

4.6

snapsmrc362

Aug 13, 2016 

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

May 18, 2016 

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.


See Also