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 (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.
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.
RetryCondition
Optionally specify under what conditions to retry a request.
Choose from:
- Never - Never retry a request.
- Http Status Error - Retry the request if the response status code is in the 4xx client error or 5xx server error categories.
- Network Error - Retry the request if a network error occurs. A network error is any low level network error that might occur. This could be a socket or connection timeout, TLS error and so on.
- Any Error - Retry the request if the response contains a http status error or a network error.
The default value is Never.
MaxRetries
Optionally specify the number of times to attempt an unsuccessful retry before error.
The default value is unlimited.
RetryTimeout
Optionally specify the maximum total amount of time to attempt to retry a failed request regardless of the number of attempts.
The default value is unlimited, the node will not timeout.
ProxyUrl
Optionally specify the URL of the proxy server to use for the HTTP requests. The URL should contain the protocol (http or https), the host, and the port. All other parts of the URL will be ignored.
The URL should be in a format similar to the following:
- HTTP proxy: http://proxy.example.com:1234
- HTTPS proxy: https://proxy.example.com:443
The node supports automatic detection of system proxy settings To override system proxy settings see the IgnoreSystemProxy property.
ProxyUsername
Optionally specify the proxy username, where the proxy requires authentication.
This property should be left blank if ProxyUrl is not set.
ProxyPassword
Optionally specify the proxy password, where the proxy requires authentication.
This property should be left blank if ProxyUrl is not set.
ProxyAuthenticationMethod
Optionally specify the authentication method used to verify the user of the proxy server. Choose from:
- Basic
- Digest
- NTLM
If it is not set - it will try to automatically detect the best one. Not set by default.
PassThroughFields
Optionally specify which input fields will "pass through" the node unchanged from the input to the output, assuming that the input exists. The input fields specified will appear on those output records which were produced as a result of the input fields. Choose from:
- All - Passes through all the input data fields to the output.
- None - Passes none of the input data fields to the output; as such, only the fields created by the node appear on the output.
- Used - Passes through all the fields that the node used to create the output. Used fields include any input field referenced by a property, be it explicitly (i.e., via a 'field1' reference) or via a field pattern (i.e., '1:foo*').
- Unused - Passes through all the fields that the node did not use to create the output.
The default value is Used.
If a naming conflict exists between a pass-through field and an explicitly named output field, an error will occur.
AsyncUpload
When set to true, then file contents is uploaded asynchronously.
The output provides the job URL that can be used outside of the node to get the status of the async file upload. The default value is False.
ConnectionTimeout
Optionally specify the maximum period (in seconds) to wait before the connection times out.
By default, a connection timeout period does not apply.
DataSourceExistsBehavior
Specify whether the data being published should be appended to an already existing data source on the Tableau Server or the data source should be overwritten. Choose from:
- Append - 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 can't append data to it.
- Overwrite - Overwrite a data source that has the same name specified in the DataSourceName property, if the data source doesn't exist then the operation succeeds.
- Error - Fail the node if a data source exists in Tableau that has the same name specified in the DataSourceName property.
The default value is Error.
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.