Tableau Server (self-hosted) on Kyvos

✅ Enterprise: AWS, Azure, GCP, and On-Premises

✅ Marketplace: AWS, Azure, and GCP

✅ SaaS: AWS, Azure, and GCP

✅ Single Node Installation (SNI)

Overview

This page describes the different methods available to connect Tableau Server (on-premises) to Kyvos semantic models, enabling seamless data analysis and visualization.

Publish data source on Tableau Server

Open Tableau desktop.
Connect to the Kyvos data source using the Tableau Server (On-prem) on Kyvos or TDS metadata file.
From the Server menu and select the Publish Data Source option, and select your data source (Kyvos semantic model).
On the displayed Tableau Server Sign in dialog, provide the Tableau Server URL and click the Connect button.
Enter details in the Publish Data Source to Tableau Server dialog box.
Click the Publish button. Your workbook will be published on the Tableau Server.

Publish Workbook on Tableau Server

Create a worksheet/visualization as per your business requirement on the Tableau desktop.
From the Server menu, select the Publish Workbook option.
The Publish Workbook to Tableau Server dialog box is displayed.
Enter details as:
1. Select the Project to which the workbook belongs.
2. From the Name drop-down, select the workbook that you want to publish.
3. Optionally, provide a Description and Tags.
4. To select specific sheets or dashboards to publish, click the Edit link under Sheets, and select the requisite sheets. To publish only Dashboard, click the Only Dashboards button. To publish all sheets and dashboards, click the All button.
  NOTE: By default, all sheets and dashboards present in the workbook are published.
5. Click the Edit link under Permission to specify data source authentication. You can select the Embedded Password or Prompt User option as needed.
Click the Publish button. The workbook will be published on the Tableau server and can be accessed from the Tableau Server as well.

Connect to Kyvos semantic model through Tableau Server interface

Login to Tableau Server.
Click New and select the Workbook option.
On the New Workbook screen, go to the Connectors tab and select Kyvos or Spark SQL option.
On the displayed Kyvos dialog box, enter your connection information as:
Click Sign In.
On the Data Source page, select your Schema, then select the Table that you want to browse in Tableau. The Kyvos data store is loaded in Tableau. You can now use your data to create reports.

Connecting to Kyvos semantic models through Tableau interface

Tableau Software released a new custom Kyvos connector with its latest version, Tableau 2019.4. Here are the steps that can help you get productive right away using the Kyvos Tableau Connector.

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
Are you connecting to an SSL server?
(Optional) Initial SQL statement to run every time Tableau connects

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

In the displayed Kyvos dialog box, enter your connection information as:
1. In the Server field, type the IP address or hostname of your Kyvos Web App server.
2. In the Port field, type the number of the TCP port that the Kyvos Web App server uses to listen for client requests.
3. In the HTTP Path field, type your client path.
4. In the Username field, type your Kyvos Web App Server Username.
5. In the Password field, type your Kyvos Web App Server Password
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.
Click Sign In. On the Data Source page, select your Schema, then select Table that you want to browse in Tableau.
The Kyvos data store is loaded in Tableau. You can now use your data to create reports.

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

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.

Create a TDS File in Kyvos

From the Kyvos Web portal, click Toolbox > Utilities.
Select the Export Semantic Model Metadata option from the list.
Select the semantic model you want to browse and click Download Selected.
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.
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, 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.

OAuth2.0 Connectivity on Tableau server using Kyvos Connector for Windows

Prerequisites

In Kyvos, OAuth must be configured with the OIDC Settings for Confidential Client selected from the Kyvos Manager. For more details, refer to Kyvos Documentation.

Creation of OAuthConfig file for Tableau Server

Provide the following details in the properties of OAuthConfigServer.xml.

authUri: Authorization endpoint URI to get an authorization code. For example, https://oauthprovider /oauth2/default/v1/authorize
tokenUri: Token endpoint URI to get the token. For example, https://oauthprovider/oauth2/default/v1/token
The following is the sample OAuthConfigServer.xml file.

<?xml version="1.0" encoding="utf-8"?>
<pluginOAuthConfig>


    <dbclass>kyvos</dbclass>
	<oauthConfigId>custom_ConfigId_provider</oauthConfigId>
	<configLabel>Kyvos OAuth</configLabel>
   

	  <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>

OAuth configuration on Tableau Server

To use an identity provider for OAuth2.0 SSO with a workbook based on Kyvos semantic models in Tableau Server, perform the following steps.

Open the Tableau server, Go to Settings.
In the General tab, go to the OAuth Clients Registry section.
Click Add OAuth Client to register the OAuth client.
Select Kyvos Connector from the Connection Type list.
Select OAuth provider from the OAuth Provider drop-down list.
Enter Client Id, Client Secret values, and upload the server version of the OAuthConfig.xml file using the Choose OAuth Config File option. For more details, click here.

Note

Redirect URL may be pre-filled as https://[your_TableauServer_url]/auth/add_oauth_token

Click Add OAuth Client and the registered OAuth client is displayed. Click Save.
To use the saved credentials, perform the following steps.
1. Select the Users option from the left panel in the Tableau server.
2. Go to the Settings option.
3. Connectors are listed with the saved credentials.
4. Go to Kyvos Connector and click Add.
5. Select the OAuth provider from the Authentication list and click Add. The identity provider login page will appear to ask for credentials to get an ID token.
6. Once the ID token is received, the OAuth provider name is displayed along with the username.

Workbook creation with OAuth on Tableau server interface

To create a workbook, go to the Home page in Tableau Server.
Click the Workbook option, the Connector list will be displayed.
Select Kyvos Connector, and the following dialog will appear.
Select the OAuth Authentication option from the Authentication list.
Click Sign In.
The identity provider login page will appear to ask for credentials for getting an ID token.
After receiving a valid ID token, the connection is established successfully.

Publishing OAuth-based Workbooks to Tableau Server

This section defines OAuth 2.0 SSO using an identity provider with a Tableau workbook built on Kyvos semantic models in Tableau Desktop and published to Tableau Server.

To publish Kyvos semantic models to the Tableau Server, perform the following steps.

Create a workbook on Tableau Desktop using OAuth authentication.
Select Publish Type.
To publish a workbook on Tableau Server, click Publish.
After the workbook is published successfully, the confirmation message is displayed.
Open the same workbook from the Tableau Server.
Click Sign In. The identity provider login page will display for credentials.
Enter credentials, and the workbook will open after getting the OAuth ID token.

On this page:

1 Overview
2 Publish data source on Tableau Server
3 Publish Workbook on Tableau Server
4 Connect to Kyvos semantic model through Tableau Server interface
5 OAuth2.0 Connectivity on Tableau server using Kyvos Connector for Windows