Upload Tableau Hyper (.hyper) files directly to a Tableau Server.
Can be used in conjunction with the "Tableau Output" node to first create Tableau Hyper (.hyper) files from data within your Data Flow, and then make the data available on a specified Tableau Server.
Properties
SourceFileName
Specify the path of the hyper file. Only the .hyper file type is supported.
If the file name is to be read from an input field, then choose the the (from Field) variant of this property to specify the name of the input field containing the file path.
A value is required for this property.
ServerURL
Specify the Tableau server URL that you wish to upload to.
Example https://my-tableau-server.com/api. The URL must be correctly formatted, or the node will fail.
If the server URL is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the url.
A value is required for this property.
TableauAtuthenticationType
Specify which authentication method is to be used.
- Username and Password - Both Username and Password properties are mandatory for this authentication type.
- Personal Access Token - Both PersonalAccessToken and PersonalAccessTokenSecret properties are required for this authentication type.
If the TableauAtuthenticationType is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the authentication type.
The default is Username and Password authentication.
UserName
Specify the username of the user to sign in as. The user must have ExportXml permissions for the data source (either explicitly or implicitly), on the Tableau server.
If the username is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the username.
Password
Specify the password of the user.
If the password is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the password.
PersonalAccessToken
Specify the personal access token to log in to Tableau server if authentication type is selected as Personal Access Token.
If the personal access token is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the personal access token.
PersonalAccessTokenSecret
Specify the personal access token secret to log in to Tableau server.
If the personal access token secret is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the personal access token secret.
SiteName
Optionally specify the site name. Leave this property blank to connect to the default site.
If the SiteName is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the SiteName.
DatasourceName:
Specify the name of the data source.
If the DataSourceName is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the DataSourceName.
A value is required for this property.
ProjectName
Optionally specify the project name to assign the data source to.
If the ProjectName is to be read from an input field then choose the (from Field) variant of this property to specify the name of the input field containing the ProjectName.
If the project is not specified, the data source will be published to the default project.
UploadBufferSize
Specify the size of the chunks that the Hyper file gets uploaded to the server in.
The default size of chunk is 64 MB.
ApiVersion
The version of the API to use, such as 3.11. For more details visit https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm.
The default value is 3.11. This will be substituted in the server URL.
A value is required for this property.
OverwriteFlag
Specify whether or not the data source on the Tableau Server should be overwritten if it already exists.
- True - Overwrite a data source that has the same name, if the data source doesn't exist then the operation succeeds.
- False - Node fails if the specified data source already exists.
You can specify both the OverwriteFlag and AppendFlag properties on the node, but they cannot both be set to true.
The default value is False.
AppendFlag
Specify whether the data being published should be appended to an already existing data source.
-
True - Append the data being published to an existing data source that has the same name specified in the DataSourceName property. If the data source does not exist then the operation fails. In order to append data to a published data source on the Tableau Server, both the source file and the published file must be an extract with the file extension
.hyper. The schema of the source and the published extract must match. If an extract was stored using the multiple tables option, you cannot append data to it. - False - Do not append the data being published to an existing data source. If the data source specified already exists then the behavior will be as specified in the OverwriteFlag property.
You can specify both the OverwriteFlag and the AppendFlag properties on the node, but they cannot both be set to True.
The default value is False.
ProcessingErrorBehavior
Optionally specify the behavior of the node if any kind of error occurs during the process of preparing and uploading a hyper file. The error will always be written on the error output pin.
Choose from:
- Error - Log an error to the Errors panel and node fails.
- Log - Log a warning to the Errors panel.
- Ignore - Ignores the error.
The default value is Error.
Inputs and outputs
Inputs: Files.
Outputs: Results, Errors.