Tableau 提供了 tabcmd 命令行实用工具，您可以使用它在 Tableau Online 站点上自动完成站点管理任务。例如，创建或删除用户、项目和组。

重要信息：为了确保 Tableau Online 的可用性并避免中断，请确保在 2022 年 1 月之前将 tabcmd 客户端升级到高于 2020.2 的版本。tabcmd 版本向后兼容 API，不需要更改代码。有关详细信息，请参见安装 tabcmd。

安装 tabcmd

将 Tableau Server 或 Tableau Online 升级到新版本时，如果需要 tabcmd 的更新版本，您可以从 Tableau 网站上“Tableau Server 版本”页面下载该版本。

对于 Tableau Server：我们建议下载择与您的服务器版本匹配的版本。对于 Tableau Online，我们建议您始终下载最新版本，以避免版本不兼容导致的问题。在任一情况下，使用 tabcmd 的过时版本可能会导致错误和不可预知的结果。

1. 打开 Web 浏览器并转到 Tableau Server 版本(链接在新窗口中打开)页面。即使您使用 Tableau Online，也转到此页面。

2. 如果您使用的是：

   在任一情况下，如果展开的信息显示维护版本，请选择最新维护版本，或选择与您的服务器版本匹配的维护版本。

   

   这将带您进入发行说明页面（名为“已解决问题”），您可以在其中阅读有关安全改进和已解决问题的信息。

• Tableau Online：请选择最新的 Tableau Server 版本。

• Tableau Server（Windows 或 Linux）：请选择与您的服务器版本匹配的版本。

3. 滚动到已解决问题下的“下载文件”部分，选择与您将从中运行 tabcmd 命令的计算机兼容的 tabcmd 下载链接。

   

   其余步骤将此计算机称为“tabcmd 计算机”。

4. 将安装程序保存到 tabcmd 计算机，或保存到可从该计算机访问的位置。

5. 完成适合于 tabcmd 计算机操作系统的安装步骤：

   若要从 Linux 计算机中卸载 tabcmd，请参见适用于正在运行的 Linux 版本的文档。

• Windows

• Linux

6. （可选）将安装 tabcmd 的完全限定位置添加到系统路径中，以允许您运行 tabcmd 命令，而无需更改到该位置，或为每个命令指定位置。执行此操作的步骤取决于操作系统的类型和版本。有关详细信息，请参见 PATH（变量）。

如何使用 tabcmd

使用 tabcmd 的基本步骤如下：

1. 以管理员身份打开命令提示符。

2. 在 Windows 计算机上，如果在不是初始节点的计算机上安装了 tabcmd，请切换到安装了 tabcmd 的目录。

   在 Linux 计算机上，您无需切换到安装目录。

3. 运行 tabcmd 命令。

在使用 tabcmd 时，您必须建立经过身份验证的服务器会话。会话会识别服务器或 Tableau Online 站点以及运行该会话的用户。您可以先启动会话，然后指定命令，或者在启动会话的同时执行命令。

重要信息：如果您要使用 tabcmd 执行多项任务，则必须依次（连续）运行任务，而非同时（并行）运行。

命令（例如 login）和选项（例如 -s、-u 等）不区分大小写，但您提供的值（例如 User@Example.com）区分大小写。

示例

下面的命令演示了如何启动会话：

tabcmd login -s https://online.tableau.com -t mysite -u authority@email.com -p password

下面介绍了如何用一条命令启动会话和删除工作簿，请注意此处不需要 login：

tabcmd delete "Sales_Workbook" -s https://online.tableau.com -t campaign -u admin@email.com -p password

选项 -s、-t、-u 和 -p 是 tabcmd 的全局变量，可与任何命令一起使用。

有关详细信息，请参见 tabcmd 命令。

tabcmd 命令

您可以在 Tableau Online 中通过 tabcmd 命令行工具使用以下命令：

重要信息：为了确保 Tableau Online 的可用性并避免中断，请确保在 2022 年 1 月之前将 tabcmd 客户端升级到高于 2020.2 的版本。tabcmd 版本向后兼容 API，不需要更改代码。有关详细信息，请参见安装 tabcmd。

login

logout

get url

addusers（至组）

creategroup

deletegroup

export

createproject

deleteproject

publish

createextracts

refreshextracts

deleteextracts

runschedule

delete workbook-name 或 datasource-name

createsiteusers

deletesiteusers

removeusers

version

addusers group-name

将用户添加到指定的组。

示例

tabcmd addusers "Development" --users "users.csv"

选项

• --users

• 将给定 .csv 文件中的用户添加到指定组中。该文件应是每行一个用户名的简单列表。用户名不区分大小写。用户应已在 Tableau Online 上创建。

  有关详细信息，请参见 CSV 导入文件准则。

• --[no-]complete

• 当设置为 complete 时，此选项要求所有行都必须有效，更改才能成功。如果未指定，则使用 --complete。

全局选项

所有 tabcmd 命令都使用以下选项。若要开始一个会话，至少需要使用一次 --server、--user 和 --password 选项。将存储一个身份验证令牌，以便可以不用包括这些选项就能运行后续命令。此令牌在使用它的最后一个命令之后五分钟内保持有效。

• -h, --help

• 显示命令帮助。

  注意：将 tabcmd 与 Tableau Online 结合使用时，列出的某些命令可能不适用。

• -s, --server

• Tableau Online URL，至少需要使用一次才能开始会话。

• -u, --user

• Tableau Online 用户名，至少需要使用一次才能开始会话。

• -p, --password

• Tableau Online 密码，至少需要使用一次才能开始会话。

• --password-file

• 允许将密码存储在给定 .txt 文件中而不是命令行中以增加安全性。

• -t, --site

• 指示命令将应用于由 Tableau Online 站点 ID 指定的站点，用单引号或双引号引起来。如果指定的用户与多个站点关联，请使用此选项。使用缓存的身份验证令牌时，站点 ID 区分大小写。如果大小写不匹配，则即使令牌仍然有效，系统也可能提示您输入密码。

• --no-prompt

• 指定后，该命令将不提示输入密码。如果未提供有效密码，则该命令将失败。

• --[no-]cookie

• 指定后，登录时将保存会话 ID，这样后续命令就无需登录。若要不保存会话 ID，请使用 no- 前缀。默认情况下，将保存会话。

• --timeout

• 等待指定秒数以使服务器完成命令处理。默认情况下，进程将等待服务器响应。

• --

• 指定命令行上的选项结尾。您可以使用 -- 向 tabcmd 指明不应将 -- 后面的内容解释为选项设置，而是解释为命令的值。如果需要在包括连字符的命令中指定值，这将非常有用。下面的示例演示如何能在 tabcmd 命令中使用 --，在该命令中，-430105/Sheet1 是 export 命令的必需值。

  tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createextracts

为已发布工作簿或数据源创建数据提取

选项

• -d, --datasource

• 数据提取创建的目标数据源的名称。

• --embedded-datasources

• 目标工作簿内嵌入的数据源名称的空格分隔列表。如果数据源名称包含空格，请用双引号括起来。仅在为工作簿创建数据提取时可用。

• --encrypt

• 创建加密数据提取

• --include-all

• 在目标工作簿内包括所有嵌入数据源仅在为工作簿创建数据提取时可用。

• --parent-project-path

• 作为包含目标资源的项目的父级的项目的路径。必须使用 -project 指定项目名称。

• --project

• 包含目标资源的项目的名称。仅当指定了 --workbook 或 --datasource 时才需要。如果未指定，则使用默认项目“默认”。

• -u, -url

• 显示在 URL 中的资源的规范名称。

• -w, -workbook

• 用于创建数据提取的目标工作簿的名称。

全局选项

creategroup group-name

创建一个组。使用 addusers 在创建组之后添加用户。

示例

tabcmd creategroup "Development"

全局选项

createproject project-name

创建一个项目。

示例

tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."

选项

• -n, --name

• 指定要创建的项目的名称。

• --parent-project-path

• 指定使用 -n 选项指定的嵌套项目的父项目的名称。例如，若要指定“Main”项目中名为“Nested”的项目，请使用以下语法： --parent-project-path "Main" -n "Nested"。

• -d, --description

• 为项目指定说明。

全局选项

createsiteusers filename.csv

根据逗号分隔值 (CSV) 文件中提供的信息将用户添加到站点。如果尚未在服务器上创建用户，该命令会在将用户添加到站点之前创建该用户。

CSV 文件必须包含一个或多个用户名，还可（为每个用户）包括一个密码、全名、许可证类型、管理员级别、发布者（是/否），以及电子邮件地址。有关 CSV 文件的格式的信息，请参见CSV 导入文件准则。

作为在 CSV 文件中包括管理员级别和发布者权限的替代方法，您可以通过包括 --role 选项并指定要为 CSV 文件中列出的用户分配的站点角色来传递访问级别信息。

默认情况下，用户将添加到您登录到的站点。若要将用户添加到其他站点，请包括全局 --site 选项并指定该站点。（您必须具有在指定的站点上创建用户的权限。）

示例

tabcmd createsiteusers "users.csv" --role "Explorer"

选项

• --admin-type

• 已弃用。请改用 --role 选项。

• --auth-type

• 为 .csv 文件中的所有用户设置身份验证类型（TableauID 或 SAML）。如果未指定，则默认值为 TableauID。

  注意：若要使用 SAML 身份验证，站点本身也必须启用 SAML。有关信息，请参见在站点上启用 SAML 身份验证。

• --[no-]complete

• 已弃用。默认错误行为：如果在十行范围内有 3 个以上的错误，则命令将失败。

• --no-publisher

• 已弃用。请改用 --role 选项。

• --nowait

• 不等待异步作业完成。

• --publisher

• 已弃用。请改用 --role 选项。

• --role

• 为 .csv 中的所有用户指定站点角色。如果要使用 --role 选项分配站点角色，请为每个站点角色创建单独的 CSV 文件。

  有效的值包括：ServerAdministrator、SiteAdministratorCreator、SiteAdministratorExplorer、SiteAdministrator、Creator、ExplorerCanPublish、Publisher、Explorer、Interactor、Viewer 和 Unlicensed。

  对于新用户，默认值为 Unlicensed，对于现有用户，默认值不变。如果有基于用户的服务器安装，并且在 createsiteusers 命令创建新用户的情况下您已达到用户许可证数的限制，则会以未许可用户的形式添加该用户。

  注意：在多站点 Tableau Server 上，如果要使用 --role 选项分配 ServerAdministrator 站点角色，请使用 createusers 命令，而不是 createsiteusers。

• --silent-progress

• 不显示命令的进度消息。

全局选项

delete workbook-name 或 datasource-name

从服务器中删除指定工作簿或数据源。

此命令按原样使用服务器上的工作簿或数据源的名称，而不是发布时的文件名。

示例

tabcmd delete "Sales_Analysis"

选项

• -r, --project

• 包含您要删除的工作簿或数据源的项目的名称。如果未指定，则使用“Default”项目。

• --parent-project-path

• 指定使用 -r 选项指定的嵌套项目的父项目的名称。例如，若要指定“Main”项目中名为“Nested”的项目，请使用以下语法： --parent-project-path "Main" -r "Nested"。

• --workbook

• 要删除的工作簿的名称。

• --datasource

• 要删除的数据源的名称。

全局选项

deleteextracts

为已发布工作簿或数据源删除数据提取。

选项

• -d, --datasource

• 用于数据提取删除的目标数据源的名称。

• --embedded-datasources

• 目标工作簿内嵌入的数据源名称的空格分隔列表。如果数据源名称包含空格，请用双引号括起来。仅在删除工作簿的数据提取时可用。

• --encrypt

• 创建加密数据提取

• --include-all

• 在目标工作簿内包括所有嵌入数据源

• --parent-project-path

• 作为包含目标资源的项目的父级的项目的路径。必须使用 -project 指定项目名称。

• --project

• 包含目标资源的项目的名称。仅当指定了 --workbook 或 --datasource 时才需要。如果未指定，则使用默认项目“默认”。

• -u, -url

• 显示在 URL 中的资源的规范名称。

• -w, -workbook

• 用于数据提取删除的目标工作簿的名称。

全局选项

deletegroup group-name

从服务器中删除指定的组。

示例

tabcmd deletegroup "Development"

全局选项

deleteproject project-name

从服务器中删除指定的项目。

使用 tabcmd，您可以仅指定项目分层结构中的顶层项目。若要自动执行想要对父项目内的项目执行的任务，请使用等效的 Tableau REST API(链接在新窗口中打开) 调用。

示例

tabcmd deleteproject "Designs"

选项

• --parent-project-path

• 指定使用命令指定的嵌套项目的父项目的名称。例如，若要指定“Main”项目中名为“Designs”的项目，请使用以下语法： --parent-project-path "Main" "Designs"。

全局选项

deletesiteusers filename.csv

从您登录到的站点中移除用户。要移除的用户在一个文件中指定，该文件包含每行一个用户名的简单列表。（除用户名之外不需要其他信息。）

默认情况下，如果服务器只有一个站点，或者用户只属于一个站点，则还会从服务器中移除用户。在 Tableau Server Enterprise 安装上，如果服务器包含多个站点，则会从站点中移除分配了“服务器管理员”站点角色的用户，但不会从服务器中移除这些用户。

如果用户拥有内容，则用户的角色将变为“未许可”，但不会从服务器或站点中移除用户。内容仍然由该用户拥有。若要完全移除用户，您必须更改内容的所有者，然后再次尝试移除用户。

示例

tabcmd deletesiteusers "users.csv"

全局选项

export

从 Tableau Online 导出视图或工作簿，并将其保存到文件。此命令还可导出恰好适用于视图的数据。视图数据在摘要级别导出。若要导出详细级别数据，您必须使用 Tableau Server UI。有关详细信息，请参见下载视图和工作簿(链接在新窗口中打开)。

使用此命令时，请注意以下问题：

• 权限：若要导出，您必须拥有“导出图像”权限。虽然可针对每个工作簿或视图设置权限，但默认情况下，所有角色均会获得或继承此权限。

• 导出数据：若要导出恰好适用于视图的数据，请使用 --csv 选项。这会将视图中使用的摘要数据导出为 .csv 文件。

• 指定要导出的视图、工作簿或数据：

• 使用 URL 的一部分标识要导出的内容，特别是工作簿或视图的 URL 中显示的 "workbook/view" 字符串。不要使用“友好名称”，并且不要包括 URL 末尾的 :iid= 会话 ID。

  例如，“Regional”（区域）工作簿中的 Tableau 示例视图“Global Temperatures”（全球温度）具有类似于如下的 URL：

  若要导出“Global Temperatures”（全球温度）视图，请使用字符串 Regional/GlobalTemperatures。

  不要使用 Regional/Global Temperatures 或 Regional/GlobalTemperatures?:iid=3。

• 如果服务器运行多个站点，并且视图或工作簿不在“默认”站点上，请使用 -t。

• 若要导出工作簿，请通过在工作簿中打开视图来获取 URL 字符串，并在使用的字符串中包括视图。

  在上面的示例中，若要导出“Regional”（区域）工作簿，请使用字符串 Regional/GlobalTemperatures。

• 若要导出工作簿，必须已在“Tableau Desktop 发布”对话框中选中“将工作表显示为标签”的情况下发布该工作簿。

  注意：无法导出包含管理视图(链接在新窗口中打开)的 Tableau 工作簿。

• 若要筛选下载的数据，请使用此格式添加参数筛选器：

  ?<filter_name>=value

  或者，如果对参数进行筛选且该参数具有与度量或维度的名称匹配的显示名称：

  ?Parameters.

• 已保存文件的格式：格式选项取决于所导出的内容。只能使用 --fullpdf 参数将工作簿导出为 PDF。可将视图导出为 PDF (--pdf) 或 PNG (--png)。

• 已保存文件的名称和位置（可选）：如果您不提供名称，则将从视图或工作簿名称得到名称。如果您不提供位置，则会将该文件保存到当前工作目录。否则，您可以指定完整路径或当前工作目录的相对路径。

  注意：您必须包括文件扩展名，例如 .csv 或 .pdf。命令不会自动向您提供的文件名中添加扩展名。

• PDF 导出中不包含仪表板网页对象：仪表板可以包含网页对象。如果要将包含网页对象的仪表板导出到 PDF，则 PDF 中将不包括该网页对象。

• 非 ASCII 和非标准 ASCII 字符及 PDF 导出：如果您导出的视图或工作簿名称所包含的字符不在 ASCII 字符集内，或包括非标准 ASCII 字符集，则您需要对字符进行 URL 编码（或百分号编码）。

  举例来说，如果您的命令包括城市 Zürich，则需要将其 URL 编码为 Z%C3%BCrich：

  tabcmd export "/Cities/Sheet1?locationCity=Z%C3%BCrich" -fullpdf

清除缓存以使用实时数据

您可以选择添加 URL 参数 ?:refresh=yes 强制刷新数据查询而不是从缓存中获取结果。如果将 tabcmd 与您自己的脚本结合使用，并且大量使用 refresh URL 参数，则可能会对性能造成负面影响。建议您仅当需要实时数据时才使用 refresh，例如，在单个仪表板上而不是整个工作簿上。

示例

视图

tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report.csv"

tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

tabcmd export "Finance/InvestmentGrowth" --png

tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png

工作簿

tabcmd export "Q1Sales/Sales_Report" --fullpdf

tabcmd export "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

选项

• -f, --filename

• 使用给定文件名和扩展名保存文件。

• --csv

• 仅视图。以 .csv 格式导出视图的数据（摘要数据）。

• --pdf

• 仅视图。导出为 PDF。

• --png

• 仅视图。导出为 .png 格式的图像。

• --fullpdf

• 仅工作簿。导出为 PDF。必须已在“将工作表显示为标签”已启用的情况下发布该工作簿。

• --pagelayout

• 设置所导出的 PDF 的页面方向（landscape 或 portrait）。如果不指定，则将使用其 Tableau Desktop 设置。

• --pagesize

• 将导出的 PDF 的页面大小设置为以下各项之一：unspecified、letter、legal、note folio、tabloid、ledger、statement、executive、 a3、a4、a5、b4、b5 或 quarto。默认值为 letter。

• --width

• 以像素为单位设置宽度。默认值为 800 像素。

• --height

• 以像素为单位设置高度。默认值为 600 像素。

全局选项

get url

从指定（部分）URL 表示的 Tableau Online 中获取资源。结果以文件形式返回。

使用此命令时，请注意以下问题：

• 权限：若要获取文件，您必须拥有“下载/另存到 Web”权限。虽然可针对每个工作簿或视图设置权限，但默认情况下，所有角色均会获得或继承此权限。

• 指定要获取的视图或工作簿：使用 "/views/ 字符串指定要获取的视图，并使用 "/workbooks/ 字符串指定要获取的工作簿。将 和 替换为当您在浏览器打开视图时工作簿和视图在 URL 中的显示名称，并将

  例如，当您在名为 Metrics Summary 的工作簿中打开视图 Regional Totals 时，URL 将类似于如下：

  /views/MetricsSummary_1/RegionalTotals?:iid=1

  使用字符串 /views/MetricsSummary_1/RegionalTotals. 来获取视图。

  使用字符串 /workbooks/MetricsSummary_1. 来获取工作簿。

• 文件扩展名：URL 必须包括文件扩展名。扩展名确定返回的内容。可采用 PDF、PNG 或 CSV（仅限汇总数据）格式返回视图。Tableau 工作簿作为 TWB 返回（如果它连接到已发布的数据源或使用实时连接）或者作为 TWBX 返回（如果它连接到数据提取）。

  注意：如果要将视图下载到 PDF 或 PNG 文件，并且包括的 --filename 参数中包含 .pdf 或 .png 扩展名，则不必在 URL 中包括 .pdf 或 .png 扩展名。

• 已保存文件的名称和位置（可选）：用于 --filename 的名称应包含该文件扩展名。如果您不提供名称和文件扩展名，则这两个名称都将从 URL 字符串得到。如果您不提供位置，则会将该文件保存到当前工作目录。否则，您可以指定完整路径或当前工作目录的相对路径。

• PNG 大小（可选）：如果保存的文件是 PNG，您可以在 URL 中指定该大小（以像素为单位）。

清除缓存以使用实时数据

您可以选择添加 URL 参数 ?:refresh=yes 强制刷新数据查询而不是从缓存中获取结果。如果将 tabcmd 与您自己的脚本结合使用，则大量使用 refresh 参数可能会对性能造成负面影响。建议您仅当需要实时数据时才使用 refresh，例如，在单个仪表板上而不是整个工作簿上。

示例

视图

tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"

tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth.csv"

tabcmd get "/views/Finance/InvestmentGrowth.png?:size=640,480" -f growth.png

tabcmd get "/views/Finance/InvestmentGrowth.png?:refresh=yes" -f growth.png

工作簿

tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb"

全局选项

login

使 Tableau Online 用户登录。

可使用 --server、--site、--username、--password 全局选项来创建会话。

注意：使用 tabcmd login 命令时，将无法使用 SAML 站点登录 (SSO)，即使您的站点配置为使用 SAML。若要登录，您必须传递在站点中创建的用户的用户名和密码。您将具有您在登录时使用的 Tableau Server 用户的权限。

如果要使用创建会话时使用的相同信息进行登录，只需指定 --password 选项。将使用存储在 Cookie 中的服务器和用户名。

如果服务器使用 80（默认值）之外的端口，您需要指定该端口。

仅当服务器运行多个站点，并且您登录的站点不是默认站点时，才需要使用 --site (-t) 选项。如果未提供密码，则会提示您输入密码。如果指定 --no-prompt 选项但未提供密码，则该命令将失败。

登录后，该会话将继续进行，直到其在服务器上过期或 logout 命令运行。

示例

登录到具有指定的站点 ID 的 Tableau Online 站点：

tabcmd login -s https://online.tableau.com -t siteID -u user@email.com -p password

选项

• -s, --server

• 如果从网络上的 Tableau Server 计算机中运行命令，您可以使用 http://localhost。否则，指定计算机的 URL，例如 http://bigbox.myco.com 或 http://bigbox。

  如果服务器使用 SSL，则需要在计算机的 URL 中指定 https://。

  对于 Tableau Online，请指定 URL https://online.tableau.com。

• -t, --site

• 当服务器具有多个站点，并且您登录的站点不是默认站点时，请使用此选项。

  在 URL 中使用站点 ID 以唯一地标识站点。例如，名为 West Coast Sales 的站点的 ID 可能为 west-coast-sales。

• -u, --username

• 登录用户的用户名。对于 Tableau Online，用户名是用户的电子邮件地址。

• -p, --password

• --username 所指定的用户的密码。如果未提供密码，则会提示您输入密码。

• --password-file

• 允许将密码存储在给定 filename.txt 文件中而不是命令行中以增加安全性。

• -x, --proxy

• 用于指定 tabcmd 请求的 HTTP 代理服务器和端口（主机:端口）。

• --no-prompt

• 不提示输入密码。如果未指定密码，则 login 命令将失败。

• --cookie

• 登录时保存会话 ID。后续命令将不需要登录名。此值是命令的默认值。

• --no-cookie

• 成功登录后不保存会话 ID 信息。后续命令将需要登录名。

• --timeout SECONDS

• 处理 login 命令前服务器应等待的秒数。默认值：30 秒。

全局选项

logout

退出服务器。

示例

tabcmd logout

publish filename.twb(x)、filename.tds(x) 或 filename.hyper

将指定的工作簿 (.twb(x))、数据源 (.tds(x)) 或数据提取 (.hyper) 发布到 Tableau Online。

如果发布工作簿，则默认情况下无需数据库用户名或密码即可发布工作簿中的所有工作表。

将从在其中发布文件的项目中复制最初分配给工作簿或数据源的权限。可在发布了文件后更改已发布资源的权限。

如果工作簿中包含用户筛选器，则必须指定一个缩略图选项。

示例

tabcmd publish "analysis_sfdc.hyper" -n "Sales Analysis"
--oauth-username "user-name" --save-oauth

如果文件与 tabcmd 并不位于同一目录，请包含文件的完整路径。

示例

tabcmd publish "\\computer\volume\Tableau Workbooks\analysis_sfdc.hyper" -n "Sales Analysis" --oauth-username "username" --save-oauth

选项

• -n, --name

• 服务器上工作簿或数据源的名称如果省略，则工作簿、数据源或数据提取将以文件名来命名。

• -o, --overwrite

• 如果服务器上已存在该工作簿、数据源或数据提取，则将其覆盖。

• -r, --project

• 将工作簿、数据源或数据提取发布到指定项目。如果未指定，则发布到“Default”项目。

• --parent-project-path

• 指定使用 -r 选项指定的嵌套项目的父项目的名称。例如，若要指定“Main”项目中名为“Nested”的项目，请使用以下语法： --parent-project-path "Main" -r "Nested"。

• --db-username

• 使用此选项可将数据库用户名与工作簿、数据源或数据提取一起发布。

  如果通过受保护 OAuth 连接和访问令牌连接到数据源，则应改用 --oauth-username 选项。

• --db-password

• 使用此选项可将数据库密码与工作簿、数据源或数据提取一起发布。

• --save-db-password

• 将提供的数据库密码存储在服务器上。

• --oauth-username

• 用户帐户的电子邮件地址。如果用户对 --name 中指定的云端数据源已经有保存的访问令牌，则通过预先配置的 OAuth 连接来连接该用户。访问令牌在用户首选项中管理。

  对于数据源的现有 OAuth 连接，应使用该选项而不是 --db-username 和 --db-password。

• --save-oauth

• 将 --oauth-username 指定的凭据保存为已发布工作簿或数据源的嵌入式凭据。

  随后，当发布者或服务器管理员登录服务器并编辑该工作簿或数据源的连接时，连接设置将显示此 OAuth 凭据已嵌入到内容中。

  如果要安排在发布后刷新数据提取，则必须对 --oauth-username 使用该选项。这与对传统的数据库连接使用 --save-db-password 类似。

• --thumbnail-username

• 如果工作簿中包含用户筛选器，则将基于指定用户可看到的内容生成缩略图。设置 --thumbnail-group 选项后，无法指定此选项。

• --thumbnail-group

• 如果工作簿中包含用户筛选器，则将基于指定组可看到的内容生成缩略图。设置 --thumbnail-username 选项后，无法指定此选项。

• --tabbed

• 发布带有选项卡式视图的工作簿时，每个工作表都成为一个选项卡，Viewer（查看者）可以使用这些选项卡在工作簿中导航。请注意，此设置将替代任何工作表级安全设置。

• --append

• 将数据提取文件附加到现有的数据源中。

• --replace

• 使用数据提取文件替换现有的数据源。

• --disable-uploader

• 禁用增量文件上传器。

• --restart

• 重新启动文件上载过程。

全局选项

refreshextracts workbook-name 或 datasource-name

对属于指定工作簿或数据源的数据提取执行完全或增量刷新。

此命令使用服务器上显示的工作簿或数据源的名称，而不使用发布时的文件名。仅允许管理员或者工作簿或数据源的所有者执行此操作。

注意：

• 如果服务器管理员为站点禁用了“立即运行”设置，此方法将失败并导致错误。有关详细信息，请参见 Tableau Server 设置(链接在新窗口中打开)。

• 您可以使用 tabcmd 来刷新云中承载的支持的数据源。例如，云平台上的 SQL Server、MySQL、PostgreSQL；Google Analytics；诸如此类。

• 若要使用 tabcmd 刷新本地数据，数据源必须是可为 Tableau Bridge 建议计划配置的类型。对于连接到本地数据的所有其他数据源，您可以使用 Bridge 或命令行数据提取实用程序。有关详细信息，请参见使用 Bridge 使数据保持最新和从命令行中自动执行数据提取刷新任务。

示例

tabcmd refreshextracts --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --parent-project-path "Main" --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --workbook "My Workbook"

tabcmd refreshextracts --url SalesAnalysis

tabcmd refreshextracts --workbook "My Workbook" --addcalculations

tabcmd refreshextracts --datasource sales_ds --removecalculations

选项

• --incremental

• 运行增量刷新操作。

• --synchronous

• 将完全刷新操作添加至后台程序进程所使用的队列，以在后台程序进程可用时立即运行。如果后台程序进程可用，则立即运行此操作。刷新操作会出现在“后台任务”报告中。

  在同步刷新期间，tabcmd 在刷新操作进行时保持实时连接到服务器，并且每秒钟进行一次轮询，直到后台作业完成为止。

• --workbook

• 包含要刷新的数据提取的工作簿的名称。如果工作簿名称中含有空格，请将名称放入引号内。

• --datasource

• 包含要刷新的数据提取的数据源的名称。

• --project

• 与 --workbook 或 --datasource 结合使用可确定 Default 以外的项目中的工作簿或数据源。如果未指定，则使用“Default”项目。

• --parent-project-path

• 指定使用 --project 选项指定的嵌套项目的父项目的名称。

  例如：

  • 若要指定“Main”项目中名为“Nested”的项目，请使用以下语法：

  • --parent-project-path "Main" --project "Nested"

  • 指定在“Nested”项目中嵌套的名为“Nested2”的项目：

  • --parent-project-path "Main/Nested" --project "Nested2"

• --url

• 显示在 URL 中的工作簿的名称。发布为“Sales Analysis”工作簿的 URL 名称为“SalesAnalysis”。

• --addcalculations

• 与 --workbook 结合使用以在工作簿的嵌入式数据提取中实现计算，或与 --datasource 结合使用以在数据提取数据源中实现计算。将操作添加到后台程序进程使用的查询中。如果后台程序进程可用，操作将立即运行。此操作出现在数据提取后台任务 管理视图中。

• --removecalculations

• 与 --workbook 或 --datasource 结合使用可移除以前实现的计算。将操作添加到后台程序进程使用的查询中。如果后台程序进程可用，操作将立即运行。此操作出现在数据提取后台任务 管理视图中。

全局选项

removeusers group-name

从指定的组中移除用户。

示例

tabcmd removeusers "Development" --users "users.csv"

选项

• --users

• 从指定的组删除给定 .csv 文件中的用户。该文件应是每行一个用户名的简单列表。

• --[no-]complete

• 要求所有行都必须有效，更改才能成功。如果未指定，则使用 --complete。

全局选项

runschedule schedule-name

运行指定的计划。

此命令按原样使用服务器上的计划名称。

此命令不可用于 Tableau Online。

注意：如果服务器管理员为站点禁用了“立即运行”设置，此方法将失败并导致错误。有关详细信息，请参见 Tableau Server 设置(链接在新窗口中打开)。

示例

tabcmd runschedule "5AM Sales Refresh"

全局选项

所有 tabcmd 命令都使用以下选项。若要开始一个会话，至少需要使用一次 --server、--user 和 --password 选项。将存储一个身份验证令牌，以便可以不用包括这些选项就能运行后续命令。此令牌在使用它的最后一个命令之后五分钟内保持有效。

• -h, --help

• 显示命令帮助。

  注意：将 tabcmd 与 Tableau Online 结合使用时，列出的某些命令可能不适用。

• -s, --server

• Tableau Online URL，至少需要使用一次才能开始会话。

• -u, --user

• Tableau Online 用户名，至少需要使用一次才能开始会话。

• -p, --password

• Tableau Online 密码，至少需要使用一次才能开始会话。

• --password-file

• 允许将密码存储在给定 .txt 文件中而不是命令行中以增加安全性。

• -t, --site

• 指示命令将应用于由 Tableau Online 站点 ID 指定的站点，用单引号或双引号引起来。如果指定的用户与多个站点关联，请使用此选项。使用缓存的身份验证令牌时，站点 ID 区分大小写。如果大小写不匹配，则即使令牌仍然有效，系统也可能提示您输入密码。

• --no-prompt

• 指定后，该命令将不提示输入密码。如果未提供有效密码，则该命令将失败。

• --[no-]cookie

• 指定后，登录时将保存会话 ID，这样后续命令就无需登录。若要不保存会话 ID，请使用 no- 前缀。默认情况下，将保存会话。

• --timeout

• 等待指定秒数以使服务器完成命令处理。默认情况下，进程将等待服务器响应。

• --

• 指定命令行上的选项结尾。您可以使用 -- 向 tabcmd 指明不应将 -- 后面的内容解释为选项设置，而是解释为命令的值。如果需要在包括连字符的命令中指定值，这将非常有用。下面的示例演示如何能在 tabcmd 命令中使用 --，在该命令中，-430105/Sheet1 是 export 命令的必需值。

  tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

1. tabcmd 的安装开关和属性 (Windows)

3. 通过 Windows 上的命令行安装 Tableau Server 命令行实用程序 (tabcmd) 版本 2019.4.0 或更高版本时，可以使用以下开关。

4. 重要信息：为了确保 Tableau Online 的可用性并避免中断，请确保在 2022 年 1 月之前将 tabcmd 客户端升级到高于 2020.2 的版本。tabcmd 版本向后兼容 API，不需要更改代码。有关详细信息，请参见安装 tabcmd。

5. 注意：对于 Tabcmd 安装程序的 Linux 版本，没有等效的开关。

6. 开关	描述	注释
   /install | /repair | /uninstall | /layout ""	运行安装程序来安装、修复或卸载 tabcmd，使用 /layout 则会指定目录中创建安装包的完整本地副本。	默认值为进行安装，并显示 UI 和所有提示。如果在全新安装时未指定目录，则使用 C:\Program Files\Tableau\Tableau Server\。
   /passive	运行安装程序并显示最少的 UI，并且不显示提示。
   /quiet | /silent	以无人参与的完全无提示模式运行安装程序。不会显示任何 UI 或提示。	注意：使用 /silent 或 /quiet，不要两者都使用。
   /norestart	运行安装程序而不重新启动 Windows，即使必须重新启动也是如此。	注意：在某些极少数情况下，即使使用此选项，也无法抑制重新启动。当跳过较低版本系统的重新启动时（例如，在安装其他软件期间），很可能出现这种情况。
   /log "	将信息记录到指定的文件和路径。 默认情况下，系统使用命名约定 Tableau_Server_Command_Line_utility_ 在用户的 %TEMP% 文件夹中创建日志文件。	如果未指定文件位置，则将日志文件写入用户的 TEMP 文件夹 (C:\Users\)。安装之后，检查此日志文件来查找错误。 示例：

8. 属性	描述	注释
   ACCEPTEULA=1|0	接受最终用户许可协议 (EULA)。对于无提示和被动安装为必需。1 = 接受 EULA，0 = 不接受 EULA。	如果使用 /passive、/silent 或 /quiet 时未包括此属性，则安装程序将无法以无提示形式运行。 如果包含此属性但设置为 0，安装程序将失败
   INSTALLDIR="	将 tabcmd 安装到指定的非默认安装位置。	指定用于安装 tabcmd 的位置。如果未使用，则 tabcmd 将安装到 C:\Program Files\Tableau\Tableau Server\ 示例：