diff --git a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/airflow.md b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/airflow.md index 2d5f06c0069..4eb507ef349 100644 --- a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/airflow.md +++ b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/airflow.md @@ -92,6 +92,117 @@ workflowConfig: authProvider: no-auth ``` +### Example Source Configurations for default and non-default tableau sites + +#### 1. Sample config for default tableau site + +For a default tableau site `siteName` and `siteUrl` fields should be kept as empty strings as shown in the below config. + +```yaml +source: + type: tableau + serviceName: local_tableau + serviceConnection: + config: + type: Tableau + username: username + password: password + env: tableau_prod + hostPort: http://localhost + siteName: "" + siteUrl: "" + apiVersion: api_version + # If not setting user and password + # personalAccessTokenName: personal_access_token_name + # personalAccessTokenSecret: personal_access_token_secret + sourceConfig: + config: + type: DashboardMetadata + # dbServiceNames: + # - service1 + # - service2 + # dashboardFilterPattern: + # includes: + # - dashboard1 + # - dashboard2 + # excludes: + # - dashboard3 + # - dashboard4 + # chartFilterPattern: + # includes: + # - chart1 + # - chart2 + # excludes: + # - chart3 + # - chart4 +sink: + type: metadata-rest + config: {} +workflowConfig: + # loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR + openMetadataServerConfig: + hostPort: http://localhost:8585/api + authProvider: no-auth +``` + +#### 1. Sample config for non-default tableau site + +For a non-default tableau site `siteName` and `siteUrl` fields are required. + + + +If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `siteName` and `siteUrl` fields in the config below. + + + +```yaml +source: + type: tableau + serviceName: local_tableau + serviceConnection: + config: + type: Tableau + username: username + password: password + env: tableau_prod + hostPort: http://localhost + siteName: openmetadata + siteUrl: openmetadata + apiVersion: api_version + # If not setting user and password + # personalAccessTokenName: personal_access_token_name + # personalAccessTokenSecret: personal_access_token_secret + sourceConfig: + config: + type: DashboardMetadata + # dbServiceNames: + # - service1 + # - service2 + # dashboardFilterPattern: + # includes: + # - dashboard1 + # - dashboard2 + # excludes: + # - dashboard3 + # - dashboard4 + # chartFilterPattern: + # includes: + # - chart1 + # - chart2 + # excludes: + # - chart3 + # - chart4 +sink: + type: metadata-rest + config: {} +workflowConfig: + # loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR + openMetadataServerConfig: + hostPort: http://localhost:8585/api + authProvider: no-auth +``` + + #### Source Configuration - Service Connection - **hostPort**: URL to the Tableau instance. diff --git a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/cli.md b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/cli.md index 9a6fc13802c..db0387eddb6 100644 --- a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/cli.md +++ b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/cli.md @@ -92,6 +92,116 @@ workflowConfig: authProvider: no-auth ``` +### Example Source Configurations for default and non-default tableau sites + +#### 1. Sample config for default tableau site + +For a default tableau site `siteName` and `siteUrl` fields should be kept as empty strings as shown in the below config. + +```yaml +source: + type: tableau + serviceName: local_tableau + serviceConnection: + config: + type: Tableau + username: username + password: password + env: tableau_prod + hostPort: http://localhost + siteName: "" + siteUrl: "" + apiVersion: api_version + # If not setting user and password + # personalAccessTokenName: personal_access_token_name + # personalAccessTokenSecret: personal_access_token_secret + sourceConfig: + config: + type: DashboardMetadata + # dbServiceNames: + # - service1 + # - service2 + # dashboardFilterPattern: + # includes: + # - dashboard1 + # - dashboard2 + # excludes: + # - dashboard3 + # - dashboard4 + # chartFilterPattern: + # includes: + # - chart1 + # - chart2 + # excludes: + # - chart3 + # - chart4 +sink: + type: metadata-rest + config: {} +workflowConfig: + # loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR + openMetadataServerConfig: + hostPort: http://localhost:8585/api + authProvider: no-auth +``` + +#### 1. Sample config for non-default tableau site + +For a non-default tableau site `siteName` and `siteUrl` fields are required. + + + +If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `siteName` and `siteUrl` fields in the config below. + + + +```yaml +source: + type: tableau + serviceName: local_tableau + serviceConnection: + config: + type: Tableau + username: username + password: password + env: tableau_prod + hostPort: http://localhost + siteName: openmetadata + siteUrl: openmetadata + apiVersion: api_version + # If not setting user and password + # personalAccessTokenName: personal_access_token_name + # personalAccessTokenSecret: personal_access_token_secret + sourceConfig: + config: + type: DashboardMetadata + # dbServiceNames: + # - service1 + # - service2 + # dashboardFilterPattern: + # includes: + # - dashboard1 + # - dashboard2 + # excludes: + # - dashboard3 + # - dashboard4 + # chartFilterPattern: + # includes: + # - chart1 + # - chart2 + # excludes: + # - chart3 + # - chart4 +sink: + type: metadata-rest + config: {} +workflowConfig: + # loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR + openMetadataServerConfig: + hostPort: http://localhost:8585/api + authProvider: no-auth +``` + #### Source Configuration - Service Connection - **hostPort**: URL to the Tableau instance. diff --git a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/index.md b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/index.md index b0e0b0e2aed..544945bcf85 100644 --- a/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/index.md +++ b/openmetadata-docs/content/openmetadata/connectors/dashboard/tableau/index.md @@ -107,11 +107,30 @@ this connector. Please follow the instructions below to ensure that you've configured the connector to read from your tableau service as desired. +#### 1. Service Connection for a default tableau site +For a default tableau site `Site Name` and `Site Url` fields should be kept empty as shown in the below image
Configure service connection +
+ +#### 2. Service Connection for a non-default tableau site +For a non-default tableau site `Site Name` and `Site Url` fields are required. + + + +If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `Site Name` and `Site Url` fields. + + + +
+Configure service connection
diff --git a/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-default-site.png b/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-default-site.png new file mode 100644 index 00000000000..b97683ec6c9 Binary files /dev/null and b/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-default-site.png differ diff --git a/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-non-default-site.png b/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-non-default-site.png new file mode 100644 index 00000000000..805051ceb89 Binary files /dev/null and b/openmetadata-docs/images/openmetadata/connectors/tableau/service-connection-non-default-site.png differ