Document toolboxDocument toolbox

Tableau Server (Collector method) - v3.3.0

Owned by Sidney Chen
Last updated: Sept 18, 2024
9 min read

Open in new tab

About Collectors

Collectors are extractors that are developed and managed by you (A customer of K).

KADA provides python libraries that customers can use to quickly deploy a Collector.

 

Why you should use a Collector

There are several reasons why you may use a collector vs the direct connect extractor:

  1. You are using the KADA SaaS offering and it cannot connect to your sources due to firewall restrictions

  2. You want to push metadata to KADA rather than allow it pull data for Security reasons

  3. You want to inspect the metadata before pushing it to K

 

Using a collector requires you to manage

  1. Deploying and orchestrating the extract code

  2. Managing a high water mark so the extract only pull the latest metadata

  3. Storing and pushing the extracts to your K instance.

Pre-requisites

Collector Server Minimum Requirements

Tableau Server Requirements

As of 3.1.0 the collector no longer supports Tableau Server Version lower than 3.5 which does not have the Metadata API Endpoint. The Metadata API Endpoint MUST BE ENABLED for the collector to work.

Step 1: Create the Source in K

Create a Tableau source in K

  • Go to Settings, Select Sources and click Add Source

  • Select “Load from File” option

  • Give the source a Name - e.g. Tableau Production

  • Add the Host name for the Tableau server

  • Click Finish Setup

Step 2: Getting Access to the Source Landing Directory

Collector Method

Step 3: Install the Collector

It is recommended to use a python environment such as pyenv or pipenv if you are not intending to install this package at the system level.

Some python packages also have dependencies on the OS level packages, so you may be required to install additional OS packages if the below fails to install.

You can download the latest Core Library and whl via Platform Settings → Sources → Download Collectors

Run the following command to install the collector

pip install kada_collectors_extractors_<version>-none-any.whl

You will also need to install the common library kada_collectors_lib for this collector to function properly.

pip install kada_collectors_lib-<version>-none-any.whl

Step 4: Configure the Collector

The collector requires a set of parameters to connect to and extract metadata from Tableau.

FIELD

FIELD TYPE

DESCRIPTION

EXAMPLE

FIELD

FIELD TYPE

DESCRIPTION

EXAMPLE

server_address

string

Tableau server address domain including the protocol: http:// https://

“https://10.1.19.15”

username

string

Username to log into tableau api (Can be null if use_cloud is True or use_token is True)

“tabadmin”

password

string

Password to log into tableau api (Can be null if use_cloud is True or use_token is True)

 

sites

list<string>

List of specific sites that you wish to extract, if left as [] it will extract all sites. (This should be a single value list if use_cloud is True as cloud only supports a single site)

[]

ssl_verification

boolean

Should ssl verification be used for API requests

true

db_host

string

This is generally the same as server address less the http/https (Can be null if use_cloud is True or meta_only is True)

“10.1.19.15”

db_username

string

By default the tableau database use is readonly should not need to change this unless you actively manage the database (Can be null if use_cloud is True or meta_only is True)

“readonly”

db_password

list<string>

Password for the database user (Can be null if use_cloud is True or meta_only is True)

 

db_port

integer

Default is 8060 unless your tableau is configured differently (Can be null if use_cloud is True or meta_only is True)

8060

db_name

string

Default database to use is workgroup (Can be null if use_cloud is True or meta_only is True), th

“workgroup”

meta_only

boolean

If for some reason you want to extract meta only set this to true otherwise leave it as false

false

retries

integer

Number of retries that the extractor should hit the API incase of intermittent failures, default is 5

5

dry_run

boolean

By doing a dry run you produce the mapping.json file which is used to populate the mapping field below. It is recommended you do a dry run first to see what databases are available to map.

true

output_path

string

Absolute path to the output location where files are to be written

“/tmp/output”

mask

boolean

To enable masking or not

true

mapping

json

This should be populate with the mapping.json output where each data source name mentioned is mapped to an onboarded K host

Where analytics.adw is the onboarded database in K

{ "somehost.adw": "analytics.adw" }

compress

boolean

To gzip the output or not

true

use_token

boolean

Using a PAT for Authentication, this will be forced to True if use_cloud is True as cloud only supports PAT Authentication

false

use_cloud

boolean

If connection to tableau cloud set to false.
If connecting to tableau server set to true.

false

token_name

string

The PAT name, must be specified if use_token or use_cloud is True

My_token

token_secret

string

The PAT secret, must be specified if use_token or use_cloud is True

somehashgarble_123123

site_content_view_name

string

The view name for the Site Content data tab in the Kada Workbook for extracting event data, used only when meta_only is False and used_cloud is True

kada_site_content

ts_events_view_name

string

The view name for the TS Events data tab in the Kada Workbook for extracting event data, used only when meta_only is False and used_cloud is True

kada_ts_events

timeout

integer

The timeout value against Tableau API calls in seconds, default recommended is 120, if you are using cloud with meta_only as false, suggest you tune this timeout to the amount of activity information you have on Tableau.

120

timestamp_format

string

The timestamp format used by the Event TS view, applicable only when use_cloud is True default value is

%d/%m/%Y %H:%M:%S

%d/%m/%Y %H:%M:%S

These parameters can be added directly into the run or you can use pass the parameters in via a JSON file. The following is an example you can use that is included in the example run code below.

kada_tableau_extractor_config.json

Step 5: Run the Collector

The following code is an example of how to run the extractor. You may need to uplift this code to meet any code standards at your organisation.

This can be executed in any python environment where the whl has been installed.

This is the wrapper script: kada_tableau_extractor.py

 

Advance options:

If you wish to maintain your own high water mark files elsewhere you can use the above section’s script as a guide on how to call the extractor. The configuration file is simply the keyword arguments in JSON format. Refer to this document for more information Collector Integration General Notes | Storing HWM in another location

If you are handling external arguments of the runner yourself, you’ll need to consider additional items for the run method. Refer to this document for more information Collector Integration General Notes | The run method

server_address: server address
username: username to sign into server
password: password to sign into server
sites: list of sites to extract.
ssl_verification: Should ssl verification be enabled for API requests.
db_host: Tableau database address
db_password: Tableau database password
db_port: Tableau database port
db_name: Tableau database name
db_username: Tableau database username
meta_only: extract metadata only
events_only: extract events only
retries: Number of attemps if an API fails on NonXMLResponse Error, default is 5
dry_run: If specified the extractor will do a dry run to produce a template mapping.
output_path: full or relative path to where the outputs should go
login_timeout: The timeout for snowflake Auth
mask: To mask the META/DATABASE_LOG files or not
compress: To gzip output files or not
use_cloud: Are you using Tableau Cloud? Note cloud will force use token authentication
use_token: Are you using a token for authentication? Token authentication is also available for Tableau Server
token_name: Token based authentication
token_secret: Token based authentication
site_content_view_name: The view name for Content View tab in the Kada workbook for events, defaults to kada_site_content
ts_events_view_name: The view name for TS Events View tab in the Kada workbook for events, defaults to kada_ts_events
timeout: The timeout value in seconds for Tableau API calls
timestamp_format: The format of the event timestamp for the TS Events View, if defaults to %d/%m/%Y %H:%M:%S, refer to python datetime formating

Step 6: Check the Collector Outputs

K Extracts

A set of files (eg metadata, databaselog, linkages, events etc) will be generated. These files will appear in the output_path directory you set in the configuration details

High Water Mark File

A high water mark file is created in the same directory as the execution called tableau_hwm.txt and produce files according to the configuration JSON. This file is only produced if you call the publish_hwm method.

Step 7: Push the Extracts to K

Once the files have been validated, you can push the files to the K landing directory..

You can use Azure Storage Explorer if you want to initially do this manually. You can push the files using python as well (see Airflow example below)

Example: Using Airflow to orchestrate the Extract and Push to K