Run Manual QA Tests


After you create your connector and validate it using TDVT, run these manual quality assurance tests to confirm that your connector works as expected.

Before you begin

Be sure that you complete all the following steps before you begin the manual tests for your connector.

  1. Make sure your computer or virtual machine is running Windows, macOS or Linux.
  2. Install and run Tableau Desktop and Tableau Server.
  3. Install an ODBC or JDBC driver for your database on Tableau Desktop and Tableau Server.
  4. Setup your connectors following these guidelines.

On Tableau Desktop

On Tableau Server

  1. Set the native_api.connect_plugins_path option. For example:
     tsm configuration set -k native_api.connect_plugins_path -v D:/tableau_connectors
    

    If you get a configuration error during this step, try adding the --force-keys option to the end of the command. Note: On Linux, make sure the connectors folder can be accessed by tsm. For example:

     tsm configuration set -k native_api.connect_plugins_path -v /var/tmp/plugins –force-keys
    
  2. Run the following command to apply the pending configuration changes. This will restart the server.
     tsm pending-changes apply
    

    For more information about tsm, see tsm Command Line Reference in Tableau Server on Windows Help or Tableau Server on Linux Help.

Test your connector with Tableau Desktop

Check company name

If your company name doesn’t display, make sure your company name is defined in the manifest.xml file.

<vendor-information>
    <company name="Company Name"/>
</vendor-information>

Connect to the database with valid credentials

  1. Connect and cancel. After you click your connector, close the window. It should return to the previous window without error.

  2. Make valid entries in each field (Server, Username, Password, Port, etc.) and verify that you can connect.

  3. Verify that the default connection name is correct, and that you can change it.

  4. Verify that you can connect using all supported methods of authentication.

  5. Verify that you can connect to a data source with SSL, if applicable. Select the Require SSL check box, and then click Sign In.

  6. Verify that you can duplicate the data source and that the duplicate source name has “(copy)” appended to the end.

  7. Verify that the data source connection properties are correct.

Test extracts

  1. Create an extract. Right-click the data source, then click Extract Data. Verify that you can create an extract without errors.

  2. Refresh an extract.

For more information, see Refresh Extracts in Tableau Desktop and Web Authoring Help.

Edit your connection

Change all possible items and verify that changes are applied.

  1. Right-click the data source and click Edit Data Source.
    The worksheet opens in Tableau.
  2. In the left pane, under Connections, click the drop-down menu next to the server name and click Edit Connection.
  3. Change something. For example, change the server.
  4. After you click Sign In, you should see the new server name under Connections.

Open a workbook with the connector missing

  1. Create a workbook with a live connection using your connector.

  2. Save the workbook. The file should have a .twb filename extension.

  3. Close Tableau Desktop and remove your connector.

  4. Open Tableau Desktop and open the workbook you created. Verify that an error message displays:

Connect to a published data source with the connector missing

  1. Remove your connector.

  2. Use Tableau Desktop to connect to a published data source with an extract. You should be able to connect without errors.

  3. Use Tableau Desktop to connect to a published data source without an extract. Verify that an error message displays:

Download and open a workbook with the connector missing

  1. Remove your connector.

  2. Download a workbook with an extract from Tableau Server and open it in Tableau Desktop. The workbook should open without errors.

  3. Download a workbook without an extract from Tableau Server and open it in Tableau Desktop. Verify that an error message displays:

Test localization Change the language to any language but English (United States).

  1. From Help, select Choose Language, and then select a language.

  2. Restart Tableau Desktop.

  3. Connect to your data source again and verify the localized text.

Connect to the correct database with the wrong credentials

[Optional] Test driver version

If you defined a minimum driver version in your connector, test connecting to the correct database with the correct credentials, but with an old driver version installed.

For example, in Mariadb, <driver-version min=’3.0’/> is defined in connection-resolver.tdr. You can install a 2.0 driver to test that the connector does not use the old driver and instead, shows the “Download and install the drivers” link.

Test your connector with Tableau Server

Publish to Tableau Server

Perform the publishing tests listed below. For more information about publishing, see the publishing resources listed at the end of this section.

Find publishing resources

For information about publishing a data source, see Publish a Data Source in the Tableau Desktop and Web Authoring Help.

For information about publishing a workbook, see Comprehensive Steps to Publish a Workbook in the Tableau Desktop and Web Authoring Help.

Test extract refreshes

Refresh the extract on Tableau Server with the connector installed on the server.

Create and open workbooks and data sources on Tableau Server

Create a new workbook on Tableau Server with the connector installed on the server:

  1. Sign in to Tableau Server.

  2. Under Explore, click Create.

  3. From the dropdown menu, select Workbook.

  4. Select your connector. In this example, the connector name is MariaDB.

  5. Enter the required information to sign in.

  6. After you connect to the data source, you should be able to create a new workbook and save it on the server.

    Note: Web authoring (creating a new connection from the web) is not currently available for all connector superclasses. In those cases, your connector won’t appear on the list of connectors on Tableau Server. If you can publish a workbook or data source using your connector to your server, then your connector is loaded correctly, even if you can’t see it on the list of connectors.