...
The collector requires a set of parameters to connect to and extract metadata from Tableau.
PARAMATER | TYPE | SUPPORTED VERSION | DESCRIPTION | EXAMPLE | |||||
---|---|---|---|---|---|---|---|---|---|
server_address | string | 2.0.0+ | Tableau server address inclusive of http/https | ||||||
username | string | 2.0.0+ | Username to log into tableau API | “tabadmin” | |||||
password | string | 2.0.0+ | Password to log into tableau API | ||||||
sites | list<string> | 2.0.0+ | List of specific sites that you wish to extract, if left as [] it will extract all sites. If you wish to extract the default site only you may do so specifying “default” | [] | |||||
db_host | string | 2.0.0+ | This is generally the same as server address less the http/https | “10.1.19.15” | |||||
db_username | string | 2.0.0+ | 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> | 2.0.0+ | Password for the database user | ||||||
db_port | integer | 2.0.0+ | Default is 8060 unless your tableau is configured differently | 8060 | |||||
db_name | string | 2.0.0+ | Default database to use is workgroup | “workgroup” | |||||
meta_only | boolean | 2.0.0+ | If for some reason you want to extract meta only set this to true otherwise leave it as false | false | retries | integer | |||
retries | integer | 2.0.0+ | Number of retries that the extractor should hit the API incase of intermittent failures, default is 5 | 5 | |||||
dry_run | boolean | 2.0.0+ | 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 | 2.0.0+ | Absolute path to the output location where files are to be written | “/tmp/output” | |||||
mask | boolean | 2.0.0+ | To enable masking or not | true | |||||
mapping | json | 2.0.0+ | Add the mapping for each data source in Tableau to a data source that is loaded into K. You will need to map the data source name in Tableau to the data source host name in K (these can be found on the Sources page) Skip any data sources are not onboarded in K (these will be loaded in as references until the source is added to K). 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
| |||||
ssl_verification | boolean | 2.1.0+ | Enable or disable ssl verification for tableau API requests | true |
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.
...