Hyper Write

Overview

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

Write-type Snap
Works in Ultra Tasks

Prerequisites

Tableau 10.5 or later version.
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. Here are the downloadables of Hyper APIs. Download and extract the zip file for the specific operating system:
To run the Tableau hyper pipelines in Groundplex, you must set the environment or system property TABLEAU_HYPER_LIBS to /home/lib (excluding /hyper) where the JCC is running.
Install Tabcmd Utility and Tableau Hyper Library. Learn more:
- Install and configure tabcmd and Tableau Hyper Library on Linux
- Install and configure tabcmd and Tableau Hyper Library on Windows

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 views


View	Description	Examples of upstream and downstream Snaps
Input	Parsed CSV data stream.	Examples: CSV Parser Binary Copy
Output	Creates a Hyper file.	Examples: Mapper
Error	Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are: Stop Pipeline Execution Stops the current pipeline execution when an error occurs. Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records. Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution. Learn more about Error handling in Pipelines.

Snap settings

Note:

Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.


Field / Field set	Type	Description
Label	String	Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.
Datasource	String	Required. Specify the Tableau datasource name on the server. If left empty, the name defaults to the current date and time as the default value. Default value: N/A Example: Test
Project	String	Required. Specify the project name to which hyper file should be published. Default value: N/A Example: Project Test
Schema Name	String/Expression	Required. Specify a schema name for the Tableau extract. If left empty, the Snap uses the default schema name `Extract`. Default value: N/A Example: schema_demo
Overwrite	Checkbox	Required. Select this checkbox to overwrite an existing datasource with the same name. Default value: Deselected
Append	Checkbox	Required. Select this checkbox to overwrite an existing datasource with the same name. Default value: Deselected
Certificate Check	Checkbox	Required. Select this checkbox to enable the tabcmd process to validate Tableau server SSL certificate. Default value: Selected
Snap execution	Dropdown list	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.

Examples

Create and write Hyper file to the SL database