From b348f8fea9d9a5becff03155b7a3a164d4ebe9ba Mon Sep 17 00:00:00 2001 From: rpourzand Date: Mon, 13 Nov 2023 16:25:33 -0800 Subject: [PATCH 1/9] Update tableau.md Adding information about Tableau Server - needs review by Diego --- .../docs/use-dbt-semantic-layer/tableau.md | 26 ++++++++++++------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index 8e6d7d8ed27..ab5a91273a7 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -12,30 +12,33 @@ The Tableau integration with the dbt Semantic Layer is a [beta feature](/docs/db The Tableau integration allows you to use worksheets to query the Semantic Layer directly and produce your dashboards with trusted data. -This integration provides a live connection to the dbt Semantic Layer through Tableau Desktop. +This integration provides a live connection to the dbt Semantic Layer through Tableau Desktop or Tableau Server. ## Prerequisites - You have [configured the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and are using dbt v1.6 or higher. -- You must have [Tableau Desktop](https://www.tableau.com/en-gb/products/desktop) installed with version 2021.1 or greater - - Note that Tableau Online does not currently support custom connectors natively. -- Log in to Tableau Desktop using either your license or the login details you use for Tableau Server or Tableau Online. +- You must have [Tableau Desktop](https://www.tableau.com/en-gb/products/desktop) version 2021.1 and greater or Tableau Server. + - Note that Tableau Online does not currently support custom connectors natively. If you use Tableau Online, you will only be able to access the connector in Tableau Desktop. +- Log in to Tableau Desktop (with Online or Server credentials) or a license to Tableau Server - You need your dbt Cloud host, [Environment ID](/docs/use-dbt-semantic-layer/setup-sl#set-up-dbt-semantic-layer) and [service token](/docs/dbt-cloud-apis/service-tokens) to log in. This account should be set up with the dbt Semantic Layer. - You must have a dbt Cloud Team or Enterprise [account](https://www.getdbt.com/pricing) and multi-tenant [deployment](/docs/cloud/about-cloud/regions-ip-addresses). (Single-Tenant coming soon) -## Installing +## Installing the Connector 1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: - - Windows: `C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors` - - Mac: `/Users/[user]/Documents/My Tableau Repository/Connectors` - - Linux: `/opt/tableau/connectors` + +|Tableau Desktop|Tableau Server| +|Windows|`C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors`|`C:\Program Files\Tableau\Connectors`| +|Mac|`/Users/[user]/Documents/My Tableau Repository/Connectors`|n/a| +|Linux|`/opt/tableau/connectors`| `/opt/tableau/connectors`| + 2. Install the [JDBC driver](/docs/dbt-cloud-apis/sl-jdbc) to the folder based on your operating system: - Windows: `C:\Program Files\Tableau\Drivers` - Mac: `~/Library/Tableau/Drivers` - Linux: ` /opt/tableau/tableau_driver/jdbc` 3. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. -4. Connect with your Host, Environment ID, and service token information that's provided to you in your dbt Cloud Semantic Layer configuration. +4. Connect with your Host, Environment ID, and ServiceTtoken information that's provided to you in your dbt Cloud Semantic Layer configuration. In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. ## Using the integration @@ -47,6 +50,11 @@ Once you authenticate, the system will direct you to the data source page with a Visit the [Tableau documentation](https://help.tableau.com/current/pro/desktop/en-us/gettingstarted_overview.htm) to learn more about how to use Tableau worksheets and dashboards. +**Publishing from Tableau Desktop to Tableau Server** + +Like any Tableau workflow, you can publish your workbook from Tableau Desktop to Tableau Server. Follow [these](https://help.tableau.com/current/pro/desktop/en-us/publish_workbooks_share.htm) instructions on Tableau's documentation site. + + ## Things to note - All metrics use the "SUM" aggregation type, and this can't be altered. The dbt Semantic Layer controls the aggregation type and it is intentionally fixed. Keep in mind that the underlying aggregation in the dbt Semantic Layer might not be "SUM" (even though "SUM" is Tableau's default). From 27b09c58335985c3e717e3543db64747b72d773a Mon Sep 17 00:00:00 2001 From: rpourzand Date: Mon, 13 Nov 2023 16:27:11 -0800 Subject: [PATCH 2/9] Update tableau.md fixing table --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index ab5a91273a7..dd30bb131a2 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -29,6 +29,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta 1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: |Tableau Desktop|Tableau Server| +-------------------------------- |Windows|`C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors`|`C:\Program Files\Tableau\Connectors`| |Mac|`/Users/[user]/Documents/My Tableau Repository/Connectors`|n/a| |Linux|`/opt/tableau/connectors`| `/opt/tableau/connectors`| From c05a7e8faa7b95ee8d4dc238ef0f6c4d9866cf71 Mon Sep 17 00:00:00 2001 From: rpourzand Date: Mon, 13 Nov 2023 16:28:21 -0800 Subject: [PATCH 3/9] Update tableau.md fixing table again --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index dd30bb131a2..326a728de56 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -28,7 +28,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta 1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: -|Tableau Desktop|Tableau Server| +|OS|Tableau Desktop|Tableau Server| -------------------------------- |Windows|`C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors`|`C:\Program Files\Tableau\Connectors`| |Mac|`/Users/[user]/Documents/My Tableau Repository/Connectors`|n/a| From ea34e272b06d1df8311d3ff6c7d7ca0ee61a6fd5 Mon Sep 17 00:00:00 2001 From: rpourzand Date: Mon, 13 Nov 2023 16:29:18 -0800 Subject: [PATCH 4/9] Update tableau.md one more try on the table fix --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index 326a728de56..ed3f18b64c5 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -29,7 +29,6 @@ This integration provides a live connection to the dbt Semantic Layer through Ta 1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: |OS|Tableau Desktop|Tableau Server| --------------------------------- |Windows|`C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors`|`C:\Program Files\Tableau\Connectors`| |Mac|`/Users/[user]/Documents/My Tableau Repository/Connectors`|n/a| |Linux|`/opt/tableau/connectors`| `/opt/tableau/connectors`| From de708ade38dbf7458505fe8e461251376a146228 Mon Sep 17 00:00:00 2001 From: rpourzand Date: Mon, 13 Nov 2023 16:37:01 -0800 Subject: [PATCH 5/9] Update tableau.md adding note about initial SQL --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index ed3f18b64c5..cf92433294c 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -72,7 +72,7 @@ The following Tableau features aren't supported at this time, however, the dbt S - Updating the data source page - Using "Extract" mode to view your data - Unioning Tables -- Writing Custom SQL +- Writing Custom SQL / Initial SQL - Table Extensions - Cross Database Joins - All functions in Analysis --> Create Calculated Field From c4a368d48bfae9be1aa97f865f55349925ab150e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 14 Nov 2023 11:00:48 +0000 Subject: [PATCH 6/9] Update tableau.md --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index cf92433294c..919493ac775 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -38,7 +38,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta - Mac: `~/Library/Tableau/Drivers` - Linux: ` /opt/tableau/tableau_driver/jdbc` 3. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. -4. Connect with your Host, Environment ID, and ServiceTtoken information that's provided to you in your dbt Cloud Semantic Layer configuration. In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. +4. Connect with your Host, Environment ID, and Service Token information that's provided to you in your dbt Cloud Semantic Layer configuration. In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. ## Using the integration @@ -74,7 +74,7 @@ The following Tableau features aren't supported at this time, however, the dbt S - Unioning Tables - Writing Custom SQL / Initial SQL - Table Extensions -- Cross Database Joins +- Cross-Database Joins - All functions in Analysis --> Create Calculated Field - Filtering on a Date Part time dimension for a Cumulative metric type - Changing your date dimension to use "Week Number" From 5d951f54f85c14d7b1616674afd016a12e2b87e8 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 14 Nov 2023 12:02:21 +0000 Subject: [PATCH 7/9] fix table and turn bold into h3 --- .../docs/use-dbt-semantic-layer/tableau.md | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index 919493ac775..1edb469e825 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -28,31 +28,32 @@ This integration provides a live connection to the dbt Semantic Layer through Ta 1. Download the GitHub [connector file](https://github.com/dbt-labs/semantic-layer-tableau-connector/releases/download/v1.0.2/dbt_semantic_layer.taco) locally and add it to your default folder: -|OS|Tableau Desktop|Tableau Server| -|Windows|`C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors`|`C:\Program Files\Tableau\Connectors`| -|Mac|`/Users/[user]/Documents/My Tableau Repository/Connectors`|n/a| -|Linux|`/opt/tableau/connectors`| `/opt/tableau/connectors`| +| Operating system |Tableau Desktop | Tableau Server | +| ---------------- | -------------- | -------------- | +| Windows | `C:\Users\\[Windows User]\Documents\My Tableau Repository\Connectors` | `C:\Program Files\Tableau\Connectors` | +| Mac | `/Users/[user]/Documents/My Tableau Repository/Connectors` | Not applicable | +| Linux | `/opt/tableau/connectors` | `/opt/tableau/connectors` | -2. Install the [JDBC driver](/docs/dbt-cloud-apis/sl-jdbc) to the folder based on your operating system: +1. Install the [JDBC driver](/docs/dbt-cloud-apis/sl-jdbc) to the folder based on your operating system: - Windows: `C:\Program Files\Tableau\Drivers` - Mac: `~/Library/Tableau/Drivers` - Linux: ` /opt/tableau/tableau_driver/jdbc` -3. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. -4. Connect with your Host, Environment ID, and Service Token information that's provided to you in your dbt Cloud Semantic Layer configuration. In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. +2. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. +3. Connect with your Host, Environment ID, and Service Token information dbt Cloud provides during [Semantic Layer configuration](/docs/use-dbt-semantic-layer/setup-sl#:~:text=After%20saving%20it%2C%20you%27ll%20be%20provided%20with%20the%20connection%20information%20that%20allows%20you%20to%20connect%20to%20downstream%20tools). + - In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. ## Using the integration -Once you authenticate, the system will direct you to the data source page with all the metrics and dimensions configured in your Semantic Layer. - -- From there, go directly to a worksheet in the bottom left-hand corner. -- Then, you'll find all the metrics and dimensions that are available to query on the left-hand side of your window. +1. **Authentication** — Once you authenticate, the system will direct you to the data source page with all the metrics and dimensions configured in your dbt Semantic Layer. +2. **Access worksheet** — From there, go directly to a worksheet in the bottom left-hand corner. +3. **Access metrics and dimensions** — Then, you'll find all the metrics and dimensions that are available to query on the left side of your window. Visit the [Tableau documentation](https://help.tableau.com/current/pro/desktop/en-us/gettingstarted_overview.htm) to learn more about how to use Tableau worksheets and dashboards. -**Publishing from Tableau Desktop to Tableau Server** +### Publish from Tableau Desktop to Tableau Server -Like any Tableau workflow, you can publish your workbook from Tableau Desktop to Tableau Server. Follow [these](https://help.tableau.com/current/pro/desktop/en-us/publish_workbooks_share.htm) instructions on Tableau's documentation site. +- **From Desktop to Server** — Like any Tableau workflow, you can publish your workbook from Tableau Desktop to Tableau Server. For step-by-step instructions, visit Tableau's [publishing guide](https://help.tableau.com/current/pro/desktop/en-us/publish_workbooks_share.htm). ## Things to note From 7e2771691852c679e83a4bff3137b9073569162b Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 14 Nov 2023 12:16:38 +0000 Subject: [PATCH 8/9] Update tableau.md --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index 1edb469e825..01024b0e1ad 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -34,12 +34,12 @@ This integration provides a live connection to the dbt Semantic Layer through Ta | Mac | `/Users/[user]/Documents/My Tableau Repository/Connectors` | Not applicable | | Linux | `/opt/tableau/connectors` | `/opt/tableau/connectors` | -1. Install the [JDBC driver](/docs/dbt-cloud-apis/sl-jdbc) to the folder based on your operating system: +2. Install the [JDBC driver](/docs/dbt-cloud-apis/sl-jdbc) to the folder based on your operating system: - Windows: `C:\Program Files\Tableau\Drivers` - Mac: `~/Library/Tableau/Drivers` - Linux: ` /opt/tableau/tableau_driver/jdbc` -2. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. -3. Connect with your Host, Environment ID, and Service Token information dbt Cloud provides during [Semantic Layer configuration](/docs/use-dbt-semantic-layer/setup-sl#:~:text=After%20saving%20it%2C%20you%27ll%20be%20provided%20with%20the%20connection%20information%20that%20allows%20you%20to%20connect%20to%20downstream%20tools). +3. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. +4. Connect with your Host, Environment ID, and Service Token information dbt Cloud provides during [Semantic Layer configuration](/docs/use-dbt-semantic-layer/setup-sl#:~:text=After%20saving%20it%2C%20you%27ll%20be%20provided%20with%20the%20connection%20information%20that%20allows%20you%20to%20connect%20to%20downstream%20tools). - In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token. From 6b8360c2db3c033e0f2b33c79608ccfcc86ea901 Mon Sep 17 00:00:00 2001 From: rpourzand Date: Tue, 14 Nov 2023 13:59:51 -0800 Subject: [PATCH 9/9] Update tableau.md --- website/docs/docs/use-dbt-semantic-layer/tableau.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/tableau.md b/website/docs/docs/use-dbt-semantic-layer/tableau.md index 01024b0e1ad..1d283023dda 100644 --- a/website/docs/docs/use-dbt-semantic-layer/tableau.md +++ b/website/docs/docs/use-dbt-semantic-layer/tableau.md @@ -38,7 +38,7 @@ This integration provides a live connection to the dbt Semantic Layer through Ta - Windows: `C:\Program Files\Tableau\Drivers` - Mac: `~/Library/Tableau/Drivers` - Linux: ` /opt/tableau/tableau_driver/jdbc` -3. Open Tableau Desktop and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. +3. Open Tableau Desktop or Tableau Server and find the **dbt Semantic Layer by dbt Labs** connector on the left-hand side. You may need to restart these applications for the connector to be available. 4. Connect with your Host, Environment ID, and Service Token information dbt Cloud provides during [Semantic Layer configuration](/docs/use-dbt-semantic-layer/setup-sl#:~:text=After%20saving%20it%2C%20you%27ll%20be%20provided%20with%20the%20connection%20information%20that%20allows%20you%20to%20connect%20to%20downstream%20tools). - In Tableau Server, the authentication screen may show "User" & "Password" instead, in which case the User is the Environment ID and the password is the Service Token.