Skip to main content

Download Workbook

UiPath.Tableau.Activities.DownloadWorkbook

Uses the Tableau API to download a workbook in.twb or.twbx format.

How it works​

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Tableau Scope activity to your project.
  3. Add the Download Workbook activity inside the Tableau Scope activity.
  4. Create an enter values for the Input properties.
  5. Enter values for the Output properties.
  6. Create and enter an ResponseStatus variable for the Output property.

In the body of the activity​

  • Site ID - The ID of the site that contains the view. Enter a string or String variable or click the Find button to display the Find site window, where you can see all the site IDs found on the Tableau instance.
    1. Select a site ID and click Done. The Site ID property is automatically populated with the selected value.
    2. Copy the Site ID string, to use it in the Workbook ID property.
  • Workbook ID - The ID of the workbook to download. Enter a string or String variable or click the Find button to display the Find Workbook window.
    1. Paste the Site ID in the Site ID search field and click Find, to identify your workbook ID.
    2. Select your workbook and click Done. The Workbook ID property is automatically populated with the correct value.
  • Folder Path - The folder to download the report to. Enter a string or String variable.
  • File Name - The filename you wish to use. Enter a string or String variable.
  • Download As Extract - If the download should be as an extract. Enter a Boolean variable. You can use this option to improve performance if you are downloading workbooks or data sources that have large extracts.

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only strings or String variables.

Input​

  • Client Timeout (in seconds) - Defines the client read timeout in seconds.. Default value is 100.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables.