When you set up a Tableau V3 connection, you must configure the connection properties.
The following table describes the Tableau V3 connection properties:
Connection property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Tableau V3
Runtime Environment
The name of the runtime environment where you want to run the tasks.
Tableau Product
The name of the Tableau product to which you want to connect.
You can choose one of the following Tableau products to publish the .hyper file:
Tableau Desktop
Creates a .hyper or TWBX files in the Secure Agent machine. You can then manually import the .hyper or TWBX files to Tableau Desktop and use the files to perform append or overwrite operation.
Tableau Server
Publishes the generated .hyper file to Tableau Server.
Tableau Online
Publishes the generated .hyper file to Tableau Online.
Authentication Method
The authentication method to connect to Tableau Server or Tableau Online.
Select one of the following methods:
- Username & Password. Uses your Tableau account user name and password to connect to Tableau Server or Tableau Online.
- Personal Access Token. Uses the personal access token and token secret from your Tableau account to connect to Tableau Server or Tableau Online.
Connection URL
The URL of the Tableau Server or Tableau Online where you want to publish the data extract file.
The URL has the following format:
http://<Host name of Tableau Server or Tableau Online>:<port>
User Name
The user name for the Tableau Server or Tableau Online account.
Password
The password for the Tableau Server or Tableau Online account.
Personal Access Token Name
The personal access token to connect to the Tableau Server or Tableau Online account.
Token Secret
The token secret associated with the personal access token to connect to the Tableau Server or Tableau Online account.
Site ID
The site name that points to a specific site on Tableau Server or Tableau Online where you want to publish the data extract file.
Contact the Tableau administrator to provide the site ID.
Schema File Path
The path of the data extract file required to import the Tableau metadata.
Enter one of the following options for the schema file path:
- Directory path for the .hyper files.
- Empty directory path.
When you provide the Tableau schema file path, the Secure Agent generates the .hyper file from the source object based on the data representation in the specified target directory.
You can only specify an empty directory if you want to publish the .hyper file to Tableau Server or Tableau Online.
When you do not specify a schema file path, the Secure Agent displays the projects and data sources that are present on Tableau Server or Tableau Online when you select the target object in the Object target properties.
The Secure Agent uses the following default file path for the target .hyper file:
You can specify the name of the site ID to point to a specific site on Tableau Server or Tableau Online where you want to publish the .hyper file. Specify the site ID in the connection properties.
The site ID has the following format: http://<Host name of Tableau Server or Tableau Online>:<port> /#/site/<Name of the site ID>/View in Tableau Server or Tableau Online>
For example, if you create a site called infa on Tableau Server, the site ID for the site on Tableau Server is: https://10.50.100.100:6000/#/site/infa/workbooks
The value you specify for the site ID in the connection properties is Infa.
To specify an existing site ID on Tableau Server or Tableau Online where you want to publish the Tableau .hyper, contact the Tableau Server or Tableau Online administrator.
Note: To specify the default site for Tableau Server, make the Site ID value an empty string (Site ID="").
Schema file path
When you create a Tableau V3 connection, you can specify the path to a .hyper file from where the Secure Agent imports the Tableau sample .hyper file.
You do not have to specify the Schema File Path connection property when you use the Create Target option. When you do not use the Schema File Path connection property to create a target object, you can create a target by using the Create Target option in a mapping task.
You need to select the Tableau sample .hyper file that you want in the target .hyper file and provide a name for the target object .hyper file. The Secure Agent creates a target .hyper file in the specified location. If you do not specify a name and directory path for the target .hyper file in the connection properties, you can provide the extract file path and file name for the target .hyper file in the advanced properties of the mapping task.
The Secure Agent generates the target object .hyper file from the source object based on the data representation in the specified target directory.
You can use one of the following options for the schema file path:
Directory path for the .hyper files
Enter a directory path that contains the .hyper files. For example, enter the following directory path: C:\tableau
When you configure a mapping task, the .hyper files that are available in the specified directory appears in the target object list. Select a schema .hyper file to fetch the metadata from that file.
Empty directory path
If you do not want to use a Tableau sample .hyper file, enter an empty directory path.