Primeur Online Docs
Data Shaper
Data Shaper
  • 🚀GETTING STARTED
    • What is Primeur Data Shaper
      • What is the Data Shaper Designer
      • What is the Data Shaper Server
      • What is the Data Shaper Cluster
    • How does the Data Shaper Designer work
      • Designer Views and Graphs
      • Data Shaper Graphs
      • Designer Projects and Sandboxes
      • Data Shaper Designer Reference
    • How do the Data Shaper Server and Cluster work
      • Data Shaper Server and Cluster
      • Data Shaper Server Reference
    • VFS Graph Components
      • DataOneFileDescriptor (DOFD) metadata
      • Passing parameters from Data One Contract to Data Shaper graph
      • Inheriting Data One context attributes in Data Shaper graph
  • DATA SHAPER DESIGNER
    • Configuration
      • Runtime configuration
        • Logging
        • Master Password
        • User Classpath
      • Data Shaper Server Integration
      • Execution monitoring
      • Java configuration
      • Engine configuration
      • Refresh Operation
    • Designer User Interface
      • Graph Editor with Palette of Components
      • Project Explorer Pane
      • Outline Pane
      • Tabs Pane
      • Execution Tab
      • Keyboard Shortcuts
    • Projects
      • Creating Data Shaper projects
      • Converting Data Shaper projects
      • Structure of Data Shaper projects
      • Versioning of server project content
      • Working with Data Shaper Server Projects
      • Project configuration
    • Graphs
      • Creating an empty graph
      • Creating a simple graph
        • Placing Components
        • Placing Components from Palette
        • Connecting Components with Edges
    • Execution
      • Successful Graph Execution
      • Run configuration
      • Connecting to a running job
      • Graph states
    • Common dialogs
      • URL file dialog
      • Edit Value dialog
      • Open Type dialog
    • Import
      • Import Data Shaper projects
      • Import from Data Shaper server sandbox
      • Import graphs
      • Import metadata
    • Export
      • Export graphs to HTML
      • Export to Data Shaper Server sandbox
      • Export image
      • Export Project as Library
    • Graph tracking
      • Changing record count font size
    • Search functionality
    • Working with Data Shaper server
      • Data Shaper server project basic principles
      • Connecting via HTTP
      • Connecting via HTTPS
      • Connecting via Proxy Server
    • Graph components
      • Adding components
      • Finding components
      • Edit component dialog box
      • Enable/disable component
      • Passing data through disabled component
      • Common properties of components
      • Specific attribute types
      • Metadata templates
    • Edges
      • Connecting Components with Edges
      • Types of Edges
      • Assigning Metadata to Edges
      • Colors of Edges
      • Debugging Edges
      • Edge Memory Allocation
    • Metadata
      • Records and Fields
        • Record Types
        • Data Types in Metadata
        • Data Formats
        • Locale and Locale Sensitivity
        • Time Zone
        • Autofilling Functions
      • Metadata Types
        • Internal Metadata
        • External (Shared) Metadata
        • SQL Query Metadata
        • Reading Metadata from Special Sources
      • Auto-propagated Metadata
        • Sources of Auto-Propagated Metadata
        • Explicitly Propagated Metadata
        • Priorities of Metadata
        • Propagation of SQL Query Metadata
      • Creating Metadata
        • Extracting Metadata from a Flat File
        • Extracting Metadata from an XLS(X) File
        • Extracting Metadata from a Database
        • Extracting Metadata from a DBase File
        • Extracting Metadata from Salesforce
        • SQL Query Metadata
        • User Defined Metadata
      • Merging Existing Metadata
      • Creating Database Table from Metadata and Database Connection
      • Metadata Editor
        • Opening Metadata Editor
        • Basics of Metadata Editor
        • Record Pane
        • Field Name vs. Label vs. Description
        • Details Pane
      • Changing and Defining Delimiters
      • Editing Metadata in the Source Code
      • Multi-value Fields
        • Lists and Maps Support in Components
        • Joining on multivalue fields (Comparison Rules)
    • Connections
      • Database Connections
        • Internal Database Connections
        • External (Shared) Database Connections
        • Database Connections Properties
        • Encryption of Access Password
        • Browsing Database and Extracting Metadata from Database Tables
        • Windows Authentication on Microsoft SQL Server
        • Snowflake Connection
        • Hive Connection
        • Troubleshooting
      • JMS Connections
      • QuickBase Connections
      • Hadoop Connections
      • Kafka Connections
      • OAuth2 Connections
      • MongoDB Connections
      • Salesforce Connections
    • Lookup Tables
      • Lookup Tables in Cluster Environment
      • Internal Lookup Tables
      • External (Shared) Lookup Tables
      • Types of Lookup Tables
    • Sequences
      • Persistent Sequences
      • Non Persistent Sequences
      • Internal Sequences
      • External (Shared) Sequences
      • Editing a Sequence
      • Sequences in Cluster Environment
    • Parameters
      • Internal Parameters
      • External (Shared) Parameters
      • Secure Graph Parameters
      • Graph Parameter Editor
      • Secure Graph Parameters
      • Parameters with CTL2 Expressions (Dynamic Parameters)
      • Environment Variables
      • Canonicalizing File Paths
      • Using Parameters
    • Internal/External Graph Elements
    • Dictionary
      • Creating a Dictionary
      • Using a Dictionary in Graphs
    • Execution Properties
    • Notes in Graphs
      • Placing Notes into Graph
      • Resizing Notes
      • Editing Notes
      • Formatted Text
      • Links from Notes
      • Folding Notes
      • Notes Properties
    • Transformations
      • Defining Transformations
      • Transform Editor
      • Common Java Interfaces
    • Data Partitioning (Parallel Running)
    • Data Partitioning in Cluster
      • High Availability
      • Scalability
      • Graph Allocation Examples
      • Example of Distributed Execution
      • Remote Edges
    • Readers
      • Common Properties of Readers
      • ComplexDataReader
      • DatabaseReader
      • DataGenerator
      • DataOneVFSReader
      • EDIFACTReader
      • FlatFileReader
      • JSONExtract
      • JSONReader
      • LDAPReader
      • MultiLevelReader
      • SpreadsheetDataReader
      • UniversalDataReader
      • X12Reader
      • XMLExtract
      • XMLReader
      • XMLXPathReader
    • Writers
      • Common Properties of Writers
      • DatabaseWriter
      • DataOneVFSWriter
      • EDIFACTWriter
      • FlatFileWriter
      • JSONWriter
      • LDAPWriter
      • SpreadsheetDataWriter
      • HIDDEN StructuredDataWriter
      • HIDDEN TableauWriter
      • Trash
      • UniversalDataWriter
      • X12Writer
      • XMLWriter
    • Transformers
      • Common Properties of Transformers
      • Aggregate
      • Concatenate
      • DataIntersection
      • DataSampler
      • Dedup
      • Denormalizer
      • ExtSort
      • FastSort
      • Filter
      • Map
      • Merge
      • MetaPivot
      • Normalizer
      • Partition
      • Pivot
      • Rollup
      • SimpleCopy
      • SimpleGather
      • SortWithinGroups
      • XSLTransformer
    • Joiners
      • Common Properties of Joiners
      • Combine
      • CrossJoin
      • DBJoin
      • ExtHashJoin
      • ExtMergeJoin
      • LookupJoin
      • RelationalJoin
    • Others
      • Common Properties of Others
      • CheckForeignKey
      • DBExecute
      • HTTPConnector
      • LookupTableReaderWriter
      • WebServiceClient
    • CTL2 - Data Shaper Transformation Language
    • Language Reference
      • Program Structure
      • Comments
      • Import
      • Data Types in CTL2
      • Literals
      • Variables
      • Dictionary in CTL2
      • Operators
      • Simple Statement and Block of Statements
      • Control Statements
      • Error Handling
      • Functions
      • Conditional Fail Expression
      • Accessing Data Records and Fields
      • Mapping
      • Parameters
      • Regular Expressions
    • CTL Debugging
      • Debug Perspective
      • Importing and Exporting Breakpoints
      • Inspecting Variables and Expressions
      • Examples
    • Functions Reference
      • Conversion Functions
      • Date Functions
      • Mathematical Functions
      • String Functions
      • Mapping Functions
      • Container Functions
      • Record Functions (Dynamic Field Access)
      • Miscellaneous Functions
      • Lookup Table Functions
      • Sequence Functions
      • Data Service HTTP Library Functions
      • Custom CTL Functions
      • CTL2 Appendix - List of National-specific Characters
      • HIDDEN Subgraph Functions
    • Tutorial
      • Creating a Transformation Graph
      • Filtering the records
      • Sorting the Records
      • Processing Speed-up with Parallelization
      • Debugging the Java Transformation
  • DATA SHAPER SERVER
    • Introduction
    • Administration
      • Monitoring
    • Using Graphs
      • Job Queue
      • Execution History
      • Job Inspector
    • Cluster
      • Sandboxes in Cluster
      • Troubleshooting
  • Install Data Shaper
    • Install Data Shaper
      • Introduction to Data Shaper installation process
      • Planning Data Shaper installation
      • Data Shaper System Requirements
      • Data Shaper Domain Master Configuration reference
      • Performing Data Shaper initial installation and master configuration
        • Creating database objects for PostgreSQL
        • Creating database objects for Oracle
        • Executing Data Shaper installer
        • Configuring additional firewall rules for Data Shaper
Powered by GitBook
On this page
  • Short Description
  • Ports
  • Metadata
  • TableauWriter Attributes
  • Details
  • Tableau Table Structure
  • Adding Libraries
  • Logging, temp configuration
  • Notes and Limitations
  • See also
  1. DATA SHAPER DESIGNER
  2. Writers

HIDDEN TableauWriter

PreviousHIDDEN StructuredDataWriterNextTrash

Last updated 1 month ago

Short Description

TableauWriter writes data in Tableau (.hyper) files. The component depends on native libraries - see below.

Extract Upgrade to .hyper Format

The .tde file format has been replaced by .hyper; therefore, you should change the file name extension in your existing graphs containing a TableauWriter component. For more information, see .

Also note that the hyper extract API 2.0 uses a new in-memory data engine which is faster but requires more RAM. The memory is used by native process (outside of Data Shaper) and is allocated dynamically depending on exported data-record size (the number and size of columns in the exported table). These requirements can reach several GB of RAM.

COMPONENT
DATA OUTPUT
INPUT PORTS
OUTPUT PORTS
TRANSFORMATION
TRANSF. REQUIRED
JAVA
CTL
AUTO-PROPAGATED METADATA

TableauWriter

Tableau binary file

1

0

x

x

x

x

x

Ports

PORT TYPE
NUMBER
REQUIRED
DESCRIPTION
METADATA

Input

0

✓

For received data records

Not all data types

Metadata

Input metadata of TableauWriter cannot contain data types decimal, byte and cbyte. Tableau types do not have sufficient precision for Data Shaper type decimal and the conversion would be lossy. A recommended alternative to decimal data type in TableauWriter is number (double). Data Shaper data types byte and cbyte do not have a corresponding Tableau data type.

Metadata containers (list, map) are not supported.

To set up mapping of particular metadata fields on Tableau metadata, use the attribute Tableau Table Structure.

TableauWriter Attributes

ATTRIBUTE
REQ
DESCRIPTION
POSSIBLE VALUES

Basic

File URL

yes

Specifies where received data will be written. The file name must have the .hyper suffix. If you are using graphs from previous versions containing TableauWriter, you should change the file extension from .tde to .hyper.

e.g. file.hyper

Table name

yes

The name of the table.

Default table collation

Value of the default collation used in the Tableau Table Structure dialog.

EN_US (default) | any from the list

Tableau table structure

See Tableau Table Structure below.

Advanced

Action on existing output file

Defines an action to be done if the output file already exists.

Overwrite table (replace the file) | Append to table | Terminate processing

Details

Tableau Table Structure

The Tableau Table Structure dialog serves to assign Tableau data types and collation to particular metadata fields.

The input field above the list of fields works as a filter to the displayed fields.

Adding Libraries

TableauWriter depends on native libraries. You need to download the libraries and set up your operating system to use it.

Linux

Download and unpack the Extract API for C/C++/Java.

Add Tableau’s directory bin to system PATH and lib64/tableausdk to system LD_LIBRARY_PATH.

Windows

Download and unpack the Extract API for C/C++/Java.

Add Tableau’s bin directory to system PATH.

Mac OS X

Download and open C/C++/Java Mac OS X .dmg (image file, 64-bit).

Drag TableauCommon.framework and TableauHyperExtract.framework directories to system /Library/Frameworks/.

Logging, temp configuration

It is advisable to set the following environment variables to specify working directories for the Extract API. If you don’t set these variables, the Extract API uses the current working directory as the default location.

  • TAB_SDK_LOGDIR - The folder where the Extract API writes the DataExtract*.log file.

  • TAB_SDK_TMPDIR - The temporary directory where the Extract API keeps intermediate (temporary) files, such as when it’s creating an extract.

Note: The directories specified by TAB_SDK_LOGDIR and TAB_SDK_TMPDIR must exist on the file-system and be writable. If the directories do not exist, the Extract API fails (with message Unknown error or Hyper Server did not start correctly: exit code: 1 or similar).

Notes and Limitations

When a .hyper file is open in Tableau application, Data Shaper cannot write into it.

TableauWriter cannot write data directly to .zip files via URL (e.g. zip:(/path/file.zip)#file.hyper) as the URL from the component is passed down to the Tableau library and the library cannot write zip files in this way.

Recommended Swap Size

On Linux, in the case of a small swap size, an exception may occur:

com.tableausoftware.TableauException: Cannot allocate memory - fork()

To prevent this, you can either:

  • increase the size of swap to equal the RAM size, or

  • allow memory overcommit (see overcommit accounting).

In the latter case, make sure you understand the implications.

Concurrent run of TableauWriter components

More TableauWriter components cannot run at the same time. If there is a TableauWriter component already running, and a second TableauWriter component needs to run, the graph with the second component fails.

See also

The libraries can be downloaded from .

For more information, see the Linux documentation: .

For more information, see last paragraph of .

More TableauWriters cannot write in the same as Tableau API is not threadsafe.

Extract Upgrade to .hyper Format
Installing the Extract API 2.0
Shared Libraries
Installing the Extract API 2.0
phase
Common properties of components
Specific attribute types
Common Properties of Writers