Connection Using Kyvos Tableau connector

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Kyvos offers seamless, single sign-on integration with Tableau, making data instantly accessible to decision-makers. With the newly launched Kyvos Connector for Tableau, users can connect to their data in just a few clicks. 

To connect to Kyvos using the Kyvos Tableau connector, you must first download the Kyvos ODBC Driver and install it. You can download the driver from the Kyvos website. The driver is also available at the Tableau website.

Install the Kyvos ODBC driver.

Once the Kyvos ODBC driver is installed, you can connect Tableau to the Kyvos semantic models using any of the following two methods:

• Through Tableau interface

• Using Tableau Data Source File

Prerequisites

• To connect Tableau to a Kyvos semantic model and set up the data source, you must first have this connection information:

  • Name of the server that hosts the database you want to connect

  • Port number for client requests

  • HTTP path to the server

  • User name and password

  • (Optional) Initial SQL statement to run every time Tableau connects

• Prerequisites for using OAuth

  • With Tableau version 2025.2.1 (Tableau Desktop and Tableau Server hosted on Windows OS), the Kyvos connector supports OAuth authentication, ensuring a more secure and seamless login experience.

  • Users must create the OAuthConfig.xml file in the C:\Users[Windows User]\Documents\My Tableau Repository\OAuthConfigs Tableau directory.

  • In Kyvos, configure OAuth with the OIDC Settings for Public Client selected from the Kyvos Manager. For more details, refer to Kyvos Documentation.

  • For creating OAuth files, provide the following details in the properties of OAuthConfigDesktop.xml file.

    • clientIdDesktop: The Client ID you registered for Tableau Desktop on the OAuth provider (Okta) For example, , client id received from IDP

    • redirectUrisDesktop: Redirect URLs for Desktop For example, http://localhost:55556/Callback

    • authUri: Authorization endpoint URI to get an authorization code For example,https://oauthprovider /oauth2/default/v1/authorize

    • tokenUri: A token endpoint URI to get a token. For example, https://oauthprovider/oauth2/default/v1/token

  • Refer to the sample OAuthConfigDesktop.xml file below.

    <?xml version="1.0" encoding="utf-8"?> <pluginOAuthConfig> <dbclass>kyvos</dbclass> <oauthConfigId>custom_ConfigId_provider</oauthConfigId> <configLabel>Kyvos OAuth</configLabel> <clientIdDesktop>client id received from IDP</clientIdDesktop> <redirectUrisDesktop>http://localhost:55556/Callback</redirectUrisDesktop> <authUri>https://oauthprovider /oauth2/default/v1/authorize </authUri> <tokenUri>https://oauthprovider/oauth2/default/v1/token</tokenUri> <scopes>email</scopes> <scopes>offline_access</scopes> <scopes>openid</scopes> <scopes>profile</scopes> <capabilities> <entry> <key>OAUTH_CAP_PKCE_REQUIRES_CODE_CHALLENGE_METHOD</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_REQUIRE_PKCE</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_FIXED_PORT_IN_CALLBACK_URL</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_SUPPORTS_STATE</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_SUPPORTS_GET_USERINFO_FROM_ID_TOKEN</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_REQUIRES_PROMPT_CONSENT</key> <value>true</value> </entry> <entry> <key>OAUTH_CAP_CLIENT_SECRET_IN_URL_QUERY_PARAM</key> <value>true</value> </entry> </capabilities> <accessTokenResponseMaps> <entry> <key>ACCESSTOKEN</key> <value>access_token</value> </entry> <entry> <key>REFRESHTOKEN</key> <value>refresh_token</value> </entry> <entry> <key>access-token-issue-time</key> <value>issued_at</value> </entry> <entry> <key>access-token-expires-in</key> <value>expires_in</value> </entry> <entry> <key>id-token</key> <value>id_token</value> </entry> <entry> <key>username</key> <value>preferred_username</value> </entry> </accessTokenResponseMaps> </pluginOAuthConfig>

Connecting to Kyvos semantic models through Tableau interface

To connect to Kyvos semantic models through Tableau interface, perform the following steps.

1. On the Tableau window, select the Kyvos option from the To a Server list on the navigation pane.

   Open

   

2. In the displayed Kyvos dialog box, specify your connection information as described below:

3. In the Server field, type the IP address or hostname of your Kyvos Web App Server without HTTP. For example, use kyvos_install NOT http://kyvos_install.

4. In the Port field, type the number of the TCP port that the Kyvos Web App Server uses to listen for client requests.

5. From the authentication list, choose one of the following Authentication types:

   1. Username and Password

      1. Enter your Kyvos BI Server credentials in the User Name and Password

      2. In the Transport field, select the HTTP option.

      3. In the HTTP Path field, enter Kyvos/sql

         Open

         

   2. Kerberos

      1. Enter Realm, Host FQDN, and Service Name

      2. In the Transport field, select the HTTP option.

      3. In the HTTP Path field, enter Kyvos/sqlSSO

         Open

         

   3. OAuth:

      1. Select OAuth 2.0 from the Authentication list.

         Open

         

      2. Confirm that authentication is enabled in the OAuth Provider list, where KyvosOAuth is selected by default.

         Open

         

      3. Click Sign In to open the default browser for authentication.

         Open

         

      4. Enter your Okta verification details, including username and password.

      5. After clicking Sign In, you will see the authentication confirmation window.

         Open

         

      6. Return to the Tableau Desktop Application and select the required dataset.

         Open

         

6. Select the Require SSL checkbox if connecting to an SSL server.

7. (Optional) Select Initial SQL to specify a SQL command to run at the beginning of every connection, such as when you open the workbook, refresh an extract, sign in to Tableau Server, or publish to Tableau Server. For more information, see Run Initial SQL.

8. Click Sign In. On the Data Source page, navigate to the Schema of the semantic model you want to connect to and select the semantic model. You can search for the Schema and then for the name of the semantic model/table.

9. Drag the selected table to the right pane. Next, go to Sheet1 to start browsing the semantic model.

10. Optionally, you can preview the data by using the Update Now.

    The levels, attributes, and measures in the semantic model are listed under the Dimensions and Measure sections based on data types or Tableau’s recommendations based on field names. You can start querying and analyzing your data.

Open

Here’s a sample Tableau worksheet with the Kyvos connection.

Open

Connecting Kyvos semantic models using Tableau Data Source connection

When you use a TDS file, you will see the dimensions, hierarchies, measures, levels, and attributes as they are configured in the Kyvos semantic model. If you generate a TDS file from the Kyvos web portal and publish it to the Tableau Server, you don’t need to provide the connection details to your users. A TDS file contains the metadata of the semantic model and connection information.

To create a TDS File in Kyvos, perform the following steps.

1. From the Kyvos Web portal, click Toolbox > Utilities.

2. Select the Export semantic model Metadata option from the list.

3. Select the semantic models you want to browse and click Download Selected.

   Open

   

4. In the Download Selected semantic model Metadata dialog box, select the Tableau Data Source (Spark SQL) option from the Format drop-down.
   Enter the details in Tableau Version, Server IP/Hostname, Server Port, and optionally the username used to connect.

5. Click Download.

Connecting to Kyvos semantic models using TDS File on Tableau Server or Tableau Desktop

Once you have downloaded the TDS file, you can connect Kyvos semantic models using this TDS file on Tableau Server and Tableau Desktop. For this, open the TDS file in Tableau, and enter your credentials and click Sign In.

Optionally, edit the connection details by using the Edit Connection option.

Publish the TDS file and allow Tableau to pre-load the semantic model metadata. Your semantic model is now ready for your users.