Versions Compared

Old Version 23

changes.mady.by.user Dean Nguyen

Saved on

compared with

New Version 24

changes.mady.by.user Dean Nguyen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Python 3.6 - 3.10

  • Tableau Server Version [2019.3] and above.

  • Enable the Tableau Metadata API for Tableau Server

    • This requires a server restart if not enabled

  • Tableau API access

    • An API user (record the username and password) needs to be created to access Tableau API.

    • The user cannot be a SSO user. This is a Tableau limitation. SSO users cannot access Tableau API

    • User needs Site Administrator Creator or Server/Site Administrator role. Roles are dependent on both Licensing and Server version see https://help.tableau.com/current/server/en-us/users_site_roles.htm

      • Site Administrator Creator is only available on Role Based Licensing Model

      • Server/Site Administrator is available on both Role Based and Core Based Licensing Model

  • Tableau Repository access

  • Access to the KADA Collector repository

    • The repository is currently hosted in KADA’s Azure Blob Storage. You will be given a SAS token to access the repository. Reach out to KADA Support (support@kada.ai) if you do not have access.

    • Download the tableau Tableau whl (e.g. kada_collectors_extractors_tableau-#.#.#-py3-none-any.whl)

...

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

  • Add the Host name for the Tableau server

  • Click Finish SetupAfter the source is created.

...

Step 2: Getting Access to the Source Landing Directory

Insert excerpt
Collectors
Collectors
namelanding

...

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

PARAMATER

TYPE

DESCRIPTION

EXAMPLE

server_address

string

Tableau server address inclusive of http/https

“https://10.1.19.15”

username

string

Username to log into tableau

api

API

“tabadmin”

password

string

Password to log into tableau

api

API

sites

list<string>

List of specific sites that you wish to extract, if left as [] it will extract all sites.

[]

db_host

string

This is generally the same as server address less the http/https

“10.1.19.15”

db_username

string

By default the tableau database use is readonly. You should not need to change this unless you actively manage the database

“readonly”

db_password

list<string>

Password for the database user

db_port

integer

Default is 8060 unless your tableau is configured differently

8060

db_name

string

Default database to use is workgroup

“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

Add the mapping.json output where each data source name

mentioned

in Tableau is mapped to an onboarded K host

Where analytics.adw is the onboarded database in

See Host / Database Mapping for more details

Where somehost is the alternate name created in Tableau for the Analytics database that has been onboarded to K

Code Block
languagejson
{
"somehost.adw": "analytics.adw"
}

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.

...

This can be executed anywhere that has the wheel whl installed.

This code sample uses the kada_tableau_extractor_config.json for handling the configuration details

...

If you are handling external arguments of the runner yourself, you’ll need to consider the following additional items for the run method. Refer to this document for more information https://kadaai.atlassian.net/wiki/spaces/KSL/pages/1902411777/Additional+Notes#The-run-method

...

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 store the hight high water mark in a file.

...

Step 7: Push the Extracts to K

...