From ec7f1c3886bb717faf99fdb658573dda3da9dbe9 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Sat, 28 Sep 2024 11:24:57 -0700 Subject: [PATCH 1/2] Update samples list to match current file set --- .gitignore | 2 +- docs/samples.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index e7dc31618..379adaad7 100644 --- a/.gitignore +++ b/.gitignore @@ -91,7 +91,7 @@ ENV/ # Rope project settings .ropeproject - +.vscode/ # macOS.gitignore from https://github.com/github/gitignore *.DS_Store diff --git a/docs/samples.md b/docs/samples.md index 85d306216..4c7aafd3a 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -41,15 +41,17 @@ You will see that you need to enter a file path for the workbook that you want t The following list describes the samples available in the repository: * `add_default_permission.py` Adds workbook default permissions for a given project. +* `create_extract_task.py` Creates extract tasks. * `create_group.py` Creates a user group. * `create_project.py` Creates a project in a site. * `create_schedules.py` Creates schedules for extract refreshes and subscriptions. -* `download_view_image.py` Downloads an image of a specified view. * `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. +* `explore_favorites.py` Queries favorites and optionally add or delete favorites. +* `explore_site.py` Interacts with sites (create, delete, and so on). * `explore_webhooks.py` Explores webhook functions supported by the Server API. * `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. * `export.py` Exports a view as an image, PDF, or CSV. -* `export_wb.py` Exports a PDF containing all views in a workbook. +* `extracts.py` Interacts with extracts, including querying, deleting or creating. * `filter_sort_groups.py` Demonstrates filtering and sorting user groups. * `filter_sort_projects.py` Demonstrates filtering and sorting projects. * `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources. @@ -65,9 +67,11 @@ The following list describes the samples available in the repository: * `query_permissions.py` Queries permissions of a given resource. * `refresh.py` Refreshes a datasource or workbook. * `refresh_tasks.py` Lists and runs configured tasks on a server. -* `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks. * `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource. +* `smoke_test.py` Verifies that TSC is installed correctly and is able to run. * `update_connection.py` Updates and embeds connection credentials of a datasource. * `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource. +* `update_workbook_data_acceleration.py` Updates workbook data acceleration settings. +* `update_workbook_data_freshness_policy.py` Updates workbook data freshness policy settings. **Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Cloud. From fe6216c7a48b9568f03026f831c9612e99d96d4f Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 30 Sep 2024 13:49:17 -0700 Subject: [PATCH 2/2] Remove workbook data acceleration; feature was removed in 2022 --- docs/samples.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/samples.md b/docs/samples.md index 4c7aafd3a..907185c03 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -71,7 +71,6 @@ The following list describes the samples available in the repository: * `smoke_test.py` Verifies that TSC is installed correctly and is able to run. * `update_connection.py` Updates and embeds connection credentials of a datasource. * `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource. -* `update_workbook_data_acceleration.py` Updates workbook data acceleration settings. * `update_workbook_data_freshness_policy.py` Updates workbook data freshness policy settings. **Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Cloud.