| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
About Collectors
Collectors are extractors that are developed and managed by you (A customer of K).
...
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 https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm
User needs
Site Administrator CreatororServer/Site Administratorrole. Roles are dependent on both Licensing and Server version see https://help.tableau.com/current/server/en-us/users_site_roles.htmSite Administrator Creatoris only available on Role Based Licensing ModelServer/Site Administratoris available on both Role Based and Core Based Licensing Model
Tableau Repository access
Follow the instructions to create a user that can access the Tableau repositoryhttps://help.tableau.com/current/server/en-us/perf_collect_server_repo.htm
This requires a server restart if not enabled
Note the Tableau repository default user is called
readonly
Access to K landing directory.
...
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 | |||
username | string | Username to log into tableau api | “tabadmin” | ||
password | string | Password to log into tableau 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 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 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
|
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.
...