Tableau
Schema-driven source documentation.
TABLEAU39 fields2 examples
Commonly Asked Questions
Assistant knowledge mapped to this source type from
assistant_knowledge.json.Required
Fields required for a valid configuration payload under `config.required`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| required | object | Yes | — | — | — |
Masked
Sensitive fields under `config.masked` (secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | Yes | — | — | — |
Optional
Optional configuration fields under `config.optional`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
| optional.connection | object | No | Tableau API connection and retry settings. | — | no extra properties |
| optional.connection.max_retries | integer | No | Maximum retries for transient Tableau API request failures | 3 | min 0, max 10 |
| optional.connection.session_trust_env | boolean | No | When true, allow requests session proxy/environment settings | false | — |
| optional.connection.ssl_verify | boolean | string | No | Verify SSL certificates. Provide a PEM bundle path string for custom certs. | true | — |
| optional.connection.timeout_seconds | integer | No | HTTP timeout in seconds for Tableau requests | 30 | min 5, max 300 |
| optional.extraction | object | No | Tableau metadata extraction feature flags. | — | no extra properties |
| optional.extraction.extract_usage_stats | boolean | No | Extract Tableau usage statistics when accessible | false | — |
| optional.extraction.ingest_owner | boolean | No | Extract Tableau owner metadata into assets | false | — |
| optional.extraction.ingest_tags | boolean | No | Extract Tableau tags into asset metadata | false | — |
| optional.scope | object | No | Optional Tableau project/workbook/datasource scope filters. | — | no extra properties |
| optional.scope.datasource_names | array | No | Optional Tableau datasource allowlist (exact names) | — | — |
| optional.scope.datasource_names[] | string | No | — | — | — |
| optional.scope.include_datasources | boolean | No | Include datasource assets in extraction | true | — |
| optional.scope.include_workbooks | boolean | No | Include workbook assets in extraction | true | — |
| optional.scope.project_names | array | No | Optional Tableau project allowlist (exact names) | — | — |
| optional.scope.project_names[] | string | No | — | — | — |
| optional.scope.workbook_names | array | No | Optional Tableau workbook allowlist (exact names) | — | — |
| optional.scope.workbook_names[] | string | No | — | — | — |
Examples
Reference payloads generated from shared source examples JSON.
Tableau Cloud PAT scan
Extract Tableau Cloud workbooks and datasources using personal access token auth
Schedule
{
"enabled": true,
"preset": "weekday_business",
"cron": "29 16 * * 1-5",
"timezone": "UTC"
}Config Payload
{
"type": "TABLEAU",
"required": {
"auth_mode": "PERSONAL_ACCESS_TOKEN",
"connect_uri": "https://test-company.online.tableau.com",
"site": "some_test_company",
"token_name": "some_token"
},
"masked": {
"token_value": "masked-token-value"
},
"optional": {
"extraction": {
"ingest_tags": true,
"ingest_owner": true,
"extract_usage_stats": true
}
},
"sampling": {
"strategy": "LATEST",
"limit": 50,
"order_by_column": "updated_at"
}
}Tableau Server username/password scan
Extract selected Tableau Server projects using username/password auth
Schedule
{
"enabled": true,
"preset": "nightly",
"cron": "17 0 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "TABLEAU",
"required": {
"auth_mode": "USERNAME_PASSWORD",
"connect_uri": "https://tableau.company.internal",
"site": ""
},
"masked": {
"username": "svc_tableau",
"password": "masked-password"
},
"optional": {
"scope": {
"project_names": [
"Finance",
"Operations"
],
"include_workbooks": true,
"include_datasources": true
}
},
"sampling": {
"strategy": "ALL"
}
}