Navigation

Connect from Tableau Desktop with Authentication

On this page

Prerequisites

Connecting Tableau to the MongoDB Connector for BI requires the following:

Connecting Tableau to the MongoDB Connector for BI requires the following:

Procedure

1

Download and install the MongoDB ODBC driver.

Download the MongoDB ODBC Driver for BI Connector and run the Windows installer (.msi).

2

Create a system DSN.

To securely connect Tableau to the BI Connector, a system DSN configured to use the MongoDB ODBC driver is required. To create a system DSN, follow the steps below:

1

Start the Microsoft ODBC Data Sources program.

Choose the program version (64-bit or 32-bit) which is appropriate for your system and ODBC driver version.

2

Select the System DSN tab.

3

Click the Add button.

Screenshot of the Windows ODBC Administrator application
4

Select a MongoDB ODBC driver from the list of available drivers.

Select either the MongoDB ODBC 1.1.0 ANSI Driver or the MongoDB ODBC 1.1.0 Unicode Driver, then click OK.

Note

ANSI ODBC/Connectors offer maximum performance but have a limited character set. Unicode ODBC/Connectors support a wider character set but may be slightly less performant.

5

Fill in the necessary form fields.

Click the Details button to expose the lower half of the form.

The following form fields are required:

Field Name Description
Data Source Name A name of your choice.
TCP/IP Server Address of the server where your mongosqld process is running. If you have enabled BI Connector on MongoDB Atlas, you can find the hostname of the server where mongosqld is running in the connection information for your cluster.
Port Port number of your mongosqld process.
Database The name of the database to connect to, e.g. test.
6

Fill in the authentication form fields.

The following fields Required when running with --auth enabled or when connecting to an BI Connector for Atlas instance.

Field Name Description
User

Username of the MongoDB user who is authenticated to use your target database.

You can specify the following authentication options after your username as URI-style query parameters:

Connection Option Description
source

Specify the name of the database which stores the user’s credentials. If you do not specify this option, the MongoDB Connector for BI will default to the current database associated with the MySQL connection.

For authentication mechanisms such as PLAIN (LDAP) or GSSAPI (Kerberos) that delegate credential storage to other services, set the source value to $external.

Not required if defaultSource is set in your MongoDB Connector for BI configuration file.

mechanism

Specify the mechanism that the MongoDB Connector for BI should use to authenticate the connection. Accepted values include:

LDAP and Kerberos require MongoDB Enterprise. Set the source to $external when using LDAP or Kerberos.

Not required if defaultMechanism is set in your MongoDB Connector for BI configuration file.

Note

X.509 is not supported.

Example

To authenticate as user grace using the admin database and the Challenge and Response (SCRAM-SHA-1) authentication mechanism, write the username in this format:

grace?source=admin

Example

To authenticate as user grace with the LDAP (PLAIN) authentication mechanism, write the username in this format:

grace?mechanism=PLAIN&source=$external

Example

To authenticate as user grace on the EXAMPLE.COM Kerberos realm with the Kerberos authentication mechanism, write the username in this format:

grace@EXAMPLE.COM?mechanism=GSSAPI&source=$external

For more information about Kerberos configuration, see Configure Kerberos for BI Connector.

Password The authenticated user’s password.
Authentication

The default authentication method. When using the MongoDB ODBC Driver for BI Connector, this field is not required.

To use the authentication plugin in conjunction with another ODBC driver, fill in this field with the string mongosql_auth.

7

Click the Test button to test the ODBC connection.

If the connection is successful, click OK to add the DSN. If the connection fails, check to make sure your MongoDB user is correctly authenticated for the database named in the connection.

3

Start Tableau.

Start the Tableau Desktop application or restart it if it is already running.

4

Connect using Tableau.

  1. In the left-side navigation under To a server, click on More… then click Other Databases (ODBC).
  2. From the Other Databases (ODBC) dialog box, select your DSN from the dropdown and click Connect.
  3. Once the connection test completes, click Sign In.
1

Download and install the MongoDB ODBC driver.

Download the MongoDB ODBC Driver for BI Connector and run the macOS installer (.dmg).

2

Create a system DSN.

To securely connect Tableau to the BI Connector, a system DSN configured to use the MongoDB ODBC driver is required. To create a system DSN, follow the steps below:

1

Launch ODBC Manager.

Note

ODBC Manager is included with the MongoDB ODBC driver.

2

Click System DSN, then click Add.

ODBC Manager DSN configuration
3

Select a MongoDB ODBC driver from the list of available drivers.

Select either the MongoDB ANSI ODBC driver or the MongoDB Unicode ODBC driver, then click OK.

Note

ANSI ODBC/Connectors offer maximum performance but have a limited character set. Unicode ODBC/Connectors support a wider character set but may be slightly less performant.

4

Enter a Data Source Name (DSN).

Optionally enter a Description.

Note

Do not close the setup window. Proceed to the next step.

5

Add the necessary keywords.

  1. Add a keyword value pair by clicking the Add button.
  2. Modify the Keyword by double-clicking on it, entering the desired keyword, then pressing enter.
  3. Modify the Value by double-clicking on it, entering the desired keyword, then pressing enter.

Using the procedure above, add the following keywords:

Keyword Value
SERVER

The hostname or IP address of the MongoDB Connector for BI host.

Important

Use 127.0.0.1 to connect via TCP to localhost. Specifying a value other than an IP address, will attempt to connect via Unix socket.

PORT The IANA port number for the MongoDB Connector for BI. The default is 3307.
DATABASE

The database to use after connecting.

Note

Required when connecting with Microsoft Excel.

For the complete list of ODBC parameters, see Connector/ODBC Connection Parameters.

For example, your user DSN configuration should look similar to the following:

ODBC Manager DSN configuration

Note

Do not close the setup window. Proceed to the next step.

6

Add the authentication keywords.

  1. Add a keyword value pair by clicking the Add button.
  2. Modify the Keyword by double-clicking on it, entering the desired keyword, then pressing enter.
  3. Modify the Value by double-clicking on it, entering the desired keyword, then pressing enter.

Using the procedure above, add the following keywords:

Keyword Value
UID

The username for the user that can access the active MongoDB Connector for BI database.

You can specify the following authentication options after your username as URI-style query parameters:

Connection Option Description
source

Specify the name of the database which stores the user’s credentials. If you do not specify this option, the MongoDB Connector for BI will default to the current database associated with the MySQL connection.

For authentication mechanisms such as PLAIN (LDAP) or GSSAPI (Kerberos) that delegate credential storage to other services, set the source value to $external.

Not required if defaultSource is set in your MongoDB Connector for BI configuration file.

mechanism

Specify the mechanism that the MongoDB Connector for BI should use to authenticate the connection. Accepted values include:

LDAP and Kerberos require MongoDB Enterprise. Set the source to $external when using LDAP or Kerberos.

Not required if defaultMechanism is set in your MongoDB Connector for BI configuration file.

Note

X.509 is not supported.

Example

To authenticate as user grace using the admin database and the Challenge and Response (SCRAM-SHA-1) authentication mechanism, write the username in this format:

grace?source=admin

Example

To authenticate as user grace with the LDAP (PLAIN) authentication mechanism, write the username in this format:

grace?mechanism=PLAIN&source=$external

Example

To authenticate as user grace on the EXAMPLE.COM Kerberos realm with the Kerberos authentication mechanism, write the username in this format:

grace@EXAMPLE.COM?mechanism=GSSAPI&source=$external

For more information about Kerberos configuration, see Configure Kerberos for BI Connector.

PWD The password associated with the UID.

For the complete list of ODBC parameters, see Connector/ODBC Connection Parameters.

For example, your user DSN configuration should look similar to the following:

ODBC Manager DSN configuration
7

Click OK to finish creating the DSN.

3

Start Tableau.

Start the Tableau Desktop application or restart it if it is already running.

4

Connect using Tableau.

  1. In the left-side navigation under To a server, click on More… then click Other Databases (ODBC).
  2. From the Other Databases (ODBC) dialog box, select your DSN from the dropdown and click Connect.
  3. Once the connection test completes, click Sign In.