Tableau Server
管理员指南
Version 8.2; Last Updated in 2014
Copyright © 2014 Tableau Software, Incorporated and its licensors. All rights reserved.
This product is Client Software as defined in Tableau Software’s End User Software License
Agreement.
安装之前...
确保要安装 Tableau Server 的计算机满足以下要求：
l
l
支持的操作系统 － Tableau Server 提供有 32 位和 64 位两种版本。可在 Windows
Server 2003 R2 SP2 或更高版本、Windows Server 2008、Windows Server 2008
R2、Windows Server 2012、Windows 7、Windows 8 或 Windows 8.1 上安装
Tableau Server。建议在 64 位操作系统上使用 64 位版本的 Tableau Server。虽然
Tableau Server 可以在 32 位操作系统上良好运行，但建议使用 64 位操作系统。
您可以在虚拟或物理平台上安装 Tableau Server。
内存、内核和磁盘空间建议 - Tableau Server 的系统要求会因多种因素而发生变
化。以下是根据服务器上的用户数提出的 最低 建议：
部署类
型
评估/概
念证明
( 64 位
Tableau
Server)
评估/概
念证明
32 位
Tableau
Server
小型
中型
企业
服务器用户数
CPU
RAM
可用磁盘空间
1-2
4 内核
8 GB
1.5 GB
1-2
2 内核
4 GB
1.5 GB
<25
<100
>100
4 内核
8 内核
16 内核
8 GB
5 GB
32 GB
50 GB
32 GB 或更 50 GB 或更多
多
运行 64 位版本 Tableau Server 的最低要求是 4 核、8 GB RAM。
l
l
l
管理帐户 — 要安装 Tableau Server 的帐户必须拥有安装软件和服务的权限。
可选： 运行身份帐户 — 如果您将 NT 身份验证用于数据源或计划进行 SQL
Server 模拟，则用于运行 Tableau Server 服务的用户运行身份帐户会十分有用。
有关更多信息，请参见用户运行身份 在本页 270和 SQL Server 模拟 在本页
278。
IIS 和 端口 80 - Tableau Server 的网关侦听端口 80，且 Internet Information
Services (IIS) 默认情况下也使用此端口。如果您在同样运行 IIS 的计算机上安装
Tableau Server，则应修改 Tableau 的网关端口号以避免与 IIS 发生冲突。如果您
在同样运行 IIS 的计算机上安装 Tableau Server，则应修改 Tableau 的网关端口
号以避免与 IIS 发生冲突。有关详细信息，请参见 TCP/IP 端口 在本页 284和修
改默认端口 在本页 285。
-3-
配置信息
安装和配置 Tableau Server 时，您可能需要提供以下信息：
选项
说明
服务器帐户 服务器必须有一个该服务可以使用的用户帐户。
默认设置为内置的 Windows 网络服务帐户。如果
使用特定用户帐户，则需要提供域名、用户名和
密码。
Active
您可以通过 Active Directory 进行身份验证，而不使
Directory
用 Tableau 的内置用户管理系统。如果是这样，您
需要使用完全限定域名。
打开
选中此选项后，Tableau Server 将打开 Windows 防
Windows 防 火墙软件中用于 http 请求的端口，以允许网络中的
火墙中的端 其他计算机访问该服务器。
口
您的信息
用户名：
密码：
域：
Active Directory
域：
__ — 是
__ — 否
端口
默认情况下，Tableau Server 要求多个 TCP/IP 端口可供服务器使用。请参见主题
TCP/IP 端口 在本页 284以获得完整列表，包括哪些端口必须可用于所有安装和分布
式安装或故障转移就绪安装。如果发生冲突，则可以更改默认端口。请参见修改默
认端口 在本页 285了解如何操作。
驱动程序
您可能需要安装其他数据库驱动程序。可从 www.tableausoftware.com/support/drivers
下载驱动程序。
-4-
安装和配置
下面是安装和配置 Tableau Server 时需要执行的主要步骤：
运行服务器安装程序
下载 Tableau Server 安装文件后，请按照下面的步骤安装服务器。
1. 双击安装文件。
2. 按照屏幕指示完成安装并安装应用程序。
3. 安装完成后，单击“下一步”打开“产品密钥管理器”窗口。
如果需要支持非“Latin-1”字符集，请通过“控制面板”>“区域和语言选项”来安装
Windows 语言包。主服务器以及任何工作计算机上都需要安装语言包。
激 活 Tableau
Tableau Server 要求至少使用一个产品密钥来同时激活服务器和指定可为用户分配的
许可级别数。您可以在 Tableau 客户帐户中心访问自己的产品密钥。安装和配置服务
器后，产品密钥管理器会自动打开，您可以输入自己的产品密钥并注册产品。如果
需要在脱机计算机中激活产品，请参见脱机激活 Tableau 下一页。
-5-
1. 选择“激活”，然后粘贴产品密钥：
2. 关于分步说明，请参见该网站上的下载帮助页面。
脱 机 激 活 Tableau
如果需要脱机工作，可按照以下步骤完成脱机激活。
1. 产品密钥管理器打开后，单击“激活产品”。
将服务器产品密钥粘贴到相应的文本框中，然后单击“激活”。您可以在 Tableau
客户门户中获得自己的产品密钥。
2. 如果处于脱机状态，激活将失败，系统会提供一个选项用于保存脱机激活文
件。单击“保存”。
3. 为文件选择一个位置，然后单击“保存”。文件将保存为 offline.tlq。
4. 返回 Tableau，单击“退出”关闭“激活”对话框。
5. 从能够访问 Internet 的计算机上，打开 Web 浏览器并访问 Tableau 网站上的产品
激活页。完成说明中的步骤并提交 offline.tlq 文件。
联机提交您的 offline.tlq 文件后，尽管您的浏览器仍显示产品激活页，但已经创
建一个名为 activation.tlf 的文件，并且 Tableau 会提示您将此文件保存到您的计
算机。
6. 保存 activation.tlf 文件并将其移到安装 Tableau Server 的计算机中。如果计算机
-6-
中安装了 Tableau Desktop，可以双击这个新文件完成激活。如果没有安装
Tableau Desktop，请继续执行步骤 7。
7. 在安装 Tableau Server 的计算机中，以管理员身份打开命令提示符，运行以下
命令：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
8. 接下来键入 tabadmin activate --tlf <path>\activation.tlf，其中
<path> 是您从产品激活页中保存的响应文件的位置。 例如：
tabadmin activate --tlf \Desktop\activation.tlf
将命令提示符窗口保持打开状态。
9. 初始化许可证后，将提示您再次激活产品。在 Tableau Server 上，依次单击“开
始”>“所有程序”>“Tableau Server 8.2”>“管理产品密钥”。
10. 单击“激活产品”。
11. 再次输入产品密钥
与在步骤 1 中输入的产品密钥相同
。
12. 保存 .tlq 文件。
13. 从能够访问 Internet 的计算机上，打开 Web 浏览器并访问 Tableau 网站上的产品
激活页。完成说明中的步骤。
Tableau 将再次创建一个名为 activation.tlf 的文件并提示您保存它。
14. 保存文件并将其移到安装 Tableau Server 的计算机中。
15. 返回到 Tableau Server 上的命令提示符窗口，键入 tabadmin activate -tlf <path>\activation.tlf，其中 <path> 是您从产品激活页中保存的第
二个响应文件的位置。 例如：
tabadmin activate --tlf \Desktop\activation.tlf
Tableau Server 现在已激活。如果需要其他帮助，请与 Tableau 客户服务部门联
系。
配置服务器
安装期间会显示“配置”对话框。通过在 Windows“开始”菜单上选择“所有程
序”>“Tableau Server 8.2”>“配置 Tableau Server”，可以在安装后打开此对话框。在
进行任何配置更改之前，需要停止服务器。有关步骤，请参见重新配置服务器 在本
页 21。
关于您在“配置”对话框中指定的设置，有两点需要注意：
l
l
设置是系统范围的：您输入的设置会应用于整个服务器。如果服务器正在运行
多个站点，则这些设置会影响每个站点。
用户身份验证是“永久性的”：通过停止服务器并重新配置，可以在安装后更改
所有设置。但“用户身份验证”设置 位于“常规”选项卡 例外。之所以说它是
-7-
“永久性的”是因为，从“使用本地身份验证”更改为“使用 Active Directory”需要
您先卸载服务器，然后重新安装服务器。
有关不同“配置”选项卡的详细信息，请参见以下主题：
常规
通过下面的步骤可以在“常规”选项卡上配置选项：
1. 默认情况下，Tableau Server 在“网络服务”帐户下运行。若要使用将为数据源提
供 NT 身份验证功能的帐户，请指定用户名和密码。用户名中应包含域名。要
详细了解如何使用特定用户帐户，请访问 用户运行身份 在本页 270。
2. 选择是否使用 Active Directory 对服务器上的用户进行身份验证。选择“使用本
地身份验证”以使用 Tableau Server 的内置用户管理系统来创建用户并分配密
码。您随后无法在 Active Directory 和本地身份认证之间进行切换。
3. 如果使用 Active Directory：
l
l
您可以选择“启用自动登录”，这会使用 Microsoft SSPI 基于用户的
Windows 用户名和密码自动使用户登录。这将创建类似于单点登录 (SSO)
的体验。如果计划将 Tableau Server 配置为使用 SAML、受信任身份验证
或代理服务器，请勿选择“启用自动登录”。
请确保键入完全限定域名 (FQDN) 和昵称。
确定 FQDN：选择“开始”>“运行”，然后在“运行”文本框中键入
sysdm.cpl。在“系统属性”对话框中，选择“计算机名”选项卡。FQDN 显
示在对话框的中心附近位置。您的用户首次登录时，需要使用完全限定
域名 例如 myco.lan\jsmith 。以后进行登录时，他们可以使用昵称
(myco\jsmith)。
4. 通过 Web 访问 Tableau Server 通过 HTTP 时的默认端口为端口 80。如果其他
服务器正在端口 80 上运行或者有其他联网需要，则可能需要更改端口号。例
如，如果 Tableau Server 主机前面有硬件防火墙或代理，则后端系统可能不适
合在端口 80 上运行。
-8-
5. 选择是否打开 Windows 防火墙中的端口。如果不打开此端口，则其他计算机上
的用户可能无法访问该服务器。
6. 选择是否包含示例数据和用户。示例数据可帮助您熟悉 Tableau Server，尤其在
安装该产品的试用版时。最初，示例用户使用一个交互者许可证。为了收回该
许可级别，您可将此用户更改为未许可。若要了解如何操作，请参见 许可和用
户权限 在本页 74。如果选择包括该示例用户，则将安装一个单个用户。用户名
和密码如下所示：
用户名
密码
Tableau 软件 test
7. 可选择继续打开下一个页面以配置“缓存”和“初始 SQL”选项。如果不想配置这些
选项，请单击“确定”。
域
在针对服务器使用 Active Directory 身份验证时，您可以查看所使用的域的列表，并编
辑这些域的域名和昵称。例如，为了确保 Tableau Server 在 SSPI 身份验证时使用正
确的昵称或使用正确的域名，您可能需要执行此操作。
修改域名
修改域名：
1. 在页面左侧的“管理”区域中选择“用户”链接。
2. 单击用户列表底部的“域”链接。域列表显示了从每个域添加到服务器的用户和
组的数量。
3. 若要显示作为域的一部分的用户的列表，请单击域名。
4. 若要修改域名或昵称，请单击“编辑”链接，键入新的完全限定域名或昵称，然
-9-
后单击“修改”。
您可以修改服务器正在使用的任何域的昵称。通常，除了您用来登录的域外，
您可以修改任何域的完整域名。但是，如果您当前用来登录的用户名同时存在
于当前域以及新域中，则只能修改当前域的完整域名。
数据连接
使用“数据连接”选项卡上的选项可以配置缓存并指定要如何从数据源处理初始 SQL 语
句。
正在缓存
发布到 Tableau Server 的视图是交互式的，有时具有与数据库的实时连接。当用户在
Web 浏览器中与这些视图交互时，查询的数据将存储在缓存中。随后的访问将从此
缓存中取出数据 如果有数据 。您可通过“数据连接”选项卡来配置将应用于所有数
据连接的缓存设置：
- 10 -
若要配置缓存，请选择以下选项之一：:
l
l
l
刷新频率低于 — 每当有数据时就对数据进行缓存并重复使用，而不管该数据是
何时添加到缓存的。此选项可将发送到数据库的查询数量降到最低。当数据变
化不频繁时，可选择此选项。“刷新频率低于”可以提高性能。
平衡 — 在指定的分钟数之后将缓存中的数据删除。如果在指定时间内已将数据
添加到缓存，则将使用缓存的数据，否则，将在数据库中查询新数据。
刷新频率高于 — 每次加载页面时都查询数据库。仍将对数据进行缓存，并在用
户重新加载页面之前重新使用该数据。此选项可确保用户看到最新的数据，但
可能会降低性能。
无论缓存是如何配置的，用户都可以单击工具栏中上“刷新数据”按钮，以
强制服务器发送查询并检索新数据。
初始 SQL
对于连接到 Teradata 数据源的视图，工作簿创建者可指定在浏览器中加载工作簿时
只运行一次的 SQL 命令。该命令称为初始 SQL 语句。出于性能或安全原因，某些管
理员可能想要禁用此功能。可以在数据连接选项卡上执行此操作：
- 11 -
若要禁用初始 SQL 功能，请选中“对所有数据源忽略初始 SQL”复选框。使用初始
SQL 语句创建的工作簿仍会打开，但不会发送初始 SQL 命令。
通知和订阅
Tableau Server 可以在系统出现故障时通过电子邮件向您发送通知，也可以通过电子
邮件向 Tableau Server 用户发送订阅 即所收藏视图的快照 。在“通知和订阅”选项
卡上，您可以指定 Tableau Server 用于发送电子邮件的 SMTP 服务器。
对于通知和订阅，不支持加密的 SMTP 连接。
配置电子邮件通知
如果您配置了通知，一旦数据引擎、存储库或网关服务器进程停止或重新启动，或
者一旦主 Tableau Server 停止或重新启动，Tableau Server 就会在“将电子邮件发送至”
下向收件人发送邮件。如果您运行的是单服务器安装 所有进程在同一台计算机上
运行 ，则 DOWN 通知表示整个服务器停止运行，而随后出现的 UP 电子邮件通知
表示服务器又重新运行。如果您运行的是专为故障转移配置的分布式安装 参见配
置故障转移和多个网关 在本页 44 ，则 DOWN 通知表示活动存储库或数据引擎实例
出现故障，而随后出现的 UP alert 通知表示该进程的备用实例已被接管或现处于活动
状态。
- 12 -
要配置电子邮件通知，请执行以下操作：
1. 选择“针对服务器运行状况问题发送电子邮件通知”。
2. 在“SMTP 服务器”下，输入您的 SMTP 服务器的名称。输入 SMTP 服务器帐户
的“用户名”和“密码” 仅当需要时输入；有些需要，有些则不需要 。默认
SMTP 端口号为 25。在“电子邮件的发送地址”下输入一个电子邮件地址，当系
统发生故障时，将向此地址发送通知。尽管您输入的电子邮件地址必须具有有
效的语法 例如 ITalerts@bigco.com or noreply@myco ， 但也不一定必须是
Tableau Server 上的实际电子邮件帐户。
保持“启用 TLS”复选框处于未选中状态，以便不对邮件服务器连接加密。
3. 在“将电子邮件发送至”中至少输入一个用于接收通知的电子邮件地址。如果输
入多个电子邮件地址，请用逗号 而不是分号 将各地址隔开。
4. 单击“确定”。当您启动服务器时，它将触发电子邮件通知，这将确认您已正确
设置通知。
配置电子邮件订阅
若要设置 SMTP 服务器用于发送订阅，请执行以下操作：
1. 选择“启用电子邮件订阅”。
2. 在“SMTP 服务器”下，输入您的 SMTP 服务器的名称。输入 SMTP 服务器帐户
- 13 -
的“用户名”和“密码” 仅当需要时输入；有些需要，有些则不需要 。默认
SMTP 端口号为 25。在“电子邮件的发送地址”下输入将用于向 Tableau Server 用
户发送订阅的电子邮件地址。
尽管您输入的电子邮件地址必须具有有效的语法 如 <text>@<text> 中的
salesteam@bigco.com 或 noreply@myco ，但是 Tableau Server 不需要它是
实际电子邮件帐户 然而，某些 SMTP 服务器可能需要它是实际电子邮件帐
户 。您还可以逐个站点地覆盖用于订阅的系统范围的“电子邮件的发送地
址”。有关详细信息，请参见添加或编辑站点 在本页 106。
保持“启用 TLS”复选框处于未选中状态，以便不对邮件服务器连接加密。
3. 在“Tableau Server URL”下，输入 http:// 或 https://，后跟 Tableau Server
的名称。此名称将用于订阅电子邮件的页脚。
4. 单击“确定”。
SSL
可以将 Tableau Server 配置为对所有 HTTP 流量使用安全套接字层 (SSL) 加密的通
信。设置 SSL 可确保对 Tableau Server 的访问是安全的，并且在 Web 浏览器与服务器
之间或 Tableau Desktop 与服务器之间传递的敏感信息将受到保护。下面的主题介绍
了针对 SSL 配置服务器的步骤；不过，您必须先从受信任的颁发机构获取证书，然
后将证书文件导入到 Tableau Server 中。如果您运行的是 Tableau Server 群集并且希
望使用 SSL，请参见下面的 SSL 向上以获取建议。
配置 SSL
将 Tableau Server 配置为使用 SSL：
- 14 -
1. 从受信任的颁发机构 例如 Verisign、Thawte、Comodo、GoDaddy 等 获取
Apache SSL 证书。您也可以使用您的公司颁发的内部证书。还支持允许您将
SSL 用于同一个域中多个主机名的通配符证书。
某些浏览器还需要其他配置才能接受来自特定提供者的证书。请参见由您的证
书颁发机构提供的文档。
2. 将证书文件放在与 Tableau Server 8.2 文件夹同级的名为 SSL 的文件夹中。例
如：
C:\Program Files\Tableau\Tableau Server\SSL
此位置为运行 Tableau Server 的帐户提供这些文件的必要权限。
3. 通过在“开始”菜单上选择“开始”>“所有程序”>“Tableau Server 8.2”>“配置
Tableau Server”打开 Tableau Server 配置实用工具。
4. 在“配置 Tableau Server”对话框中，选择“SSL”选项卡。
5. 选择“将 SSL 用于服务器通信”并提供以下每个证书文件的位置：
SSL 证书文件 — 必须是有效的 PEM 编码 x509 证书，扩展名为 .crt
SSL 证书密钥文件 — 必须是不受密码保护的有效 RSA 或 DSA 密钥，文件扩展
名为 .key
SSL 证书链文件( 可选) — 某些证书提供者会针对 Apache 颁发两个证书。第
二个证书是链文件，连接构成服务器证书的证书链的所有证书。文件中的所有
证书必须为 x509 PEM 编码，文件扩展名必须为 .crt 而不是 .pem 。
- 15 -
6. 单击“确定”。更改将在下次重新启动服务器时生效。
针对 SSL 配置服务器后，该服务器会将请求接受到非 SSL 端口 默认为端口
80 并自动重定向至 SSL 端口 443。SSL 错误记录在以下位置处的安装目录
中。使用此日志可解决验证和加密问题。
C:\ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\httpd\error.log
Tableau Server 仅支持端口 443 作为安全端口。它不能在有其他应用程序
正在使用端口 443 的计算机上运行。
为群集配置 SSL
您可将 Tableau Server 群集配置为使用 SSL。如果主 Tableau Server 是唯一一个
运行网关进程的节点 默认情况下如此 ，则您只需要在此节点上配置 SSL。
有关步骤，请参见上述过程。
- 16 -
SSL 和 多 个 网 关
一个高度可用的 Tableau Server 群集可包括多个网关，它们前面有负载平衡器
了解详情 。 如果您要将此类型的群集配置为使用 SSL，则有两种选择：
l
l
为 SSL 配置负载平衡器。从客户端 Web 浏览器到负载平衡器的流量会经
过加密。从负载平衡器到 Tableau Server 网关进程的流量不会经过加密。
不需要在 Tableau Server 中进行 SSL 配置，这全都由负载平衡器处理。
将 Tableau Server 配置为使用 SSL： 从客户端 Web 浏览器到负载平衡器
以及从负载平衡器到 Tableau Server 网关进程的流量都会经过加密。有关
详细信息，请参见以下过程。
将 服 务 器 群 集 配 置 为 使 用 SSL
当您将 Tableau Server 群集配置为使用 SSL 时，您将 SSL 证书和密钥文件放在
运行网关进程的每台计算机上。将 Tableau Server 群集配置为使用 SSL：
1. 将负载平衡器配置为使用 SSL 传递。请查阅负载平衡器的文档以获取帮
助。
2. 确保为负载平衡器的主机名颁发了所使用的 SSL 证书。
3. 按照上面过程中所述配置主 Tableau Server。
4. 将用于主服务器的同一 SSL 证书和密钥文件放在运行网关进程的每台
Tableau 工作服务器上。对工作计算机使用您用于主服务器的相同文件夹
位置。您无需对工作计算机执行任何其他配置。
例如，使用包含一台主 Tableau Server 和三台工作计算机的群集。网关进
程运行在主服务器、工作服务器 2 和工作服务器 3 上。在此情况下，您将
主 Tableau Server 配置为使用 SSL，然后将同一 SSL 证书和密钥文件复制
到工作服务器 2 和工作服务器 3。因为这些文件位于主服务器上的
C:\Program Files\Tableau\Tableau Server\SSL 文件夹中，所以它们位于工作
服务器 2 和工作服务器 3 上的同一位置。
SAML
可以将 Tableau Server 配置为使用外部身份提供程序 (IdP) 通过 SAML 对 Tableau
Server 用户进行身份验证。所有用户身份验证都在 Tableau 中完成，无论您是使用
Active Directory 还是 Tableau Server 中的本地身份验证来管理 Tableau Server 上的用
户。这使您能够在组织中的所有应用程序之间提供单点登录体验。
在将 Tableau Server 配置为使用 SAML 之前，确保满足 SAML 要求 在本页 265。
配置 SAML
将 Tableau Server 配置为使用 SAML：
1. 将证书文件放在与 Tableau Server 8.2 文件夹同级的名为 SAML 的文件夹中。例
如：
C:\Program Files\Tableau\Tableau Server\SAML
- 17 -
此位置为运行 Tableau Server 的帐户提供这些文件的必要权限。
2. SAML 配置在“SAML”选项卡上完成，Tableau Server 安装过程中会显示该选项
卡。如果在安装后配置 SAML，请通过打开 Tableau Server 配置实用工具 开始
> 所有程序 > Tableau Server 8.2 > 配置 Tableau Server 并单击“SAML”选项卡
来访问 SAML。
3. 在“SAML”选项卡上，选择“使用 SAML 进行单点登录”并提供以下各项的位置：
Tableau Server 返回 URL － Tableau Server 用户将访问的 URL，例如
http://tableau_server。不建议使用 http://localhost，也不支持结尾有斜杠的 URL
例如，http://tableau_server/ 。
SAML 实体 ID - 实体 ID 可向 IdP 唯一地标识您的 Tableau Server 安装。如果您愿
意，可以在此处再次输入 Tableau Server URL，但它不必非得是您的 Tableau
Server URL。
SAML 证书文件 - PEM 编码的 x509 证书，文件扩展名为 .crt。此文件由 Tableau
Server 而不是 IdP 使用。
SAML 证书密钥文件 - 不受密码保护的 RSA 或 DSA 私钥文件，文件扩展名为
.key。此文件由 Tableau Server 而不是 IdP 使用。
4. 暂时将“SAML IdP 元数据文件”文本框保留为空，然后单击“导出元数据文件”。
5. 将会打开一个对话框，允许您将 Tableau Server 的 SAML 设置保存为 XML 文
件。此时，不包括来自 IdP 的元数据。
使用所选名称保存 XML 文件。
6. 在您的 IdP 网站上或在其应用程序中：
- 18 -
l
l
将 Tableau Server 作为服务提供程序添加。您需要查阅 IdP 的文档，了解
如何操作。在此过程中，您将导入在步骤 5 中保存的文件。
确认您的 IdP 使用“用户名”作为要验证的属性元素。
7. 仍然是在 IdP 中，导出您的 IdP 的元数据 XML 文件。
8. 将 IdP 的元数据 XML 文件复制到 Tableau Server 计算机上的以下文件夹：
C:\Program Files\Tableau\Tableau Server\SAML
9. 在“Tableau Server 配置”对话框的“SAML”选项卡上，在“SAML IdP 元数据文件”
文本框中输入文件位置：
10. 单击“确定”。Tableau Server 现在已配置为使用 SAML 身份验证。
将 Server 群集配置为使用 SAML
当您将 Tableau Server 群集配置为使用 SAML 时，您需要将 SAML 证书和密钥文件放
置在运行 Tableau 应用程序服务器进程 又称为 wgserver 的每台计算机上。将
Tableau Server 群集配置为使用 SAML：
1. 按照上面过程中所述配置主 Tableau Server。
2. 将您用于此主服务器的同一 SAML 证书和密钥文件放置在运行应用程序服务器
进程的每台 Tableau 工作计算机上。对工作计算机使用您用于主服务器的相同
文件夹位置。您无需对工作计算机执行任何其他配置。
例如，使用包含一台主 Tableau Server 和三台工作计算机的群集。应用程序服
务器进程运行在主服务器、工作计算机 2 和 工作计算机 3 上。在此情况下，您
将主 Tableau Server 配置为使用 SAML，然后将同一 SAML 证书和密钥文件复制
到工作计算机 2 和工作计算机 3 上。因为这些文件在主服务器上位于
- 19 -
C:\Program Files\Tableau\Tableau Server\SAML 文件夹中，因此它们在工作计算
机 2 和工作计算机 3 上也位于这一相同位置。
测试配置
打开一个新的 Web 浏览器实例并在 URL 窗口中键入 Tableau Server 名称，来测试您
的 SAML 配置：
您应该会注意到出现的登录提示来自 IdP 而不是 Tableau Server：
添加管理员帐户
激活 Tableau Server 的最后一步是添加管理员帐户。管理员将具有服务器的完全访问
权限，包括管理用户、组和项目的权限。添加管理员帐户的步骤将根据是使用 Active
Directory 还是使用本地身份验证而有所不同。
Active Directory
如果使用 Active Directory，请键入将成为管理员的现有 Active Directory 用户的用户名
和密码。然后单击“添加用户”。
- 20 -
注意：
如果该管理员帐户与服务器在同一个域中，则只需键入用户名，无需键入域。否
则，应包括进完全限定域名。例如，test.lan\username。
本地身份验证
如果使用本地身份验证，请通过键入所选的用户名、显示名称和密码
来创建管理帐户。然后单击“添加用户”。
键入两次
重新配置服务器
输入 Tableau Server 配置设置是安装过程的一部分，但您可在安装后打开“配置”对话
框进行更改。有关详细信息，请参见以下步骤。也可以使用 tabadmin 在本页 306 命
- 21 -
令行工具进行配置更改。无论如何进行更改，新设置都会写入配置文件 tabsvc.yml，
此文件位于 config 目录中。
注意： 您不能在 Active Directory 和本地身份验证之间进行切换。只能在安装期间配置
这些选项。
若要在“Tableau Server 配置”对话框中更改设置，请执行以下操作：
1. 通过在 Windows“开始”菜单上选择“所有程序”>“Tableau Server 8.2”>“停止
Tableau Server”来停止服务器。
2. 然后在 Windows“开始”菜单中选择“配置 Tableau Server”。
3. 如果使用 Active Directory 帐户作为服务器的“用户运行身份”帐户，请在“常规”选
项卡上输入其密码。
4. 进行配置更改。
5. 单击“确定”。
6. 通过在 Windows“开始”菜单上选择“所有程序”>“Tableau Server 8.2”>“启动
Tableau Server”来启动服务器。
重新配置进程
若要更改针对单服务器安装配置进程的方式，请按以下步骤操作。如果您要更改针
对工作服务器配置进程的方式，请参见安装和配置工作服务器 在本页 36。
1. 在“开始”菜单中，通过导航到“所有程序”>“Tableau Server 8.2”>“配置 Tableau
Server”打开“Tableau Server 配置”对话框。
2. 如果需要在“常规”选项卡上输入您的“密码”，然后单击“服务器”选项卡：
3. 突出显示 This Machine，然后单击“编辑”：
- 22 -
4. “编辑 Tableau Server”对话框是您更改进程数的位置：
5. 您可以最多运行 VizQL 进程、应用程序服务器进程、Data Server 进程或后台进
程的 8 个实例 尽管如果需要可以更改此限制 。有关详细信息，请参见关于
服务器进程限制 在本页 32。另外，为使 Tableau Server 正常运行，数据引擎和
存储库必须始终有一个活动实例。有关如何将它们移动到其他计算机的步骤，
请参见移动数据引擎进程和存储库进程 在本页 31。有关如何配置它们的备用实
例的步骤，请参见高可用性 在本页 39。
在进行更改后，单击“确定”，然后再次单击“确定”退出“配置”对话框。
Tableau Server 进程
存在六个 Tableau Server 进程，可以更改其默认配置以获得不同的结果。主题提高服
务器性能 在本页 208和高可用性 在本页 39介绍了您可以采用的某些方法。每个进程
- 23 -
的高级别状态显示在服务器的“维护”页面，与某些进程
信息位于 管理视图 在本页 142 主题中。
例如后台进程
有关的详细
从结构上说，64 位版本的 Tableau Server 使用本机 64 位进程；32 位版本的 Tableau
Server 使用 32 位进程。但数据引擎例外。如果 32 位版本的 Tableau Server 安装在 64
位操作系统上，则会使用 64 位版本的数据引擎进程。
有关这些进程生成的日志文件的信息，请参见服务器日志文件位置 在本页 341。
进程
文件名
应用程序服 wgserver.exe
务器
是否
为多
用途
线
程？
处理 Web 应用程 是
序，支持浏览和
搜索
后台
backgrounder.exe 执行服务器任务 否
包括数据提取
刷新 、“立即
运行”任务以及
通过 tabcmd 启
动的任务
数据引擎
tdeserver64.exe 存储数据提取和 是
回答查询
tdeserver.exe
- 24 -
性能特征
在不经常使用的操作
例如，发布包含数
据提取的工作簿，或
者生成视图的静态图
像 中仅占用显而易
见的资源。可通过基
于浏览器的交互和
tabcmd 创建该进程的
负载。
可在群集内的任何或
所有计算机上运行多
个进程以扩展容量的
单线程进程。后台程
序通常不会占用很多
进程内存，但后台程
序可能会根据面向它
的工作负载的性质占
用 CPU 资源、I/O 资源
或网络资源。例如，
执行大量数据提取刷
新时，可能会使用网
络带宽来检索数据。
数据检索或复杂的
tabcmd 任务可能会占
用 CPU 资源。
数据引擎的工作负载
是来自 VizQL Server 进
程的请求产生的。该
进程是将数据提取加
载到内存并针对数据
提取执行查询的组
件。内存占用主要基
于所加载的数据提取
进程
文件名
Data Server dataserver.exe
存储库
postgres.exe
VizQL
Server
vizqlserver.exe
是否
为多
线
程？
用途
性能特征
的大小。在 64 位操作
系统上，默认使用 64
位二进制文件，即使
安装的是 32 位 Tableau
Server，也是如此。数
据引擎是多线程的进
程，可以一次处理多
个请求。在高负载的
情况下，该进程可能
会占用 CPU 资源、I/O
资源和网络资源，所
有这些资源都可能是
高负载的性能瓶颈。
高负载时，数据引擎
的单个实例可能会占
用所有 CPU 资源，以
便处理请求。
处理至 Tableau 是
由于该进程是一个代
Server 数据源的
理，因此它通常仅受
连接
限制于网络，但在有
很多同时存在的用户
会话时，可能会受限
制于 CPU。该进程的
负载是以下内容产生
的：基于浏览器的交
互，基于 Tableau
Desktop 的交互，以及
针对 Tableau Server 数
据源的数据提取刷新
作业。
Tableau Server 不适用 通常仅占用很少的资
数据库，用于存
源。执行诸如用户查
储工作簿和用户
看所有工作簿或更改
元数据
权限等操作时，在极
少情况下，对于超大
型部署 存在数千位
用户 ，该进程可能
会成为瓶颈。
加载和呈现视
是
在从 Web 浏览器加载
图，计算和执行
视图和交互使用的过
- 25 -
进程
文件名
是否
为多
线
程？
用途
查询
性能特征
程中，占用明显的资
源。可能受限制于
CPU、I/O 或网络。进
程负载只能由浏览器
的交互创建。进程内
存可能不足。
关于服务器进程限制
wgserver、数据引擎、数据服务器和 VizQL 服务器进程设计为多线程和多进程。单个
进程实例可以运行 16 个以上的线程。默认情况下，Tableau Server 安装时，每个服务
器进程最多两个实例。
如果运行 64 位版本的 Tableau Server
进程的两个实例。
从 8.1 版开始提供
，则最多应该运行一个
如果运行 32 位版本的 Tableau Server 并且默认设置不够，则可以在安装过程中 仅
限升级 或安装后使用“配置”对话框更改为最多 8 个实例。每个进程 8 个实例是默认
上限。如果您的计算机有足够的 RAM 和 CPU 内核，则可以使用 service.max_
procs tabadmin 设置来更改上限。对于每个进程实例，Tableau 建议运行进程的计算
机至少具有 1 GB RAM 和 1 个逻辑 CPU 内核。
更改允许的最大进程数：
1. 安装后，停止服务器。
2. 还是在 Tableau Server 的 bin 目录中，输入以下命令，其中 number 是要允许的
进程实例的最大数目：
tabadmin set service.max_procs number
例如：
tabadmin set service.max_procs 10
3. 启动服务器以使更改生效。
- 26 -
升级到8.2
请参考以下主题将 Tableau Server 软件升级到版本 8.2。如果要从 8.1 以前的版本进行
升级，请参见 Tableau 知识库。
升级前检查表
下面是在将 Tableau Server 升级到版本 8.2.x 之前应该找到的各个项以及应该执行的步
骤。
凭据、安装文件和自定义项
在升级前，请确保您有以下几项：
l
l
l
用户帐户凭据：对于要升级的每台计算机，您都需要拥有本地管理员权限的用
户帐户的凭据。
以帐户凭据身份运行：确认您拥有 Tableau Server 的 运行身份帐户的用户名和
密码。如果您在使用 NT AUTHORITY\NetworkService 默认设置 ，则无需密
码。
安装文件：除了有要执行的升级所需的 .exe 文件外，还应找到或重新下载生产
环境中当前所用服务器版本的安装 .exe 文件 请参见下载 Tableau 产品 。如
果在升级过程中发生意外情况，这可帮助您更快恢复。
当 Tableau 在升级过程中保留配置设置时，最佳做法是记录您所做的所有自定义操
作，以便以后进行验证。这些操作包括配置 SSL、更改 Tableau 的默认端口和超时值
以及使用自定义徽标。此外，如果您向 Windows PATH 环境变量中添加了当前
Tableau Server 版本，升级后还需要更新该条目，以便它引用较新版本的 Tableau
Server。
位版本
从 8.1 版开始，Tableau Server 作为本机 64 位应用程序以及 32 位应用程序提供。早期
版本的 Tableau Server 仅作为 32 位应用程序提供。
如果您以前在 64 位操作系统上运行 32 位版本的 Tableau Server，建议您升级到 64 位
版本的 Tableau Server。有关最低要求，请参见安装之前... 在本页 3。
如果您要升级 Tableau Server 的分布式安装，则整个群集必须运行同一位版本 — 全都
运行 32 位或全都运行 64 位 Tableau Server 软件。当从 32 位版本的 Tableau Server 升
级到 64 位版本时，您必须首先在每台工作计算机上卸载 32 位版本才能安装 64 位版
本的工作软件。有关详细信息，请参见将 Tableau Server 的分布式安装从 32 位升级
到 64 位 在本页 31。
检查产品维护状态
如果尝试从维护已过期的 Tableau Server 进行升级，您会得到一个未许可的 Tableau
Server 实例。
- 27 -
查看您服务器的维护是否已过期：
l
选择“开始”>“所有程序”>“Tableau Server”>“管理产品密钥”，并在“维护过期”
列下查看。
如果您的维护已过期，请选择密钥并单击“刷新”。如果维护日期未更新，请联系
Tableau 客户支持。安装过程中将重新激活产品密钥。有关详细信息，请参见激活
Tableau 在本页 5。如果服务器无法访问 Internet，请参见脱机激活 Tableau 在本页
6。
创 建 “清 洁 ”备 份
除了定期 Tableau Server 备份之外，最好在升级前也创建一个备份。在创建备份之
前，应运行 tabadmin cleanup 命令从备份中移除不重要的文件。有关步骤，请参见运
行清理和备份 Tableau 数据 在本页 331。
仅限分布式安装：是否在创建备份之前删除工作服务器
Tableau 备份文件 (.tsbak) 包含配置信息以及数据。因此，Tableau Server 分布式安装
的备份将包含有关工作服务器的配置信息 包括其 IP 地址 。如果您不希望在备份
中包含此信息 例如，因为您要在升级过程中将工作计算机迁移到新硬件 ，则可
执行以下两项操作之一：
l
l
在创建备份之前从 Tableau Server 配置中删除工作计算机。
计划在将备份文件还原到新安装时使用 --no-config 选项。请注意，使用此
选项时，不会还原任何配置信息，包括主 Tableau Server 的配置信息。
如果正在运行 Tableau Server 的分布式安装，并且具有运行 Windows XP 或 Windows
Server 2003 SP1 或更高版本的工作计算机，则必须在升级之前将该工作计算机从配
置中删除。8.2 版不支持这些操作系统平台。请注意，Windows Server 2003 R2 SP2 或
更高版本 受 支持。
从 Tableau Server 配置中删除工作计算机：
1. 在主 Tableau Server 上停止服务器。
2. 在主服务器上，在“开始”菜单中依次选择 Tableau Server <version> > 配置
Tableau Server。
- 28 -
3. 在“配置”对话框中，选择“服务器”选项卡。
4. 如果工作服务器正在承载数据提取和/或存储库，请将这些服务移到其他计算机
上。有关步骤，请参见移动数据引擎进程和存储库进程 在本页 31。
5. 接下来，突出显示工作服务器，然后单击“删除”。
6. 单击“确定”。
7. 启动服务器。
运行清理
运行 tabadmin cleanup 命令可从 Tableau Server 系统中移除备份文件中不需要的文件。
应在服务器运行时运行一次清理，以便对 Tableau 数据库执行清理；还应在服务器停
止后运行一次清理，以便删除日志文件。
运行 tabadmin cleanup：
1. 以管理员身份打开命令提示符：
2. 导航到 Tableau Server 的 bin 目录。例如：
cd “C:\Program Files (x86)\Tableau\Tableau Server\8.1\bin”
3. 确认服务器正在运行：
tabadmin status
- 29 -
4. 通过键入以下命令运行清理：
tabadmin cleanup
5. 停止服务器：
tabadmin stop
6. 再次运行清理：
tabadmin cleanup
不启动服务器以便创建备份
下一步
。
创建备份文件
tabadmin backup 命令可创建包含存储库、数据提取和服务器配置中的数据的 .tsbak 文
件。创建该文件后，将其存储于其他计算机上。有关步骤，请参见备份 Tableau 数
据 在本页 331。请注意，如果您使用 Tableau Server 8.0 版或更早版本创建备份，则必
须在创建备份之前停止服务器。从 8.1 版开始，您不用先停止服务器即可创建备份。
仅限分布式安装 ：如果您在创建备份之前从服务器配置中删除了工作计算机，
并且不会在升级过程中迁移至新硬件，则现在可以将这些工作计算机重新添加
到配置中。请按升级到8.2 向下中的步骤操作。否则，如果要在升级过程中迁
移至新硬件，则不要在配置中重新添加工作计算机。有关详细信息，请参见迁
移到新硬件 在本页 33。
升 级 到 8.2
完成升级前检查表 在本页 27之后，请按以下过程之一操作将现有 Tableau Server 安装
升级到 8.2 版。如果要在升级过程中迁移到新硬件，请参见迁移到新硬件 在本页 33
而非以下过程。
安装较新版本的 Tableau Server 时，使用早期版本所用的同一驱动器和目录。这样，
可以自动导入早期版本中的数据和配置设置。
如果您是从 32 位 Tableau Server 升级到 64 位 Tableau Server，则必须卸载现有版本才
能安装新版本。
单服务器安装
将 Tableau Server 的单服务器安装升级到 8.2 或 8.2.x 版：
1. 使用 Tableau Server 上的“添加/删除程序”卸载早期版本。
卸载时将删除服务器软件，但数据和配置设置将保留不动。
2. 安装 Tableau Server。Tableau Server 安装程序将从之前的版本导入数据和配置
设置。
- 30 -
分布式安装
如果您要在升级到 8.1 版的过程中将群集移至 64 位版本的 Tableau Server，请查看升
级前检查表 在本页 27中有关“位版本”的指南。
将 Tableau Server 的分布式安装从 8.1 版升级到 8.2 版或 8.2.x：
1. 使用主 Tableau Server 上的“添加/删除程序”卸载早期版本。
2. 使用工作服务器上的“添加/删除程序”卸载早期版本。
卸载时将删除服务器软件，但数据和配置设置将保留不动。
3. 在工作服务器上安装 Tableau 工作服务器。
4. 在主 Tableau Server 上安装 Tableau Server。
Tableau Server 安装程序将从之前的版本导入数据和配置设置。
将 Tableau Server 的分布式安装从 8.2.x 版升级到 8.2.x 版 ：
1. 使用主 Tableau Server 上的“添加/删除程序”卸载早期版本。
卸载时将删除服务器软件，但数据和配置设置将保留不动。
2. 在主 Tableau Server 上安装 Tableau Server。因为这是“相同版本”升级 8.2.x 版
到 8.2.x ，所以无需在 Tableau 工作计算机上卸载然后重新安装服务器软件。
主 Tableau Server 会将更新推送到工作服务器。
注意： 如果您是从 32 位 Tableau Server 升级到 64 位，则无需卸载并重新
安装。请参见下面的“将 Tableau Server 的分布式安装从 32 位升级到 64
位”。
Tableau Server 安装程序将从之前的版本导入数据和配置设置。
将 Tableau Server 的分布式安装从 32 位升级到 64 位
如果您要将分布式安装从 32 位升级到 64 位，则需要执行以下步骤：
1. 使用主 Tableau Server 上的“添加/删除程序”从主服务器卸载 32 位版本。
2. 使用 Tableau Server 上的“添加/删除程序”卸载 32 位版本。
3. 在每台工作计算机上安装 64 位 Tableau Server。
4. 在主 Tableau Server 上安装 64 位 Tableau Server。
移动数据引擎进程和存储库进程
如果您需要从 Tableau Server 配置中删除某一工作服务器，而该工作服务器承载了存
储库或数据引擎 承载数据提取 的唯一实例，则您必须先将该进程移到其他计算
机上。这是因为必须始终有一个活动的存储库和数据引擎进程实例。
要移动数据引擎或存储库进程，请执行以下操作：
- 31 -
1. 如果您尚未停止主 Tableau Server，请先停止它，然后在主 Tableau Server 上打
开“Tableau Server 配置”对话框 “开始”>“Tableau Server 8.2”>“配置 Tableau
Server” 。
2. 在“服务器”选项卡上，突出显示要将进程移到其上的计算机的 IP 地址或计算机
名称。该计算机可以是其他工作服务器，也可以是主服务器 (This Computer
(Primary))。
3. 单击“编辑”。
4. 在“编辑 Tableau Server”对话框中，选中要移动的进程所对应的复选框：数据引
擎、存储库或同时选中，然后单击“确定”。
5. 在“Tableau Server 配置”对话框中单击“确定”。
6. 启动主 Tableau Server 以使更改生效。
7. 停止该服务器并打开“Tableau Server 配置”对话框。
8. 在“服务器”选项卡上，突出显示要从中删除进程的工作服务器的 IP 地址或计算
机名称，然后单击“编辑”。
9. 清除已移动的进程所对应的复选框，然后单击“确定”。
10. 再次单击“确定”并启动主服务器以使更改生效。
如果您在从 Tableau Server 配置中删除某个工作服务器期间执行此过程
查表 在本页 27中所述 ，请重新停止该服务器，然后继续。
如升级前检
关于服务器进程限制
wgserver、数据引擎、数据服务器和 VizQL 服务器进程设计为多线程和多进程。单个
进程实例可以运行 16 个以上的线程。默认情况下，Tableau Server 安装时，每个服务
器进程最多两个实例。
如果运行 64 位版本的 Tableau Server
进程的两个实例。
从 8.1 版开始提供
，则最多应该运行一个
如果运行 32 位版本的 Tableau Server 并且默认设置不够，则可以在安装过程中 仅
限升级 或安装后使用“配置”对话框更改为最多 8 个实例。每个进程 8 个实例是默认
上限。如果您的计算机有足够的 RAM 和 CPU 内核，则可以使用 service.max_
procs tabadmin 设置来更改上限。对于每个进程实例，Tableau 建议运行进程的计算
机至少具有 1 GB RAM 和 1 个逻辑 CPU 内核。
更改允许的最大进程数：
1. 安装后，停止服务器。
2. 还是在 Tableau Server 的 bin 目录中，输入以下命令，其中 number 是要允许的
进程实例的最大数目：
tabadmin set service.max_procs number
例如：
- 32 -
tabadmin set service.max_procs 10
3. 启动服务器以使更改生效。
迁移到新硬件
使用以下过程将 Tableau Server 从一台计算机迁移到另一台计算机。这些步骤具体描
述了如何将 Tableau Server 数据和配置设置从生产计算机移动到安装了 Tableau Server
版本 8.2 的新计算机。在开始之前，请确保已执行了升级前检查表 在本页 27中的步
骤，包括创建 .tsbak 文件。
1. 在新计算机上安装 Tableau Server。
2. 将 .tsbak 文件复制到新 Tableau Server 上的 bin 文件夹
Files\Tableau\Tableau Server\8.2\bin 。
例如 C:\Program
3. 然后，停止 Tableau Server。
4. 键入 tabadmin restore <filename> 其中 <filename> 是 .tsbak 文件的名
称 ，将生产数据和配置信息还原到新安装的 Tableau Server。例如：
tabadmin restore mybackup.tsbak
或者，若要仅还原生产 Tableau Server 的数据而不还原配置信息，请键入以下
命令：
tabadmin restore --no-config mybackup.tsbak
5. 启动服务器。
6. 仅限分布式安装：在要添加到 Tableau Server 集群的其他所有计算机上运行
Tableau 工作软件安装程序。有关步骤，请参见安装和配置工作服务器 在本页
36。
7. 同一 Tableau Server 产品密钥可激活三次：一次针对生产环境，一次针对测试
环境，一次针对 QA 环境。在您测试了新 Tableau Server 安装并确认它可用于生
产后，必须先停用然后卸载 Tableau Server 的早期生产版本。停用早期版本：
- 依次选择开始 > 所有程序 > Tableau Server > 管理产品密钥。
- 选中所有产品密钥，然后单击停用。
如果您未连接到 Internet，系统将提示您创建离线激活文件以完成停用过
程。有关步骤，请参见脱机激活 Tableau 在本页 6。
- 33 -
分布式环境
使用下面的主题可了解有关运行 Tableau Server 分布式安装的更多信息：
分布式要求
在开始配置 Tableau Server 群集之前，请确保满足以下要求。
硬件
虽然您在群集中使用的计算机必须满足安装之前... 在本页 3中所述的要求，但它们不
需要完全相同。
实现高可用性的硬件指南
下面是一些针对您用于实现故障转移和高可用性的系统的指南：
l
l
l
l
故障转移 - 两台或三台计算机： 要配置一个群集来为数据引擎和存储库进程提
供故障转移支持，您至少需要两台计算机或虚拟机：一台用作主 Tableau
Server，一台用作 Tableau 工作服务器。在这种配置中，可能还需要一个未运行
Tableau 的网站或计算机 了解更多信息 。建议的故障转移配置需要三台计
算机或虚拟机：一台用作主 Tableau Server，两台用作工作服务器。
故障转移和多网关支持 - 两台或三台计算机和一个负载平衡器：要配置提供上
述功能并支持多个网关的群集，您至少需要两台计算机或虚拟机和一个位于群
集前端的负载平衡器。建议的支持多个网关的故障转移配置是三台计算机或虚
拟机和一个负载平衡器。
高可用性 - 四台计算机和一个负载平衡器：要配置高可用性，您不仅需要上面
描述的资源，而且还需要一台计算机作为主 Tableau Server 的备份。
主计算机： 如果您配置高可用性，则主 Tableau Server 计算机和备份主计算机
可以运行很少的 Tableau Server 进程，或不运行任何 Tableau Server 进程。因
此，运行主计算机和备份主计算机的计算机无需具有与运行工作服务器的计算
机一样多的内核。不过，将需要足够的磁盘空间进行备份，因为在数据库备份
和还原过程中将会使用主计算机。除了备份文件所需的空间量外，还需要大约
相当于备份文件大小 10 倍的临时磁盘空间 因此如果备份是 4 GB，则应有大
约 40 GB 的可用临时磁盘空间 。
软件
Tableau Server 提供 32 位和 64 位两种版本。如果您运行 Tableau Server 群集，则其中
的每台计算机必须运行相同位数的版本，要么全都是 64 位，要么全都是 32 位。例
如，如果主 Tableau Server 运行 64 位版本的 Tableau Server，则群集中的工作服务器
也必须运行 64 位版本的 Tableau Server 工作软件。 它们不能运行 32 位版本的 Tableau
Server 工作软件。
- 34 -
联网与端口
l
l
l
端口：与任何分布式系统一样，您所使用的计算机或虚拟机需要能够互相通
信。有关网关和工作服务器上必须具有的端口的列表，请参见TCP/IP 端口 在
本页 284。
相同域：群集中的所有计算机都必须是同一域的成员。在主 Tableau Server 上
指定的服务器的用户运行身份 在本页 270帐户也必须是同一域中的域帐户。
静态 IP 地址：运行 Tableau Server 的任何计算机，无论它是单服务器安装还是
群集的一部分，都必须具有静态 IP 地址 了解更多信息 。
最佳做法
下面是开始安装和配置之前需要注意的问题：
l
l
l
l
IP 地址或计算机名称： 记下将要使用的各计算机或虚拟机的 IPv4 地址或计算
机名称。在 Tableau 工作服务器安装和配置期间，需要提供这些信息。如上所
述，群集中的每台计算机必须都使用静态 IP 地址，即使在配置过程中使用计算
机名称进行标识也是如此。
CNAME 记录：如果您配置高可用性并且未使用负载平衡器，则应确保主
Tableau Server 服务器和备份主计算机具有相同的 CNAME 记录，以便在一个主
服务器出现故障并且您已配置由另一个服务器进行接替时，Tableau Server 用户
能够平稳过渡。如果使用负载平衡器，用户将使用负载平衡器的名称作为
Tableau Server URL，与实际处理该请求的网关无关。
用户帐户凭据：对于每台计算机，都需要拥有本地管理员权限的用户帐户的凭
据。如果您配置高可用性，则用于主 Tableau Server 的“运行身份”帐户必须与用
于备份主 Tableau Server 的“运行身份”帐户相同。
备份：最好在进行重要的系统更改之前创建备份。有关步骤，请参见备份
Tableau 数据 在本页 331。
SSL
如果您计划为使用多个网关和一个负载平衡器的高度可用的 Tableau Server 群集配置
SSL， 了解更多信息 ，请确保为负载平衡器的主机名称颁发您使用的 SSL 证书。
有关其他详细信息，请参见 为群集配置 SSL 在本页 16。
Tableau Server 中 的 主 机 名 支 持
从 8.1 版开始，向 Tableau Server 中添加了主机名支持。 这意味着，当您配置 Tableau
Server 以便与其他计算机一起使用时，您可以使用该计算机的名称来标识它，而不是
使用其静态 IPv4 地址。但是，在内部，Tableau Server 仍然依赖 IP 地址与各种服务
例如 Tableau 工作计算机或受信任主机 通信。因此，即使您提供了计算机的名称
而非其 IP 地址，与该计算机关联的 IP 地址也无法更改或者可能只是暂时的。
- 35 -
如果运行 Tableau Server 的计算机获得新 IP 地址，例如在虚拟机重新启动后或者在使
用 DHCP 的网络环境中，那么您将需要运行 tabadmin config 使用该更改更新
Tableau Server 的配置。有关步骤，请参见下面的过程。
除 DHCP 外，另一个可能导致 IP 地址在设置后发生变化的项目是 Windows 操作系统
的 IPv6 地址功能，称为“临时 IPv6 地址”。请参见知识库，了解有关如何识别和禁用
此功能的详细信息。
更 新 Tableau Server 配 置 ：
1. 在主 Tableau Server 上，以管理员身份打开命令提示符。
2. 键入以下命令：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
3. 停止服务器：
tabadmin stop
4. 通过键入以下命令更新服务器的配置：
tabadmin config
5. 启动服务器：
tabadmin start
安装和配置工作服务器
完成初始配置后，可以将 Tableau Server 设置为在多台计算机上运行。这称为分布式
安装，或群集。运行分布式安装时将使用主 Tableau Server 上的附加端口，且要求在
安装过程中 Tableau 工作服务器上的某些端口可用于绑定。有关更多信息，请参见
TCP/IP 端口 在本页 284。当您运行分布式安装时还要注意一些其他要求。有关详细
信息，请参见分布式要求 在本页 34。
安装和配置 Tableau 工作服务器：
1. 确保已在主计算机上安装 Tableau Server。
2. 停止主计算机上的服务器
在本页 128 。
若要了解如何操作，请参见 Tableau Server Monitor
3. 在 Tableau 客户帐户中心下载 Tableau Server 工作软件。
4. 在要添加到 Tableau Server 集群的所有其他计算机上运行 Tableau Server 工作软
件安装程序。
5. 安装过程中，您需要提供主服务器的 IPv4 地址或计算机名称。建议使用计算机
名称。
- 36 -
如果主计算机启用了多个网络接口卡 (NIC)，并且您选择输入 IPv4 地址，请输
入主计算机的所有 IPv4 地址，并用逗号将每个地址分隔开。运行主计算机的计
算机的 IP 地址必须是静态的，即使您使用计算机名称来标识主计算机，也是如
此 了解更多信息 。
如果您有一个运行 Windows 7 的工作服务器，且启用了 Windows 防火墙，请先
参见 Tableau 知识库，然后再继续。
6. 如果在工作计算机上安装了工作软件，并且主 Tableau Server 仍然停止，请返
回主服务器，然后通过在“开始”菜单上选择“Tableau Server 8.2”>“配置 Tableau
Server”打开配置实用工具。
7. 在“配置实用工具”中，在“常规”选项卡上输入您的密码，选择“服务器”选项卡，
然后单击“添加”。
8. 在下一个对话框中，键入其中一台工作计算机的 IPv4 地址或计算机名称，然后
指定要分配给该计算机的“VizQL”、“应用程序服务器”、“Data Server”、“后台”
和“数据引擎”进程的数目。
使用 Tableau Worker Server 的 64 位版本，您最多可以运行每个进程的两个实
例。在极少数情况下，如果服务器的硬件允许，则可以更改此限制。有关更多
信息，请参见关于服务器进程限制 在本页 32和性能 在本页 207。
- 37 -
默认情况下，数据引擎、存储库和网关位于主服务器上。在另外一台服务器上
运行这些进程或者将这些进程移出主服务器是配置高可用性的一部分。有关更
多信息，请参见高可用性 下一页。
9. 单击“确定”。可能需要等几分钟时间才能完成此更新。
10. 针对要添加到分布式环境中的每台计算机，重复这些步骤。添加完工作计算机
后，再次单击“确定”以保存更改，然后启动主 Tableau Server。
数据库驱动程序
Tableau Server 和 Tableau Server Workers 的安装程序会自动安装 Oracle 和 Oracle
Essbase 数据库的驱动程序。如果您计划发布与其他数据库连接的工作簿和数据源，
则需要确保您的主服务器和工作服务器上有相应驱动程序。
运行 VizQL 的工作计算机、应用程序服务器、数据服务器或后台程序进程需要这些数
据库驱动程序。例如，如果您有一台专门用作 VizQL 服务器的工作计算机和另一台专
用于数据提取存储的计算机，则只需在 VizQL 服务器进程的计算机上安装驱动程序。
服务器进程
VizQL
应用程序服务器
数据服务器
后台
数据引擎 提取存储
存储库
网关
是否需要数据库
驱动程序？
是
是
是
是
否
否
否
- 38 -
维护分布式环境
在设置用于分布式安装的主服务器以及一台或多台工作服务器后，您可以使用主服
务器上的命令行工具和配置实用工具，从主服务器执行所有随后的配置和更新。更
新将被自动推送到工作计算机上。
安装工作服务器时，指定了主服务器的 IPv4 地址或计算机名称。如果该 IP 地址或计
算机名称发生更改，您需要重新安装工作服务器。
您可以在服务器的“维护”页面上监视 Tableau Server 集群的状态。若要了解关于维护
服务器的更多信息，请参见服务器维护 在本页 120。
高可用性
使用下面的链接可了解有关 Tableau Server 高可用性支持的更多信息：
了解高可用性
配置高可用性 Tableau Server 系统所执行的步骤就是构建冗余配置，这样就可以缩短
潜在停机时间。需要冗余的四个方面是数据引擎进程、存储库进程、网关进程和主
Tableau Server 运行服务器的许可组件 。由于数据引擎和存储库进程必须始终有
一个活动实例，因此配置群集是一个多阶段过程，需要将主 Tableau Server 停止并在
特定的点重新启动以使设置生效。有关具体步骤，请参见 配置故障转移和多个网关
在本页 44 和 配置备份主计算机 在本页 52。另请参见distrib_requ.htm。
下面的主题总结了服务器系统拓扑结构在您配置高可用性时的变化。高可用性的最
低建议配置是一个三节点系统。这包括一台运行许可组件的主服务器和两台承载主
要进程的工作服务器。您可以通过添加第四台计算机作为备份主计算机来提高系统
的可靠性。如果在所有节点上运行网关进程，还应该对网关使用负载平衡器。
单服务器系统
安装主 Tableau Server 后，它至少运行所有服务器进程的一个实例。这是最基本的
Tableau Server 配置。该配置没有冗余。
- 39 -
单服务器系统的“维护”页面上的“状态”表通常与下面的表相似：
若要构建冗余，您需要添加另外的服务器以承载活动和备用数据引擎及存储库进
程。此外，为了减少系统漏洞，可以运行多个网关，主网关应隔离在其自身节点
上，理想情况是运行尽可能少的服务器进程。实现此目的至少需要三台计算机 请
参见三节点系统 下一页 ；不过，您可以使用两台计算机实现某种程度的冗余。
两节点系统
如果您具有硬件限制，无法实现三节点群集，则可以使用 Tableau Server 群集外部的
两台计算机和一台主机获得某种程度的冗余。
- 40 -
在上面的系统中，主 Tableau Server 和工作服务器同时运行数据引擎和存储库的活动
和备用实例以及网关。Tableau Server 群集外部的第三台计算机将用作两个网关的第
三个接触点。下面是原因：当运行数据引擎或存储库的 Tableau 服务器与其他节点的
连接断开时，它将检查其外部的网关进程 但仍然是在 Tableau Server 群集内部 ，
以确定哪个节点发生故障，以及任何备用进程现在是否需要变为活动状态。在两节
点群集中，如果连接中断，将无法访问另一个 Tableau 网关进程。在这种情况下，可
以使用 Tableau Server 群集外部的网站或计算机。有关配置方法，请参见外部确认故
障转移 在本页 49。
下面是以上配置对应的“状态”表。由于第三台计算机不是 Tableau 服务器，因此未在
表中列出。
三节点系统
虽然上面描述的两节点系统可对数据引擎和存储库进程提供某种程度的故障转移支
持，但三节点系统将帮助您减少主计算机的漏洞：
- 41 -
“维护”页面上的“状态”表应与下面的表类似：
在三节点群集中，数据引擎和存储库进程已从主服务器移至工作服务器，并且主服
务器仅运行网关进程。由于搜索和许可功能是主服务器不可分割的一部分并且无法
删除，因此它们不会显示在状态表中。在此配置中，如果活动工作服务器出现故
障，备用工作服务器会自动成为活动服务器。有关创建这种三节点群集，包括添加
工作服务器和从主服务器删除进程的具体步骤，请参见配置故障转移和多个网关 在
本页 44。
您还可以做两件事来改善这种三节点群集：1) 添加一个负载平衡器与三个活动网关
交互，以及 2) 创建一个备份服务器以解决单点故障：主服务器。有关详细信息，请
参见以下主题。
- 42 -
添加负载平衡器
此时，全部三个节点都具有网关，这些网关用于将请求路由到可用的服务器进程。
与存储库进程不同，不存在非活动和备用网关。所有网关都处于活动状态。为了进
一步降低群集出现中断的可能性，您应该配置一个负载平衡器。
添加备份主计算机
添加备份主计算机可为系统提供一种安全保护。备份主计算机是添加到系统中的一
个附加服务器，可在主计算机出现故障时随时接替工作。该服务器不是活动服务
器，但在您完成 配置备份主计算机 在本页 52 中的第一组步骤后，可以随时将其激
活。虽然备份主计算机需要在安装期间得到许可，但它并不算作 Tableau EULA 下允
许的三种环境之一。
带有备份主计算机的系统与下面类似：
以上配置的“状态”表与三节点系统的“状态”表看上去相同。如果主计算机出现故障，
并且您执行备份主计算机的接替步骤，则系统就会使用新的主计算机继续运行：
- 43 -
主 Tableau Server 是唯一一个可以管理许可的位置。每 8 小时检查一次许可。如果主
计算机仅运行许可组件，根据许可检查上次发生的时间，您最多有 8 个小时让备份主
计算机联机。在此时间段内，群集将继续运行。例如，如果许可检查发生在 7 小时
50 分钟之前，则您有 10 分钟时间。如果许可检查发生在 1 分钟之前，则您有 7 小时
59 分钟时间。
配置故障转移和多个网关
执行以下步骤可配置一个提供多个网关和故障转移支持的三计算机群集。请注意，
仅当您还计划使用负载平衡器时，运行多个网关才有意义。
1. 在主计算机上安装 Tableau Server。
2. 安装完成后，检查“维护”页面上的“状态”表。所有进程都应处于绿色的“等待请
求”状态：
3. 在主计算机上停止服务器。
4. 接下来，在将会提供故障转移和额外网关支持的另外两台计算机或虚拟机上运
行 Tableau 工作软件安装程序。在工作软件安装过程中，您需要提供主 Tableau
Server 的计算机名称 推荐 或 IPv4 地址。如果输入多个 IPv4 地址，请用逗号
将每个地址分隔开。
即使您使用主计算机的计算机名称标识它，也必须为主计算机分配一个
静态 IP 地址 了解更多信息 。
- 44 -
5. 在主服务器仍停止的情况下，打开其“配置”对话框：“开始”>“所有程
序”>“Tableau Server”>“配置 Tableau Server”。 在“常规”选项卡上，键入“运行
身份”帐户密码。
6. 在“服务器”选项卡上，单击添加以添加工作服务器。
7. 输入工作服务器的 IPv4 地址或计算机名称，为“数据引擎”输入 1，然后选中“存
储库”复选框。现在，请将“网关”复选框保持清除状态。稍后您将向此工作计算
机添加一个网关。
如果希望此工作服务器运行其他服务器进程，则输入要运行的实例数，如 1 或
2。
8. 单击“确定”关闭“添加 Tableau Server”对话框，然后再次单击“服务器”选项卡上的
“添加”以添加另一台工作服务器。
9. 输入第二台工作服务器的 IPv4 地址或计算机名称，为每个进程至少输入 1，但
“数据引擎”进程除外 将该进程设置为 0 。 清除“存储库”复选框并选择“网
关”。
- 45 -
无需为数据引擎和存储库指定哪些工作服务器分别处于活动和备用状态。
10. 在主计算机上启动服务器。
11. 重要信息：留几分钟时间，以便服务器的同步进程复制数据。这可能需要 5 分
钟到 15 分钟 甚至更长 时间，具体取决于您的安装的大小和数据提取的数
量。
12. 通过比较主服务器和第一台工作服务器上的以下文件夹来确认同步已完成：
l
数据引擎文件夹：ProgramData\Tableau\Tableau
Server\data\tabsvc\dataengine
主服务器和第一台工作服务器上此文件夹的内容和大小应该相同。
l
存储库文件夹：pProgramData\Tableau\Tableau
Server\data\tabsvc\gsql
主服务器和第一台工作服务器上此文件夹的大小应该相同，或者几乎相
同。
在下一步中停止服务器之前不确认上述内容可能会导致数据丢失。
13. 在确认同步已完成后，在主服务器上停止服务器。
14. 再次打开“配置”对话框，然后在“服务器”选项卡上，突出显示“此计算机(主)”，
然后单击“编辑”。
- 46 -
15. 在“编辑 Tableau Serve”对话框中，将数据引擎设置为 0 并取消选中存储库复选
框。保持“网关”处于选中状态。如果希望主 Tableau Server 只运行 Apache 即
不运行任何 Tableau Server 进程 ，则可通过在各文本框中输入 0 从中移除剩
余进程：
单击“确定”。
16. 在“服务器”选项卡上，选择第一台工作服务器，单击“编辑”，并选中“网关”复选
框。将其他设置保持原样。单击“确定”。
17. 仍然在“服务器”选项卡上，选择第二台工作服务器，然后单击“编辑”。
18. 将“数据引擎”设置为 1，并选中“存储库”复选框。
- 47 -
19. 单击“确定”。
“服务器”选项卡现在应与下图类似：
20. 您还可以设置电子邮件通知，以便在服务器出现故障或者数据引擎和存储库进
程的状态发生变化时收到通知。为此，请在“配置”对话框中单击“通知和订阅”选
项卡，然后按配置电子邮件通知 在本页 12中的步骤操作。
21. 单击“确定”关闭“配置”对话框。
22. 在主计算机上启动服务器 可能需要几分钟时间更改才会生效 。您的系统现
在已配置为针对数据引擎和存储库进程提供故障转移支持。还可以配置多个网
关。现在您可以使用负载平衡器，以确保在网关出现故障时群集的可用性，以
及分摊群集的工作负载。
“维护”页面上的“状态”表应与下面的表类似：
- 48 -
浅绿色的选中标记表示某一进程为备用进程，可在活动进程
记 出现故障时接替工作。
深绿色选中标
外部确认故障转移
添加另一台运行数据引擎或存储库的服务器后，可以使用“服务器”选项卡上的“使用
外部主机确认故障转移”复选框。该选项允许您列出 Tableau Server 群集外部将用于
在出现故障转移时检查群集连接状态的一个或多个计算机或网站。
使用外部主机或网站确认故障转移在如下所示的两节点 Tableau Server 系统中最为有
用：
- 49 -
在上面的系统中，主 Tableau Server 和工作服务器同时运行数据引擎和存储库的活动
和备用实例以及网关。Tableau Server 群集外部的这第三台计算机将用作两个网关的
第三个联系点。下面是原因：当运行数据引擎或存储库的 Tableau 服务器与其他节点
的连接断开时，它将检查其外部的网关进程 但仍然是在 Tableau Server 群集内
部 ，以确定哪个节点发生故障，以及任何备用进程现在是否需要变为活动状态。
在两节点群集中，如果连接中断，将无法访问另一个 Tableau 网关进程。在这种情况
下，可以使用未运行 Tableau 的计算机来建立简单的 TCP 连接。如果上图中的工作服
务器无法连接主服务器但仍然能够连接到外部主机，将会触发它开始运行数据引擎
和存储库的活动实例。
如果无法访问外部主机或网站，则活动或备用数据引擎都不会启动，并且承载数据
引擎的服务器上的 tabspawnpg.log 文件中 在 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\pgsql 下 将出现一条类似下面内容的消息：
2013-11-04 14:42:23.934 -0800 ERROR root: Not "Primary": No
quorum. Cannot reach external failover confirmation host on
myco.example.lan:80 from 10.98.7.65
2013-11-04 14:42:23.945 -0800 ERROR root: Not "Secondary": No
quorum. Cannot reach external failover confirmation host on
myco.example.lan:80 from 10.98.7.65
- 50 -
添加负载平衡器
可以通过运行多个网关并配置负载平衡器在网关之间分配请求，来提高 Tableau
Server 群集的可靠性。与可以处于活动或备用状态的存储库进程不同，所有网关进程
都必须处于活动状态。如果群集中的一个网关变得不可用，负载平衡器将停止向其
发送请求。您选择的负载平衡器算法决定网关路由客户端请求的方式。
如果您还计划创建备份主计算机并且该计算机将运行网关进程，请确保向负载平衡
器标识该网关以及所有其他网关。
指南
在配置您的负载平衡器以便与 Tableau Server 一起使用时，请注意以下事项：
l
l
l
l
l
已测试负载平衡器：具有多个网关的 Tableau Server 群集已使用 Apache 和 F5 负
载平衡器进行了测试。
Tableau Server URL：当负载平衡器位于 Tableau Server 群集前端时，Tableau
Server 用户所访问的 URL 将属于负载平衡器而不是主 Tableau Server。
X-Forwarded-For 和 X-Forwarded-Host 标头：Tableau Server 用户活动管理视
图显示客户端 IP 地址及其他信息。要让此视图显示客户端的 IP 地址而不是群
集的负载平衡器，可能需要在负载平衡器上显式启用 X-Forwarded-For 和 XForwarded-Host 标头 有些负载平衡器默认会将其启用，有些则不会 。
受信任主机设置：必须将运行负载平衡器的计算机作为受信任主机向 Tableau
Server 标识。请参见下面的过程了解如何配置 Tableau Server。
代理服务器配置：用于将负载平衡器标识给 Tableau Server 的设置与用于标识
代理服务器的设置相同。如果您的 Tableau Server 群集同时需要代理服务器和
负载平衡器，则必须由同一进程在同一计算机上进行处理。
配置 Tableau Server 以使用负载平衡器
您可以通过执行下列步骤配置 Tableau Server 以使用负载平衡器。
1. 停止服务器。
2. 在 Tableau Server bin 目录中，输入以下命令，其中 name 是负载平衡器的规范
外部可见 名称：
tabadmin set gateway.public.host "name"
3. 默认情况下，Tableau 假定负载平衡器在端口 80 上侦听外部通信。要使用其他
端口，请输入以下命令，其中 port_number 是端口：
tabadmin set gateway.public.port "port_number"
4. 现在，输入以下命令，其中 server 是负载平衡器的 IPv4 地址或计算机名称：
tabadmin set gateway.trusted "server"
server 的值可以是逗号分隔的列表，例如：
- 51 -
tabadmin set gateway.trusted "123.45.67.890, 123.45.67.880,
123.45.67.870"
或
tabadmin set gateway.trusted "proxy1, proxy2, proxy3"
5. 在下一个命令中，您将为负载平衡器提供任何备用名称，例如它的完全限定域
名、任何非完全限定域名和任何别名。这些是用户可能在浏览器中键入的名
称。用逗号分隔每个名称：
tabadmin set gateway.trusted_hosts "name1, name2, name3"
例如：
tabadmin set gateway.trusted_hosts "lb.example.com, lb,
ftp.example.com, www.example.com"
6. 运行 config 命令：
tabadmin config
7. 启动服务器以使更改生效。
配置备份主计算机
按照此主题中的过程进行操作前，请先执行配置故障转移和多个网关 在本页 44中的
步骤。完成这些步骤后，您将拥有两个提供故障转移支持的工作服务器。每台服务
器还运行一个网关，可以为网关配置负载平衡器。主 Tableau Server 运行网关进程和
许可功能，该功能不会公开，也不能作为进程分配。现在您已对数据引擎、存储库
和网关实现了冗余，接下来需要为主 Tableau Server 构建冗余。通过创建备份可以实
现此目的。虽然备份主计算机需要在安装期间得到许可，但它并不算作 Tableau
EULA 下允许的三种环境之一。
请记住每 8 小时检查一次许可。如果主计算机仅运行许可组件，根据许可检查上次发
生的时间，您最多有 8 个小时让备份主计算机联机。在此时间段内，群集将继续运
行。例如，如果许可检查发生在 7 小时 50 分钟之前，则您有 10 分钟时间。如果许可
检查发生在 1 分钟之前，则您有 7 小时 59 分钟时间。若要了解上次检查许可的时
间，请查看 ProgramData\Tableau\Tableau Server\data\tabsvc\logs\licensing folder 中的
checklicense_lic.log 文件及其他日志文件。
下面的第一个过程介绍如何创建主计算机的备份。第二个过程演示当前主计算机出
现故障时应执行的操作。
创建备份主计算机
执行以下操作以创建备份主计算机：
1. 在主 Tableau Server 上停止服务器。
2. 在主计算机上，以管理员身份打开命令提示符，然后转到 Tableau Server 的 bin
目录：
- 52 -
C:\Program Files\Tableau\Tableau Server\8.2\bin
3. 版本 8.1.3 及更早版本：输入以下命令，其中 <primary1> 是当前主计算机的
IPv4 地址或计算机名称，<primary2> 是备份主计算机的 IPv4 地址或计算机名
称：
tabadmin failoverprimary --primary <primary1> --secondary
<primary2>
版本 8.1.4 及更高版本：输入以下命令，使用当前主计算机和备份主计算机的
计算机名称 推荐 或当前主计算机和备份主计算机的所有 IPv4 地址。如果输
入 IPv4 地址，请用逗号将每个地址分隔开。
tabadmin failoverprimary --primary "primary1_name,primary2_
name"
或
tabadmin failoverprimary --primary "primary1_IP,primary2_IP"
例如，如果当前主计算机的计算机名称为 TABLEAU_SERVER，备份主计算机的
计算机名称为 TABLEAU_SERVER2，则输入以下命令：
tabadmin failoverprimary --primary "TABLEAU_SERVER,TABLEAU_
SERVER2"
这里是一个使用 IPv4 地址的命令示例。此示例假定主计算机 (primary1_IP) 具
有单个 IPv4 地址 123.45.67.90，备份主计算机 (primary2_IP) 具有单个 IPv4
地址 123.45.67.89：
tabadmin failoverprimary --primary
"123.45.67.90,123.45.67.89"
如果主计算机和备份主计算机具有多个 IPv4 地址，则全部输入它们。例如：
tabadmin failoverprimary --primary
"123.45.67.90,123.45.67.91,123.45.67.89,123.45.67.88"
4. 接下来，创建该主计算机的 tabsvc.yml 文件 位于 ProgramData\Tableau\Tableau
Server\config 中 的副本，并将该副本放在备份主计算机上的一个临时位置。
tabsvc.yml 文件包含服务器配置设置。在“Tableau Server 配置”对话框中或通过
tabadmin 更改配置设置时会向该文件写入。如果 tabsvc.yml 发生改变，您需要
更新备份主计算机上 tabsvc.yml 的副本。
5. 在备份主计算机上，打开 tabsvc.yml 文件，并将主计算机 IP 地址或计算机名称
替换为备份主计算机 您当前所在的计算机 的 IP 地址或计算机名称。如果主
计算机仅运行网关，如此过程中所述，您需要编辑的唯一一行是
worker.hosts。如果主计算机还运行其他进程，请将任何位置显示的主计算
机的 IP 地址或名称替换为备份主计算机的 IP 地址或名称。
- 53 -
6. 在备份主计算机上安装 Tableau Server。使用在主计算机上运行 Tableau Server
安装程序时所使用的“运行身份”帐户和配置设置。
7. 安装完成后，在备份主计算机上停止服务器。
8. 还是在备份主计算机上，输入以下命令以禁用其 Tableau Server 服务：
sc config tabsvc start= disabled
- 54 -
此时即完成备份主计算机的创建。查看下一组步骤以了解当前主计算机出现故
障时应执行的操作。如果您在测试环境中工作，这会是关闭当前主计算机，模
拟系统故障以测试配置的好时机。
配置备份主计算机
当主计算机出现故障时，请按照这第二组步骤操作。所有步骤都应在备份主计算机
上执行。
1. 在备份主计算机上，使用在上一过程的步骤 5 中编辑的 tabsvc.yml 文件来覆盖
在 ProgramData\Tableau\Tableau Server\config 中本地安装的同名文件。
2. 以管理员身份打开命令提示符，然后转到 Tableau Server 的 bin 目录：
C:\Program Files\Tableau\Tableau Server\8.2\bin
3. 版本 8.1.3 及更早版本：输入以下命令，其中 primary2 是备份主计算机 很快
就会成为新的主计算机 的 IPv4 地址或计算机名称，primary1 是先前的主计
算机 很快将成为备份 的 IPv4 地址或计算机名称：
tabadmin failoverprimary --primary <primary2> --secondary
<primary1>
版本 8.1.4 及更高版本：输入以下命令，使用备份主计算机 很快就会成为新
的主计算机 的计算机名称或备份主计算机 很快就会成为新的主计算机 和
主计算机 很快就会成为备份主计算机 的 IPv4 地址。如果输入 IPv4 地址，请
用逗号将每个地址分隔开。
tabadmin failoverprimary --primary "primary2_name,primary1_
name"
或
tabadmin failoverprimary --primary "primary2_IP,primary1_IP"
例如，如果备份主计算机的计算机名称为 TABLEAU_SERVER2，先前的主计算
机的名称为 TABLEAU_SERVER，则输入以下命令：
tabadmin failoverprimary --primary "TABLEAU_SERVER2,TABLEAU_
SERVER"
这里是一个使用 IPv4 地址的示例。此示例假定备份主计算机 (primary2_IP) 具
有单个 IPv4 地址 123.45.67.89，先前的主计算机 (primary1_IP) 具有单个
IPv4 地址 123.45.67.90：
tabadmin failoverprimary --primary
"123.45.67.89,123.45.67.90"
如果备份主计算机和先前的主计算机具有多个 IPv4 地址，则全部输入它们。例
如：
- 55 -
tabadmin failoverprimary --primary
"123.45.67.89,123.45.67.88,123.45.67.90,123.45.67.91"
4. 输入以下命令：
sc config tabsvc start= auto
5. 启动服务器。备份主计算机现在已成为主计算机。在查看“维护”页面上的“状态”
表时，应该会注意到主计算机的 IP 地址或计算机名称已发生改变：
6. 若要使先前的主计算机现在充当备份主计算机，需要执行以下操作：
l
l
l
使用“添加/删除程序”从先前的主计算机删除 Tableau Server。在卸载程序
结束时，会收到一个备份错误，您可以将其忽略。
删除先前的主计算机上 Program Files (x86) 和 ProgramData 下的 Tableau 文
件夹。
重复此主题中“创建备份主计算机”下面从步骤 4 开始的步骤。
- 56 -
使用服务器
请参见以下主题以了解如何使用 Tableau Server 用户界面来管理安装：
用户与许可证
需要访问 Tableau Server 的任何人 无论是要进行发布、浏览还是管理
用户来添加。此外，还必须为用户分配许可级别。
都必须作为
用户
需要访问 Tableau Server 的任何人 无论是进行发布、浏览还是管理 都必须作为用
户添加。如果 Tableau Server 运行多个站点，则系统管理员可以在“所有用户”页面上
执行此操作。否则，如果 Tableau Server 以单站点模式运行，则系统和站点管理员可
以在“用户”页面上添加用户。
默认用户
Tableau Server 会自动创建 "Tableau Software"用户帐户并为其分配可用交互者许可证
之一。该帐户用于发布示例工作簿。默认情况下，该帐户没有密码并且无法用于登
录。
您可以更改该帐户的许可级别以使该许可证可用于另一用户 参见更改许可级别 在
本页 76 ，或者，如果服务器配置为使用内部用户管理系统 本地身份验证 ，则
您可以向该帐户添加密码以允许访问 参见编辑用户 在本页 69
在添加用户后，您可以编辑和删除它们，从站点中添加或移除它们，以及为其分配
许可级别和用户权限。有关更多信息，请参见以下主题。
添加用户
具有正确权限的系统管理员和站点管理员都可以从“用户”页面添加用户：
- 57 -
可通过两种方法从“用户”页面添加用户：交互方式 如下所述 或使用“导入”命令成
批添加，这依赖于 CSV 文件 如从 CSV 文件导入用户 在本页 62中所述 。
添加用户：
1. 在“用户”页面上，单击用户列表上面的“添加”链接：
2. 输入“用户名”。
l
l
本地身份验证：如果将服务器配置为进行本地身份验证，则使用电子邮
件地址作为“用户名”是避免用户名冲突的最佳方法 例如，使用
jsmith@myemail.com 而不是 jsmith 。输入“用户名”后，单击“添加用
户”。
Active Directory：如果要添加的用户所属的 Active Directory 域与运行服务
器的域相同，则可以键入不带域的“用户名”。此时将使用服务器所在的
域。
- 58 -
如果服务器所在的域和另一个域之间设置了双向信任，则可以从这两个
域添加用户。首次从“非服务器域”添加用户时，请对用户名使用完全限定
域名。可以使用该域的昵称添加后续用户。例如，假定“非服务器域”为
mybiz.lan，则对于该域的第一个用户，请输入 user1@mybiz.lan 或
mybiz.lan\user1。可以使用该域的呢称输入下一个用户，例如
user2@mybiz 或 mybiz\user2。
注意：切勿在此字段中输入用户的“全名”，因为这会导致在导入过程中出
现错误。
3. 仅限本地身份验证 提供了以下信息：
l
全名 — 为用户键入显示名称
l
密码 — 为用户键入密码。
l
确认 — 重新键入密码。
例如 John Smith
。
4. 许可级别：选择许可级别。若要了解更多信息，请参见许可和用户权限 在本页
74以及权限参考 在本页 179。
5. 用户权限：选择用户是否可以发布工作簿和分配管理员权限。若要了解更多信
息，请参见允许或拒绝用户权限 在本页 78。
6. 单击“添加”。
多站点服务器说明：
只要现有用户仅是站点管理员也可控制的站点的成员，站点管理员就可以编辑该用
户的帐户。例如，如果用户 Joe 是站点 A 和站点 B 的成员，并且站点管理员仅是站点
B 的管理员，则站点管理员不能编辑 Joe 的全名或重置其密码。
向站点添加用户
将站点添加到 Tableau Server 之后，它将变为多站点系统，并且以前的“用户”页面将
变为两个页面：“所有用户”和“站点用户”。作为系统管理员，只有您可以访问“所有
用户”页面，该页面应用于整个服务器系统。只有在此页面上，才可以同时向多个站
点中添加用户，移除用户，并且 如果服务器使用的是本地身份验证 重置用户密
码。
- 59 -
“站点用户”页面是一种快速查看哪些用户在您当前登录的站点上的简便方式。您可以
从此处添加用户，但这些用户将只添加到该站点。
以下过程介绍如何从“所有用户”添加用户。您可以采用的方法有两种：一次添加一个
如下所述 或使用“导入”命令成批添加，这依赖于 CSV 文件 如 从 CSV 文件导入
用户 在本页 62 中所述 。
添加用户：
- 60 -
1. 从“所有用户”页面中，单击用户列表顶部的“添加”链接。
2. 输入“用户名”：
l
l
本地身份验证 — 如果服务器使用的是本地身份验证，则使用电子邮件地
址作为用户名是避免用户名冲突的最佳方法 例如，使用
jsmith@myco.com 而不是 jsmith 。
Active Directory — 如果要添加的用户所属的 Active Directory 域与运行服
务器的域相同，则可以键入不带域的“用户名”。此时将使用服务器所在的
域。
如果服务器所在的域和另一个域之间设置了双向信任，则可以从这两个
域添加用户。首次从“非服务器域”添加用户时，请对用户名使用完全限定
域名。可以使用该域的昵称添加后续用户。例如，假定“非服务器域”为
mybiz.lan，则对于该域的第一个用户，请输入 user1@mybiz.lan 或
mybiz.lan\user1。可以使用该域的呢称输入下一个用户，例如
user2@mybiz 或 mybiz\user2。
注意：切勿在此字段中输入用户的“全名”，因为这会导致在导入过程中出
现错误。
3. 如果服务器使用本地身份验证，请提供以下信息：
l
全名 — 为用户键入显示名称
l
密码 — 为用户键入密码。
l
确认 — 重新键入密码。
例如 John Smith
。
4. 站点成员身份 — 选择用户应是哪个站点的成员。默认情况下会选择您所登录的
站点。
5. 许可级别和用户权限 — 选择许可级别、管理员角色以及用户是否可以发布工作
簿和数据源。属于多个站点的用户可在每个站点上具有不同的许可级别和用户
权限。若要了解更多信息，请参见关于许可级别 在本页 74、权限参考 在本页
179和关于用户权限 在本页 77。
6. 单击“添加用户”。
- 61 -
从 CSV 文件导入用户
可以使用 CSV 文件自动完成添加用户的过程。
要求
l
l
l
l
必须以 UTF-8 格式保存 CSV 文件，带字节顺序标记 (BOM)。
必须对 UTF-8 以外的字符编码
换。
，则 Tableau
以下两列始终是必需的：
l
l
进行转换。可通过“另存为”完成转
不使用列标题。如果使用列标题 Username、Password 等
Server 将尝试作为文件中第一个用户的文本凭据导入它们。
l
l
例如 BIG-5
Username
Password：如果将 Tableau Server 配置为使用 Active Directory 用户身份验
证，则必须具有一个 Password 列，但该列本身应该是空的。如果服务器
使用本地身份验证，则必须为新用户提供密码。有关其他信息，另请参
见“多站点模式和导入位置”。
CSV 文件还可具有按以下顺序显示的下列可选列
列之后 ：
在 Username 和 Password
l
Full Name
l
License Level
“Interactor”、“Viewer”或“未许可”
l
Administrator
“系统”、“站点”、“站点”或“无”)
l
Publisher
l
Email Address
yes/true/1 或 no/false/0
列的顺序非常重要。将第一列视为 Username，将第二列视为 Password，将第
三列视为 Full Name 等等，而不考虑列内容。
多站点模式和导入位置
如果服务器正在运行多个站点，并且您是系统管理员，则您可在两个页面上执行
CSV 用户导入。每个页面具有不同的功能，这些功能与现有服务器用户帐户相关。
l
“所有用户”页面：此页面显示服务器是否运行多个站点，只有系统管理员才可
访问此页面。
- 62 -
如果从这里进行 CSV 导入，您除了可添加新用户帐户外，还可更新现有服务器
用户帐户。例如，如果您针对每个现有用户执行具有新密码的 CSV 导入，则将
重置该用户的密码。
“站点用户”页面：
l
当系统管理员在此处工作时，他们能使用的功能与站点管理员相同。这意味着
他们可通过 CSV 导入来添加新用户帐户，如果导入中含有现有用户，则“密码”
- 63 -
和“全名”字段必须匹配或保留为空白。如果使用新的密码或全名，则导入会失
败。
如果您是具有多个站点的服务器上的站点管理员，则您可从“用户”页面执行 CSV 用
户导入。
用户可以属于同一个服务器系统上的多个站点，但该用户必须针对每个站点使用相
同的凭据。如果您要向站点添加新用户 但可能不是服务器的新用户，也就是说，
这些用户是服务器上其他站点的成员 ，这十分重要。如果您认为可能是这种情
况，请尝试将 Password 列保留为空白 但保留所需的 Password 列标题 。如果将
服务器配置为进行本地身份验证，并且新的站点用户也是服务器系统的新用户，则
CSV 导入窗口中会显示一条消息，提示您为该用户提供密码。
从 CSV 文 件 添 加 用 户
从 CSV 文件添加用户：
1. 从“用户”或“所有用户”页面中，单击“导入”链接：
2. 单击“浏览”，导航到文件，然后单击“检查文件”：
- 64 -
3. 显示初步结果。若要查看帐户特定信息，请选择“查看详细信息”：
4. 若要继续，请单击“导入用户”，然后在最后的对话框中单击“退出”。
向组添加用户
更方便地管理用户的一种方法是将用户分配到组中。这样，您就可以为整个组分配
权限，而不是为每个用户分配权限。若要向组中添加用户，该组必须已存在。有关
详细信息，请参见创建组 在本页 79。
向组中添加用户：
- 65 -
1. 在“管理”选项卡上，选择“用户”页面：
如果您是多站点服务器的系统管理员，则需要使用“站点用户”页面逐个站点地
执行此操作：
2. 选择一个或多个用户。
3. 单击用户列表上方的“添加组”链接，然后选择要将用户添加到的组：
- 66 -
查看、编辑和删除用户
通过本主题可了解如何查看、编辑和删除 Tableau Server 用户。
查看用户
如果 Tableau Server 运行多个站点，则“所有用户”列出服务器系统上的所有用户，而
“站点用户”显示当前已登录站点的所有用户：
注意：
默认情况下，此用户列表是专用列表，只有管理员才可查看。通过启用“维护”页面上
“设置”区域的“公开用户列表”，可以将用户列表公开。如果服务器运行多个站点，则
启用此设置将仅为用户显示其站点上用户的名称。
用户可以跨多个页面列出。选择列表中的用户时，这些用户将添加到左上角的快速
列表中。通过快速列表，可以查看已添加多少用户并有助于方便地从中删除用户。
单击快速列表中用户名旁边的“x”x”按钮可删除所选用户。
- 67 -
也可以使用左侧“筛选器”下的“搜索”框在列表中快速查找特定用户。
键入完整用户名或用户名的一部分，然后按 Enter。可以在搜索中使用星号 (*) 字符作
为通配符。例如，搜索 John* 将会返回所有以 John 开头的名称。
发布权限
管理员可使用用户列表查看谁可以发布以及该权限是显式还是隐式设置的。如果发
布权限是显式设置的，当您将光标悬停在“发布”列中的绿色复选标记上时会显示“允
许(授予)”工具提示：
因拥有管理员或项目主管身份而可以发布的用户具有隐式发布权限。换言之，它是
其角色附带的。将光标悬停在复选标记上时会显示“允许(隐式)”工具提示：
- 68 -
编辑用户
如果将服务器配置为使用内部用户管理系统 本地身份验证 ，则可以在添加用户
之后编辑用户的“显示名称”和“密码”。如果要进行许多更改，则更方便的方法是从
CSV 文件导入更改。有关详细信息，请参见添加用户 在本页 57。
编辑用户信息：
1. 在用户列表中选择一个用户。
2. 单击列表顶部的“编辑”链接。
3. 在相应文本框中键入新的“显示名称”和“密码”。
4. 单击“提交”。
多站点服务器说明：
只要现有用户仅是站点管理员也可控制的站点的成员，站点管理员就可以编辑该用
户的帐户。例如，如果用户 Joe 是站点 A 和站点 B 的成员，并且站点管理员仅是站点
B 的管理员，则站点管理员不能编辑 Joe 的全名或重置其密码。
- 69 -
删除用户
删除用户：
1. 选择一个或多个要删除的用户。
2. 单击列表顶部的“删除”。
3. 在确认对话框中单击“是”。
您只能从 Tableau Server 中移除不拥有任何内容 工作簿、数据源等 的用
户。如果使用前面的步骤删除拥有内容的用户，该用户将被设置为“未许可”而
不是被移除。
“用户首选项”页面
“用户首选项”页面上的选项会影响您的各个 Tableau Server Web 会话。使用这些选项
可以管理订阅设置，指定开始页面，更改您在 Tableau Server 中看到的语言和区域设
置，清除数据连接密码的 Cookie，或者更改 Tableau Server 密码。您还可以使用此页
面快速浏览已发布的各项。
若要访问“用户首选项”页面，请单击页面顶部的用户名，然后从下拉菜单中选择“用
户首选项”：
- 70 -
更改电子邮件地址
如果您订阅了 Tableau Server 视图或工作簿，则用于接收订阅的电子邮件帐户将在“用
户首选项”页面上列出：
若要输入或更改 Tableau Server 将订阅发送到的电子邮件地址，请在“电子邮件”文本
框中输入新电子邮件地址，在“确认电子邮件”文本框中再次输入，然后选择“设置”：
管理订阅设置
使用订阅选项可以更改您正在接收的所有订阅的计划。
更改订阅计划：
1. 在“计划”下，选择不同的计划：
2. 单击“更新”。
- 71 -
您也可以从这里取消订阅视图或工作簿。有关详细信息，请参见取消订阅视图或工
作簿 在本页 102。
自定义开始页面
Tableau Server 安装时将“视图”作为所有用户的默认开始页面，但管理员可以指定不
同的开始页面。若要确定您的开始页面是什么，请单击“转到开始页面”：
通过导航到所需的服务器页面 例如“工作簿” 并从右上角的下拉菜单中选择“使此
页面成为我的开始页面”命令，您可以为自己指定不同的开始页面：
若要返回以使用管理员指定的开始页面，请在“用户首选项”页面上，单击“重置为默
认值”：
语言和区域设置
“语言”设置可控制 Tableau Server 所显示用户界面的语言，而 “区域设置”会影响视图
中的内容，如数字的格式设置方式或所使用的货币。管理员可以为所有服务器用户
配置这些设置，但您可以在这里仅为自己更改设置。如果更改这些设置，请注意仅
当它们是支持的语言时才会生效。若要了解更多信息，请参见语言和区域设置 在本
页 142。
进行“语言”和“区域设置”选择后，请单击“设置”。
下次您登录时，这些设置将用于您的服务器会话。
- 72 -
更 改 Tableau Server 密 码
如果将服务器配置为使用内部用户管理系统 本地身份验证 而不是使用 Active
Directory，则可通过单击“更改密码”更改 Tableau Server 密码。 单击此链接时，系统
会要求您输入“当前密码”和“新密码” 两次 。键入所需信息后，请单击“更改”以保
存更改。
清除保存的数据连接密码
如果您访问的视图或工作簿具有实时数据库连接，并且需要您进行身份验证，则
Tableau 会提出为您保存密码。如果您接受，系统将在 Cookie 中存储您的凭据。单击
“保存的数据连接密码”下的“全部清除”将从 Tableau Server 中移除 Cookie：
浏览已发布项
您的用户帐户页面列出了您发布的所有工作簿、标记和注释。可使用此页面在服务
器上快速浏览您的活动。
- 73 -
许可和用户权限
分配给用户的许可级别和用户权限决定他们能够在 Tableau Server 中执行的操作。
关于许可级别
若要打开“许可证”页面，请单击“管理”选项卡上的“许可证”链接：
- 74 -
必须为 Tableau Server 上的所有用户分配同一个许可级别，即使该级别是未许可级别
也是如此。Tableau Server 许可级别不与您从 Tableau 购买的 Tableau Server 命名用户
许可证相对应 如果您正在使用基于用户而非基于内核的服务器许可 。这些许可
证允许您在服务器上拥有一定数量的用户。借助许可级别，管理员可以控制用户对
站点的访问程度。
下面是您可以分配的许可级别：
许可级别
未许可
查看者
交互者
来宾
说明
用户无法登录到服务
器。默认情况下，所有
用户都以未许可级别添
加。
用户可以登录和查看服
务器上的已发布视图，
但无法与这些视图交
互。此级别的用户只有
查看、添加注释和查看
注释的权限。他们不能
与快速筛选器交互，也
不能对视图中的数据进
行排序。
用户可以登录、浏览服
务器，并且与已发布的
视图交互。请务必注
意，可能已使用限制用
户功能的权限添加特定
的视图、工作簿和项
目。可由工作簿作者或
管理员编辑权限设置。
来宾许可级别用于允许
在服务器上没有帐户的
用户查看嵌入式视图并
与其交互。如果启用此
级别，用户不登录就可
以加载包含嵌入式视图
的网页。只有基于内核
的服务器提供此选项。
如果您具有基于用户的 Tableau Server 许可证，则可以在“许可证”页面上查看这些级
别的分配情况：
- 75 -
如果您具有基于内核的 Tableau Server 许可证，则“许可证”页面将显示是否允许来宾
连接：
它还显示您已许可的内核数和使用中的内核数：
更改许可级别
通常在创建用户时分配许可级别。若要更改一个或多个现有用户的许可级别，请按
照以下步骤操作：
1. 在“管理”选项卡上单击“用户”。
- 76 -
2. 选择一个或多个用户。
3. 单击列表顶部的许可证用户。
4. 为选定用户选择“未许可”、“查看者”或“交互者”。
用户列表中的许可级别会进行更新以反映所做的更改。
关于用户权限
除许可级别外，用户在 Tableau Server 上的特权还受其用户权限的影响：
用户权限
发布
管理
说明
允许用户从 Tableau Desktop 连接到
Tableau Server 以便发布和下载工作
簿和数据源。
将用户设置为管理员。
有两种类型的管理员：站点管理员
和系统管理员。
l
l
站点管理员可以管理组、项
目、工作簿和数据连接。默
认情况下，站点管理员还可
以添加用户并分配用户权限
和许可级别，但系统管理员
可以禁用这项权限 请参见
添加或编辑站点 在本页
106 。
系统管理员具有站点管理员
的所有权限，此外，系统管
理员还可以为未许可的用户
发放许可，控制站点管理员
是否可以添加用户，创建其
他系统管理员，并且可以管
- 77 -
用户权限
说明
理服务器自身。这包括处理
维护、设置、计划和搜索索
引。
只能向拥有交互者许可级别
和“发布”权限的用户分配“管
理”权限。
允许或拒绝用户权限
通常在创建用户时分配用户权限。若要更改一个或多个现有用户的用户权限，请按
照以下步骤操作：
1. 在“管理”选项卡上单击“用户”。
2. 选择一个或多个用户。
3. 单击列表顶部的“发布”或“管理”。
4. 选择“允许”或“拒绝”以更改所选用户的发布权限。
- 78 -
5. 从“管理”中，选择“系统”、“站点”或“无”以更改所选用户的管理权限。用户列
表中的“管理”和“发布”列会进行更新以反映所做的更改。
组和项目
“组”和“项目”可帮助您组织 Tableau Server 上的工作簿和用户。
组
可以将 Tableau Server 用户组织到组中以便更轻松地管理多个用户。可以在本地服务
器上创建组，或者从 Active Directory 导入组。可以在“组”页面上创建和管理组，该页
面列出了服务器或站点上的所有组，前提是该服务器承载多个站点。
创建组
根据服务器的配置方式，可使用内部用户管理系统
者从 Active Directory 导入组。
本地身份验证
来添加组，或
创建本地组
本地组是使用内部用户管理系统在 Tableau Server 上创建的组。创建组后，可以添加
和删除用户。创建本地组：
- 79 -
1. 单击组列表顶部的“新建”。
2. 键入该组的名称，然后单击“添加组”：
3. 单击“返回组”返回到组列表。
通 过 Active Directory 创 建 组
也可以从 Active Directory 导入组。在导入 Active Directory 组时，将在服务器上创建匹
配组，并在服务器上为组中的每个成员创建一个用户。每个用户都未获得许可，并
且没有发布权限。如果服务器上已存在该用户，则会将该用户添加到新组，且不改
变其权限。若要了解有关许可级别和用户权限的更多信息，请参见 许可和用户权限
在本页 74
- 80 -
1. 单击组列表底部的“导入 Active Directory 组”。
2. 键入要导入的 Active Directory 组的名称，然后单击“导入”
3. 如果不知道组的准确名称，可通过在“搜索”文本框中键入全部或部分组名称来
查找。然后单击“搜索”。可将星号 (*) 用作通配符。
4. 从搜索结果列表中选择组。
5. 组名称将自动添加到“导入”文本框中。单击“导入”将组添加到 Tableau Server。
- 81 -
无法更改从 Active Directory 导入的组的名称。只能在 Active Directory 中更改该组
名称。
同 步 Active Directory 组
可随时将 Active Directory 组与 Tableau Server 同步，以便 Active Directory 中的任何新用
户也添加到该服务器中。可同步单个组或一次同步多个组。
1. 在“组”页面上，选择一个或多个组。
2. 单击“同步化”。
如果要添加的组来自于运行该服务器的同一个 Active Directory 域，则只需键入
组名称。另外，如果服务器使用的域和另一个域之间设置了双向信任，则可以
同时从这两个域添加组。第一次从与服务器使用的域不同的域添加组时，必须
在组名称中包括完全限定域名。例如 domain.lan\group 或 group@domain.lan。任
何随后的组都可使用该域的昵称来添加。若要了解有关管理域名的更多信息，
请参见修改域名 在本页 9。
删除用户
在您从 Active Directory 中删除用户，然后与 Tableau Server 上该用户所在的组同步
时，该用户将：
- 82 -
l
从您同步的 Tableau Server 组中删除
l
被置于 Tableau Server 上的“所有用户”组中
l
无法登录 Tableau Server
因为用户仍留在服务器上，所以作为管理员，您可以在完全删除用户帐户之前审核
和重新分配用户的内容。用户将无法登录到服务器。若要从 Tableau Server 中完全删
除用户，您需要执行下列操作：
l
对用户的帐户取消许可
如果 Tableau Server 使用基于用户的许可
l
从 Tableau Server 的“所有用户”页中删除用户
删除组
可以从服务器删除任何组。删除组时，将删除该组中的用户，但不会从服务器删除
这些用户。
1. 在“组”页面上，选择一个或多个要删除的组。
2. 单击组列表上的“删除”：
项目
项目是相关工作簿的集合。作为管理员，您将会在两个位置看到列出“项目”：“内容”
选项卡下，“管理”选项卡下。如果要创建新项目、分配权限或删除项目，请使用“管
理”选项卡下的“项目”页面：
- 83 -
只有管理员才可以创建新项目，而可以向用户和组分配“Project Leader”权限。此权限
让用户或组能够指定项目权限以及将工作簿移到项目中。有关处理项目的步骤和详
细信息，请参见下面的主题：
添加项目
添加一个或多个项目：
1. 单击“添加”链接。
2. 键入项目的名称和说明，然后单击“添加”。可以在项目说明中包含设置格式和
- 84 -
超链接。
将工作簿移动到项目中
所有工作簿都必须位于项目中。默认情况下，工作簿将添加到“默认”项目中。在创建
自己的项目后，您可以将工作簿从一个项目移动到另一个项目中。如果您拥有交互
者许可级别，并且至少满足以下条件之一，就可以将工作簿移动到项目中：
l
您拥有写入项目的权限。
l
您拥有该项目的“Project Leader”权限。
l
您拥有“管理”权限。
将工作簿移动到项目中：
1. 选择一个或多个工作簿，然后单击工作簿列表顶部的“移动”链接。
- 85 -
2. 选择要移入工作簿的项目。
由于所有工作簿必须是项目的一部分，因此可通过将工作簿移动到 Default 项目
中来删除某一项目中的工作簿。每个工作簿都只能是一个项目的一部分。
删除项目
只有管理员才可以删除项目。删除项目时，该项目包含的所有工作簿和视图也会从
服务器删除。删除项目：
1. 在项目列表中选择项目。
2. 单击项目列表上的“删除”。
3. 在确认对话框中单击“是”。
- 86 -
Default 项目无法删除。
计划刷新和订阅
数据提取刷新和订阅交付是 Tableau Server 执行的任务，并且在这些任务运行时会安
排控制。
作为服务器管理员，您对服务器任务和计划拥有最高级别的控制，不过，有两种类
型的任务是 Tableau Server 用户可以计划的。工作簿作者可以在发布含有数据提取的
工作簿或数据源时计划数据提取刷新，而 Tableau Server 用户可以订阅按计划交付的
视图。作为管理员，您可以调整数据提取或订阅的计划，创建新计划和刷新任务，
以及删除计划和任务。您还可以控制是否允许工作簿作者计划 请参见启用计划功
能 下一页 ，并控制是否将服务器配置为发送订阅 请参见管理订阅 在本页 95 。
当作者下次进行发布时，对数据提取计划进行的任何更改都会反映在 Tableau
Desktop 的“计划”对话框中。同样，如果您创建新订阅计划或删除现有订阅计划，则
此操作会在 Tableau Server 用户订阅视图时看到的计划选项中反映出来。
有关详细信息，请参见以下主题：
关于数据提取和计划
Tableau Desktop 允许作者创建数据提取，数据提取就是原始数据源的副本或数据子
集。由于提取的数据将导入到 Tableau 的内置快速数据引擎中，因此使用数据提取的
工作簿通常比使用实时数据库连接的工作簿速度快。数据提取还可以增加功能。发
布带有数据提取的工作簿或数据源后，该数据提取就会驻留在 Tableau Server 上。
直接在 Tableau Server 上刷新数据提取：
l
Web 浏览器：作为管理员，您可以更改或重新分配数据提取刷新计划，无论带
有数据提取的工作簿或数据源在发布时是否设置了刷新计划。当工作簿或数据
源再次发布时，管理员在 Tableau Server 中进行的任何计划更改都会反映在
Tableau Desktop 的“计划”对话框中。
您也可以立即刷新数据提取，只需使用“立即运行”选项即可。有关详细信息，
请参见管理刷新任务 on page 91和创建或修改计划 on the next page。请注意，创
建刷新计划前，必须先在服务器上启用计划功能。若要了解更多信息，请参见
启用计划功能 on the next page。
l
tabcmd 命令行实用工具：您可以在命令行中使用 tabcmd 命令行实用工具提供
的 refreshextracts 命令或将其包含在自己的脚本中。有关详细信息，请参
见自动刷新任务 on page 93。
从 Tableau Desktop 中刷新数据提取：
l
发布时：当作者发布使用数据提取的工作簿或数据源时，可以将其分配给
Tableau Server 上一个可反复使用的刷新计划。 该刷新可以是完全刷新或增量
刷新。增量刷新引用具有日期、日期/时间或整数数据类型的数据提取中的列
- 87 -
如时间戳 。Tableau 使用此列来标识需要添加到数据提取中的新行。有关
详细信息，请参见 Tableau Desktop 帮助中的刷新数据提取和计划。
l
l
用户界面：您可以使用 Tableau Desktop 的“从源刷新”、“从文件添加数据”和“从
数据源添加数据”选项，向 Tableau Server 上传添加内容或刷新其中的数据提
取。如果 Tableau Server 没有足够的凭据从原始数据源刷新数据，您可能需要
执行此操作。有关上传方法的详细信息，请参见 Tableau Desktop 联机帮助中的
更新 Tableau Server 上的数据提取。
数据提取命令行实用工具：数据提取命令行实用工具随 Tableau Desktop 一起安
装。您可以使用该工具向 Tableau Server 上的数据提取上传添加内容或刷新该
数据提取。有关上传方法的详细信息，请参见 Tableau Desktop 联机帮助中的
Tableau 数据提取命令行实用工具。
启用计划功能
在计划数据提取刷新前，必须先在服务器上启用计划功能。启用计划后，可以向计
划添加工作簿和数据源，创建和编辑计划，管理计划任务，以及更改计划设置以允
许发布者向计划分配工作簿。此设置不影响订阅计划。
若要启用计划，请选中“服务器维护”页面上“设置”下的“计划”复选框：
由于刷新数据提取可能需要数据库密码，因此必须启用“嵌入式凭据”以允许计
划。
创建或修改计划
“计划”页面显示了一个计划列表，包括计划名称、类型、作用范围、任务数、行为
同时或顺序处理 以及计划运行的时间。
- 88 -
1. 若要创建新计划，请单击“新建”：
2. 若要修改现有计划，请选择该计划，然后单击“修改”：
3. 为计划指定一个描述性“名称”
4. 选择“计划范围”
例如，“每个星期六早晨”、“月底”
计划将处理的内容
。
— 数据提取刷新或订阅交付。
5. 您可以选择定义一个 0 到 100 之间的“默认优先级”。这是在默认情况下将分配
给任务的优先级。如果队列中有两个未完成的任务，则具有最高优先级的任务
首先运行。若要了解有关修改任务优先级的更多信息，请参见管理刷新任务 在
本页 91。
6. 选择计划中的作业是同时
默认设置
运行还是依次
顺序
运行。
7. 完成定义或编辑计划。您可以定义每小时、每天、每周或每月计划。
- 89 -
8. 单击“创建计划”
划 。
如果是新计划
，或者单击“保存计划”
如果修改了现有计
向计划添加数据源或工作簿
启用计划后， 可以从“工作簿”列表向计划添加工作簿，也可以从“数据源”列表向计划
添加数据源。默认情况下，Tableau Server 具有三个内置的数据提取刷新计划。您也
可以创建自己的计划。有关详细信息，请参见创建或修改计划 在本页 88。
1. 如果为工作簿计划数据提取刷新，请在“工作簿”页面上选择一个或多个工作
簿，然后单击“计划任务”：
- 90 -
如果为数据源计划数据提取刷新，请在“数据源”页面上选择一个或多个数据
源，然后单击“计划任务”：
2. 选择“添加完全刷新”或“添加增量刷新”，然后从列表中选择计划：
“添加完全刷新”仅当所选数据源连接到数据提取时才可用。“添加增量刷新”仅
当所选数据源连接到定义了增量刷新的数据提取数据源时才可用。Tableau
Server 无法刷新与映射驱动器上的本地文件数据源连接的数据源。更新连接以
使用至该数据源的完整路径。
管理刷新任务
“任务”页面显示正在由服务器处理的所有完全和增量的数据提取刷新任务。系统和站
点管理员可以使用此页面更改任务的优先级，将任务移到其他计划，运行或删除任
务。您可以单击“管理”选项卡上的任务，打开“任务”页面：
- 91 -
编辑任务计划
通过执行以下操作将数据提取刷新任务从一个计划移到另一个计划：
1. 在“任务”页面上，选择一个或多个要修改的任务。
2. 单击“编辑计划”。从计划列表选择一个新计划：
也可通过在列表中选择一个或多个任务然后选择工具栏上的相应选项来删除和运行
任务。
立即运行任务
您也可以立即强制刷新任务
可。
例如数据提取刷新任务
1. 在“任务”页面上，选择要运行的任务。
2. 单击立即运行。
- 92 -
，只需使用立即运行选项即
更改任务优先级
更改数据提取刷新任务的优先级：
1. 在“任务”页面上，选择一个或多个要修改的任务。
2. 单击修改优先级。
3. 键入 0 到 100 之间的一个新优先级，然后单击“提交”。
自动刷新任务
您可以将数据提取刷新任务与 Tableau Server 中的计划关联，以自动刷新数据提取。
还可以使用 tabcmd 自动刷新数据提取，它是一个随 Tableau Server 提供且能安装在
Tableau Server 之外的计算机上的命令行实用工具。具体来说，您可以将
refreshextracts 命令与您脚本中的其他命令结合使用。例如：
tabcmd login - http://mytabserver -u jsmith -p P@ssw0rd!
refreshextracts --datasource salesq4
处理数据提取刷新通知
如果计划的数据提取刷新失败，Tableau 将在右上角显示“通知”菜单：
仅当数据提取刷新失败，并且您具有以下身份时，才会看到“通知”菜单：
l
系统管理员和站点管理员。
l
未能刷新的工作簿或数据源的作者。
l
连接到未能刷新的数据源的工作簿的作者。
- 93 -
打开“通知”菜单后，可以看到有关刷新失败的更多信息：
当“数据源”列示为“嵌入”时，意味着该数据源定义 包括数据源凭据或数据库名称等
内容 嵌入或驻留在原来在 Tableau Desktop 中创建的工作簿自身中。
当数据源名称或工作簿名称列示为“数据源”时 例如数据源: sales_data
该数据源是 Tableau Server 数据源。数据源定义位于 Tableau Server 上。
，意味着
在数据窗口中，您可以识别原来在 Tableau Desktop 中创建的工作簿或数据源。 数据
源名称旁边会显示一个 Tableau 图标而非数据库图标：
解决数据提取刷新问题
通过单击通知中的“编辑连接信息”链接，输入缺少的信息，然后单击“保存”，可以解
决一些数据提取刷新问题：
- 94 -
如果通过编辑数据连接无法解决问题，则需要在 Tableau Desktop 中解决它并重新发
布工作簿。
提示： 管理员可以随时在“数据连接”页面上编辑数据连接，可从“管理”选项卡访问
该页。
管理订阅
订阅是安排通过电子邮件定期将 Tableau Server 视图或工作簿发送给订阅用户。当订
户单击其电子邮件中的视图或工作簿的快照时，它即在 Tableau Server 中打开。
若要访问有关每个订阅的信息，例如订户的电子邮件地址和姓名、视图名称及发送
计划，请单击“管理”选项卡上的“订阅”。
要求
若要使 Tableau Server 用户能够接收订阅，必须存在以下项：
l
l
l
电子邮件设置配置： 作为系统管理员，您可以在安装过程中出现的“配置”对话
框中的“通知和订阅”选项卡上配置订阅的基本 SMTP 服务器设置。这是Tableau
Server 用于将订阅通过电子邮件发送给服务器用户的“发件人帐户”。您也可以
在安装后访问此选项卡。有关步骤，请参见重新配置服务器 在本页 21和配置电
子邮件订阅 在本页 13。
嵌入凭据或不需要凭据：从 Tableau Server 的角度来看，订阅包括工作簿、数
据和计划。为了交付数据，Tableau Server 需要能够在没有最终用户参与的情况
下访问数据。这可以使用具有嵌入式数据库凭据的工作簿、Tableau Server 数据
源或使用不需要凭据的数据 如发布时工作簿附带的文件 实现。无法订阅要
求提供凭据以进行实时数据库连接的工作簿。
用户要求：如果用户可以看到 Tableau Server 上的视图或工作簿并且视图或工
- 95 -
作簿的右上角有订阅图标 ( )，那么该用户就可以订阅该视图或工作簿。能否
看到视图或工作簿由“视图”权限控制。用户还必须具有电子邮件地址。如果
Tableau Server 尚没有订阅用户的电子邮件地址，在用户注册订阅时，它会提示
用户提供一个电子邮件地址。用户可以在“用户首选项”页面上更改其交付选
项、取消订阅或者更新其电子邮件地址。
l
不使用受信任的身份验证： 如果 Tableau Server 配置为使用受信任的身份验
证，则将禁用订阅。受信任的身份验证与 Tableau 的本地身份验证结合可以为
最终用户打造“免登录”且经过身份验证的体验。为了创建与此相同的体验并使
用订阅，请改用 Active Directory 并启用自动登录 作为用户身份验证类型。
可以在安装期间选择用户身份验证类型。有关详细信息，请参见配置服务器 在
本页 7。
其他订阅设置
只要在“通知和订阅”选项卡上配置了订阅并且 Tableau Server 正在使用其默认设置，
服务器用户就可以订阅其查看的视图和工作簿。若要阻止用户订阅或自定义其订阅
体验，下面是要转向的页面：
l
l
l
“站点”页面：默认情况下为每个站点启用订阅，但您可以使用“站点”页面逐个
站点地禁用订阅或进行自定义。 例如，可以为订阅输入自定义“发件人地址”，
而不是在“配置”对话框中指定的地址。还可以为用户接收的订阅电子邮件创建
您自己的页脚。
“计划”页面：用户至少需要一个订阅计划以供在订阅时进行选择。默认情况
下，Tableau 提供两个订阅计划。作为系统管理员，您可以创建其他计划或者
删除默认计划。有关详细信息，请参见创建或修改计划 在本页 88。
“订阅”页面：此页面列出服务器或站点上 如果您是站点管理员 的所有订
阅。此页面列出服务器或站点 如果您是站点管理员 上的所有订阅。系统管
理员可以使用此页面更改服务器用户的订阅计划或删除其订阅。有关详细信
息，请参见以下主题。
有关如何测试是否正确配置了订阅的步骤，请参见测试订阅配置 下一页。如果订阅
出现问题，请参见订阅疑难解答 在本页 351。
删除订阅
若要删除订阅，请选择要移除的订阅，然后单击“删除”：
- 96 -
编辑订阅计划
若要更改某个订阅的计划，请选择该订阅，单击“编辑计划”并选择一个计划：
测试订阅配置
作为管理员，您可以通过执行以下操作来测试是否正确配置了订阅：
1. 订阅视图。
2. 在“计划”页面上，选择包含您的订阅的计划。
3. 单击“立即运行”：
4. 几分钟后，订阅应该就会出现在电子邮件收件箱中。
订阅疑难解答
"此 电 子 邮 件 中 的 视 图 快 照 无 法 正 确 呈 现 。 ”
如果您接收的订阅出现此错误消息，可能是由以下几种原因导致的：
l
l
l
缺失凭据：某些视图是与嵌入式凭据一起发布的。如果嵌入式凭据现已过时或
视图并未与嵌入式凭据一起发布，则您可能会收到以上错误消息。
数据库暂时瘫痪：如果视图具有实时数据库连接，且数据库在生成订阅时暂时
瘫痪，则您可能会收到以上错误消息。
后台进程超时：默认情况下，处理订阅的后台进程如果在 30 分钟后还未完成，
就算超时。大部分情况下，30 分钟足够了。但如果后台进程在处理极大且非常
- 97 -
复杂的仪表板，30 分钟可能就不够。您可以检查后台任务 在本页 147管理视
图，看看是否出现了这种情况。若要提高超时阈值，请使用 tabadmin 选项
subscriptions.timeout。
无法订阅
如果您在 Tableau Server 上可以看到视图并且该视图的右上角有一个订阅图标 (
则您可以订阅该视图。
)，
需要存在以下两项，您才能订阅视图：需要正确配置 Tableau Server 请参见管理订
阅 在本页 95 ，并且您订阅的视图必须已嵌入其数据源的凭据或者根本不需要凭
据。后一种情况的示例连接到不需要刷新的数据提取的工作簿，或其数据位于发布
时工作簿附带的文件中的工作簿。嵌入凭据的步骤在 Tableau Desktop 中执行 有关
详细信息，请参见 Tableau Desktop 帮助 。
没有订阅图标
可以在 Tableau Server 上看到视图但无法订阅它。具有实时数据库连接的视图会出现
这种情况，当您首次单击该视图时，会提示您提供数据库凭据。订阅包括视图 或
工作簿 、数据和计划。为了交付数据，Tableau Server 需要嵌入式数据库凭据或不
需要凭据的数据。至于实时数据库连接，Tableau Server 没有相关凭据，只有单个用
户拥有凭据。这就是为什么您只能订阅不需要凭据或已嵌入凭据的视图的原因所
在。
如果 Tableau Server 配置为使用受信任的身份验证，您也可能可以看到视图但无法订
阅它 没有订阅图标 。有关详细信息，请参见订阅要求。
接 收 的 订 阅 无 效 或 “破 损 ”
如果除了生产实例，您还配置了 Tableau Server 测试或开发实例上的订阅，请禁用非
生产实例上的订阅。在所有实例上将订阅保持为启用状态会导致您用户接收到看起
来有效但实际无法运作的订阅，或接收到已在视图或工作簿上取消的订阅。
订阅没有到达
“发 送 电 子 邮 件 时 出 错 。 无 法 向 SMTP 主 机 发 送 命 令 。 ”)
如果订阅显示为已发送 根据后台任务 在本页 147管理视图 但没有到达，并且您的
SMTP 服务器使用的是加密 (SSL) 会话，您可能会在 Windows 事件查看器中看到以上
错误消息。订阅只支持未加密的 SMTP 连接。解决方案是使用未加密的 SMTP 服务
器。
升 级 到 8.1 后 ， 自 定 义 脚 本 不 工 作
为了更好地管理会话，从 8.1 版开始，向视图 URL 末尾添加了一个井号 (#)。如果您
的自定义订阅脚本会以 PDF 或 PNG 形式生成视图，可能需要更新脚本以允许使用井
号。
例如，在 8.1 版之前，视图 URL 类似于
http://tableauserver/views/SuperStore/sheet1，您可以向 URL 末尾添加
.png 生成 PNG 形式的视图，例如
http://tableauserver/views/SuperStore/sheet1.png。 从 8.1 版开始，视图
URL 类似于：http://tableauserver/views/SuperStore/sheet1#1。若要生
成 PNG，可在井号前面添加 .png。例
如：http://tableauserver/views/SuperStore/sheet1.png#1
- 98 -
订阅视图
如果您在 Tableau Server 上可以看到视图并且该视图的右上角有一个订阅图标 ( )，
则表示您的管理员已为您的站点配置了订阅，您可以订阅该视图。 这意味着会定期
自动向您的电子邮件收件箱中发送视图的快照，而您不必登录 Tableau Server。您还
可以订阅工作簿。您可以在一封电子邮件中接收工作簿中的每个视图，而不是接收
单个视图。您可以取消订阅您不想再接收的订阅。有关详细信息，请参见以下内
容。
可以在“用户首选项”页面上更改您的订阅设置。有关详细信息，请参见管理订
阅设置 在本页 71。
订阅视图
订阅视图或工作簿：
1. 选择“视图”或“工作簿”页面：
2. 单击视图或工作簿。
3. 单击右上角的订阅图标：
- 99 -
4. 如果您的 Tableau Server 帐户尚未与电子邮件地址相关联，则系统会提示您提
供一个。输入您的电子邮件地址，然后单击“下一步”。
您可以更改用来接收订阅的电子邮件地址。有关详细信息，请参见更改电子邮
件地址 在本页 71。
5. 在接下来的对话框中，选择订阅计划。默认情况下，Tableau Server 会提供工作
日早晨计划和星期一早晨计划。Tableau Server 管理员还可以创建自定义订阅计
划。
- 100 -
6. 接下来，选择您是要订阅单个视图 “此工作表”
簿中的工作表” ，然后单击“订阅”。
还是订阅整个工作簿
“工作
7. 稍后，当您通过电子邮件收到订阅时，单击视图的快照，它将在 Tableau Server
上打开：
- 101 -
取消订阅视图或工作簿
取消订阅视图或工作簿：
1. 通过单击订阅电子邮件底部的链接，打开 Tableau Server 上的“用户首选项”页
面：
- 102 -
您还可以从 Tableau Server 下拉菜单中打开“用户首选项”页面：
2. 在您要取消订阅的视图旁，选中“取消订阅”复选框。
- 103 -
您还可以在这里更改订阅。有关详细信息，请参见管理订阅设置 在本页 71。
3. 单击“更新”。
站点
使用“站点”页面可为一个服务器系统上的不同组织或组创建独立站点。每个站点的工
作簿、数据和用户列表都独立于其他站点的相应项。只有系统管理员才可以查看每
个站点并执行各种操作，例如，创建站点并进行系统范围的更改。有关详细信息，
请参见以下主题：
使用站点
下面的主题介绍使用多个站点的各个方面 例如使用哪种身份验证
的与用户许可证和管理员角色有关的内容。
以及应该了解
身份验证和登录凭据
一个服务器上的所有站点都使用相同的服务器运行身份帐户和用户身份验证模式。
在安装 Tableau Server 时，需要选择这两个设置。有关详细信息，请参见常规 在本页
8。
属于同一个服务器系统上的多个站点的用户对每个站点使用相同的凭据。例如，如
果史珍妮在站点 A 的用户名为“jsmith”并且密码为“MyPassword”，她在站点 B 上也使用
相同的凭据。例如，如果史珍妮在站点 A 的用户名为 jsmith，密码为“MyPassword”，
她在站点 B 上使用这些相同的凭据。当她登录 Tableau Server 时，她将能够选择她要
访问的站点。
Default 站点
为帮助您从单服务器系统平稳过渡到多服务器系统，Tableau Server 在安装时带有一
个名为 Default 的站点。如果运行模式为单站点模式，则无需显式使用 Default 站点，
它的使用是自动进行的。但是，如果添加一个或多个站点，则 Default 会成为您登录
Tableau Server 时可以登录的站点之一。Default 站点与添加到系统中的站点有以下不
同：
- 104 -
l
永远无法删除该站点，但与添加的站点一样，可以对其重命名。
l
该站点存储随 Tableau Server 提供的示例和数据连接。
l
Default 站点所用的 URL 没有名为“default”的相应 Web 文件夹。例如，名为 Sales
的站点上名为 Profits 的视图的 URL 为
http://localhost/t/sales/views/profits。Default 站点上同一视图的
URL 为 http://localhost/views/profits。
站点管理员和系统管理员角色
Tableau Server 中有两种类型的管理员，即系统管理员和站点管理员。系统管理员可
以控制站点管理员是否可在“添加新站点” 或“编辑站点” 对话框中添加和删除用
户：
如果选择了“仅系统管理员”，则站点管理员不能添加或删除站点用户。但是，他们仍
然可以管理其站点中的组、项目、工作簿和数据连接。如果选择了“系统和站点管理
员” 默认设置 ，则站点管理员可以执行上述所有操作，并可以添加或删除用户。
许可和用户限制
用户可以属于多个站点，在每个站点上具有不同的用户权限和许可级别。不过，属
于多个站点的用户也不是对于每个站点都需要许可证。每个服务器用户只需要一个
许可证。
系统管理员可以使用“站点用户数目最大值 <n>”设置来指定站点的用户限制。将仅对
许可用户计数；不包括系统管理员。例如，如果一个站点有 90 个许可用户、20 个未
许可用户和一个系统管理员，则用户计数为 90。如果“站点用户数目最大值”设置为
“100”，则还可以添加 10 个许可用户。
- 105 -
添加或编辑站点
如果您是系统管理员，则可以通过执行以下操作向 Tableau Server 添加站点或编辑现
有站点：
1. 单击“管理”下的“站点”打开“站点”页面，然后单击“添加”：
或者，如果要编辑站点，请选择要更改的站点，然后单击“编辑”。如果您尚未
向 Tableau Server 中添加站点，则只有一个站点可供选择：Default。
2. 为站点输入“站点名称”和“站点 ID”
“站点 ID” ：
如果编辑的是 Default 站点，则无法更改
无法更改 URL 中的“t” 例如，http://localhost/t/wsales
中，它出现在除默认站点之外的站点的 URL 中。
。在多站点服务器系统
3. 工作簿、数据提取和数据源全部占用服务器上的存储空间。选择“无限制”或“配
额”，然后输入希望作为限制的 GB 数。如果您设置了配额但站点超过了该配
额，则将阻止发布者上载新内容，直至站点再次低于该限制。系统管理员可以
使用站点页面上的“存储配额”和“已用配额百分比”列来跟踪站点相对于其配额
的情况。
- 106 -
4. 接下来，选择是只有您 即系统管理员 可以添加和删除用户 “仅系统管理
员” ，还是两类管理员 “系统和站点管理员” 均可执行该操作。
如果您允许站点管理员添加用户，则可通过选择以下选项之一来指定他们可向
站点添加多少用户：
l
l
直到服务器容量：对于使用基于用户的许可的服务器，此限制是可用的
服务器席位许可证数。对于使用基于用户的许可的服务器，此限制是可
用的服务器席位许可证数。对于使用基于内核的许可的服务器，对可以
添加的用户数没有限制。
站点用户数目最大值 <n>：允许站点管理员根据您指定的限制来添加用
户。允许站点管理员根据您指定的限制来添加用户。有关许可和用户限
制的信息，请参见使用站点。
5. 选择“允许性能记录”将允许您的站点用户收集有关工作簿执行方式的指标，例
如，工作簿加载速度等。
除了为站点选中此复选框之外，若要开始记录，用户还必须向工作簿的 URL 中
添加参数。有关详细信息，请参见创建性能记录 在本页 219。
6. 将“允许对此网站进行 Web 制作”保留为选中或清除它以在服务器上完全禁用制
作。
禁用 Web 制作意味着用户无法从服务器 Web 环境编辑已发布工作簿。要更新
已发布到服务器的工作簿，Tableau Desktop 用户必须重新发布它。有关更多信
息，请参见示例：禁用 Web 制作 在本页 194。
7. 如果您希望站点用户能够订阅视图，请在“站点订阅设置”下将启用订阅始终设
为选中状态。只有当您也在“配置”对话框中配置了订阅设置时，此选项才可
见。
- 107 -
还可以为订阅输入自定义“发件人地址”。尽管您输入的地址应使用有效的电子
邮件地址语法 例如 bizdev@bigco.com 或 noreply@sales ，但是 Tableau
Server 不需要它对应于实际电子邮件帐户 然而，某些 SMTP 服务器可能需要
它是实际地址 。
8. 通过“电子邮件页脚”，选择“自定义”并输入任何您希望出现在订阅页脚的
Tableau Server URL 上的文本。例如，如果输入以下文本：
电子邮件页脚看起来将类似于：
9. 单击“确定”。
如果向 Tableau Server 中添加第一个站点，则“管理”选项卡将发生更改。用户现在为
所有用户 因为它与服务器上的所有用户相关 ，而且将显示站点用户类别。
- 108 -
向站点添加用户
将站点添加到 Tableau Server 之后，它将变为多站点系统，并且以前的“用户”页面将
变为两个页面：“所有用户”和“站点用户”。作为系统管理员，只有您可以访问“所有
用户”页面，该页面应用于整个服务器系统。只有在此页面上，才可以同时向多个站
点中添加用户，移除用户，并且 如果服务器使用的是本地身份验证 重置用户密
码。
- 109 -
“站点用户”页面是一种快速查看哪些用户在您当前登录的站点上的简便方式。您可以
从此处添加用户，但这些用户将只添加到该站点。
以下过程介绍如何从“所有用户”添加用户。您可以采用的方法有两种：一次添加一个
如下所述 或使用“导入”命令成批添加，这依赖于 CSV 文件 如 从 CSV 文件导入
用户 在本页 62 中所述 。
添加用户：
1. 从“所有用户”页面中，单击用户列表顶部的“添加”链接。
2. 输入“用户名”：
l
本地身份验证 — 如果服务器使用的是本地身份验证，则使用电子邮件地
址作为用户名是避免用户名冲突的最佳方法 例如，使用
- 110 -
jsmith@myco.com 而不是 jsmith
l
。
Active Directory — 如果要添加的用户所属的 Active Directory 域与运行服
务器的域相同，则可以键入不带域的“用户名”。此时将使用服务器所在的
域。
如果服务器所在的域和另一个域之间设置了双向信任，则可以从这两个
域添加用户。首次从“非服务器域”添加用户时，请对用户名使用完全限定
域名。可以使用该域的昵称添加后续用户。例如，假定“非服务器域”为
mybiz.lan，则对于该域的第一个用户，请输入 user1@mybiz.lan 或
mybiz.lan\user1。可以使用该域的呢称输入下一个用户，例如
user2@mybiz 或 mybiz\user2。
注意：切勿在此字段中输入用户的“全名”，因为这会导致在导入过程中出
现错误。
3. 如果服务器使用本地身份验证，请提供以下信息：
l
全名 — 为用户键入显示名称
l
密码 — 为用户键入密码。
l
确认 — 重新键入密码。
例如 John Smith
。
4. 站点成员身份 — 选择用户应是哪个站点的成员。默认情况下会选择您所登录的
站点。
5. 许可级别和用户权限 — 选择许可级别、管理员角色以及用户是否可以发布工作
簿和数据源。属于多个站点的用户可在每个站点上具有不同的许可级别和用户
权限。若要了解更多信息，请参见关于许可级别 在本页 74、权限参考 在本页
179和关于用户权限 在本页 77。
6. 单击“添加用户”。
删除站点
系统管理员可以删除已添加到 Tableau Server 的站点。删除站点会同时删除发布到该
站点的工作簿和数据源以及用户。如果用户属于其他站点，则不会将其删除。若要
永久删除用户，需要使用“所有用户”页面。
删除站点：
- 111 -
1. 在“服务器”下打开“站点”页面：
2. 选择要删除的站点，然后单击“删除”：
3. 在出现的确认对话框中单击“是”。
导入或导出站点
您可以通过将现有站点导出到一个文件，然后将该文件导入新站点，来配置新
Tableau Server 站点。导出的站点称为 源站点 。 导入到其中的站点称为 目标站点 。
源站点可以来自 Tableau Online 它是 Tableau Server 基于云的版本，由 Tableau 托
管 ，也可以来自您管理的 Tableau Server 部署。导入站点时，该站点的所有资产
- 112 -
包括工作簿、项目、数据源、用户
阅或已创建的用户收藏夹列表。
都一同导入。导入内容还包括所有权限、订
导出之前...
导出站点之前，请注意以下事项：
删除未使用的项： 确保源站点只包含您想导入的内容。删除任何未使用的工作簿、
项目或数据源。
移除未使用的用户： 确认所有用户都已获得许可并移除不再代表实际用户的任何用
户。必须将从源站点导出的所有用户导入目标站点。不能在导入过程中移除用户。
在目标服务器上创建用户帐户： 站点导入过程会向用户分配一个目标站点。用户在
目标服务器系统上必须已经拥有用户帐户。如果将一个站点导出到同一 Tableau
Server 上的另一个站点，将拥有所需的所有用户帐户。如果从 Tableau Online 或从另
一台 Tableau 服务器导出站点，则必须先在目标服务器上创建用户帐户，然后再执行
导入。
检查用户身份验证： 用户身份验证是一种服务器端设置，服务器上的所有站点必须
使用相同设置。可以从使用不同用户身份验证方法的服务器导出或导入到这些服务
器，但需要修改用于导入的映射文件。该步骤内置于导入过程中，详见验证站点的
映射 在本页 115。由于 Tableau Online 站点使用自定义用户身份验证方法，因此从
Tableau Online 站点导出需要对用户特定的映射文件进行编辑。这可以确保干净导
入，与目标服务器的配置方式无关。
检查计划： Tableau Server 上的“计划”页列出您可以用于数据提取刷新和订阅的默认
计划：
分配给源站点上的默认计划的刷新和订阅将自动映射到目标站点上的相同计划。如
果源站点具有自定义计划，它们将会导入目标站点，在编辑映射文件时，还可以选
择将它们重命名。
配置目标服务器以交付订阅： 订阅将会导入新站点，但如果目标服务器尚未配置为
交付订阅，则必须进行相应配置。有关详细信息，请参见通知和订阅 在本页 12。
创建或标识目标站点： Tableau Server 上必须已经有目标站点，才能导入站点文件。
目标站点上有但源站点上没有的任何内容在导入期间都将被移除。因此，建议使用
空站点。有关创建或更改站点的详细信息，请参见添加或编辑站点。
查找站点 ID： 用于导出或导入站点的命令需要使用站点 ID 作为参数。站点 ID 用于
向 Tableau Server 唯一地标识站点。 登录站点时，站点 ID 会出现在 URL 中的 t/ 后
面：
- 113 -
导出站点
导出或导入过程中不需要停止 Tableau Server。导出站点：
1. 以管理员身份打开命令提示符，然后转到 Tableau Server 上的 bin 目录。例如：
C:\Program Files\Tableau\Tableau Server\8.2\bin
2. 键入以下命令：
tabadmin exportsite <site ID> --file <filename or path>.
例如，若要将站点 ID 为 wsales 的站点导出到文件 C:\sites\exported_sites\sales_
export.zip，请键入以下命令：
tabadmin exportsite wsales --file C:\sites\exported_
sites\sales_export.zip
有关可与 exportsite 命令一起使用的其他选项的示例，请参见 exportsite
在本页 314。
在导出期间，Tableau Server 锁定该站点。
导入站点
如果尚没有用于导入的目标站点，请创建一个。 请参见添加或编辑站点了解相关步
骤。
导入站点共分三步。首先，要运行 tabadmin importsite 命令以生成将要导入的
文件；接下来，验证这些文件是否显示了将要导入站点的方式；最后，运行
tabadmin importsite_verified 命令完成导入。
在开始之前，需要准备好导出的站点文件和目标站点的站点 ID。Tableau Server 默认
站点的站点 ID 是 "" 双引号，没有空格 。如果您是在 Windows PowerShell 中运行
命令，则用单引号 ('""') 分隔默认站点双引号。
虽然无需在导入过程中停止 Tableau Server，但接收导入的站点将处于锁定状态，直
到导入完成。
开始站点导入
开始站点导入：
1. 以管理员身份打开命令提示符，然后转到 Tableau Server 上的 bin 目录。例如：
C:\Program Files\Tableau\Tableau Server\8.2\bin
2. 键入以下命令：
- 114 -
tabadmin importsite <site ID> --file <filename or path>
其中，<site ID> 是目标站点的站点 ID，<filename or path> 是导出的站
点文件的完整路径。
例如，若要将文件 C:\sites\exported_sites\sales_export.zip 导入站点 ID 为 esales
的站点，请键入以下命令：
tabadmin importsite esales --file C:\sites\exported_
sites\sales_export.zip
有关可与 importsite 命令一起使用的其他选项的示例，请参见 importsite
在本页 315。
3. 输入命令后，要验证的映射文件将被放置到 ProgramData\Tableau\Tableau
Server\data\tabsvc\temp\import_<site ID>_<datetime>\mappings 中。 请记下此位置
以便在下一过程中使用。
验证站点的映射
使用 importsite 命令启动站点导入后生成的映射文件将显示在导入完成后，将如
何分配站点资源。Tableau Server 无法映射的文件以及需要编辑的文件将在 CSV 文件
中使用问号 (???) 进行标记。 运行最终的 importsite_verified 命令之前，必须
更改问号，使其表示目标站点上的有效分配。
在更改过程中不能添加或移除用户。导入的用户的所有用户名在目标服务器上
必须已经存在。
验证站点的映射文件：
1. 转到在输入 importsite 命令后显示的目录：
2. 使用 Microsoft Excel
件。
建议
或文本编辑器，打开映射文件夹中的每个 CSV 文
每个文件都显示在导入到目标站点后，将如何映射或处理源站点中的项。
3. 验证映射是否正确。将任何带有问号 (???) 的条目替换为有效值。使用该表作
- 115 -
为指南：
CSV 文件名
列标题
mappingsDomainMapperForGroups source_
name
source_
domain_
name
target_
domain_
name
mappingsScheduleMapper
是否 说明
可编
辑？
否
源站点上的用户组名称。
否
是*
source_
name
否
source_
scheduled_
action_type
否
target_name 是
target_
scheduled_
- 116 -
否*
源站点上的用户身份验证
类型：local 对于本地
身份验证 或域名称 对
于 Active Directory 。
源站点上的用户身份验证
类型：local 对于本地
身份验证 或域名称 对
于 Active Directory，例如
example.com 或
example.lan 。
*不要编辑“所有用户”的
target_domain_name
值。将其值保留为
local，即使您的目标服
务器配置为使用 Active
Directory 用户身份验证。
“所有用户”组是每个
Tableau Server 上都必须
存在的特殊的默认用户
组。
源站点上的自定义和默认
数据提取或订阅计划的名
称。
计划的类型，要么是“数
据提取” 对于数据提取
刷新 ，要么是“订阅”
对于源站点上的订阅交
付 。
目标站点上的自定义计划
的名称。您可以编辑该
值。例如，如果计划在源
站点上的名称是“星期五
更新”，您可以在目标站
点上将其重命名为“星期
五刷新”。
计划的类型，要么是“数
据提取” 对于数据提取
刷新 ，要么是“订阅”
对于目标站点上的订阅
交付 。
action_type
mappingsSiteMapper
source_url_
namespace
target_url_
namespace
mappingsSystemUserNameMapper source_
name
source_
domain_
name
否
*在极少数情况下，该列
中可能会有问号 (???)。
如果有，请将它们替换为
“数据提取”或“订阅”，使
其与您在“source_
scheduled_action_type”
中看到的条目匹配。
源站点的站点 ID。
否
目标站点的站点 ID。
否
用户在源站点上的用户
名。
源站点上的用户身份验证
类型：local 对于本地
身份验证 ，域名称 对
于 Active Directory，例如
example.com 或
example.lan ，或
external 对于 Tableau
Online 站点 。
在导入时将分配给目标站
点的用户的用户名。
否
target_name 是
确认所有列出的用户名在
目标服务器系统上都存
在，并将所有问号 (???)
替换为目标服务器上的有
效用户名。
不能通过向 CSV 文件中
添加行来创建用户名。同
样，也不能通过删除行来
移除用户名。
您可以编辑 target_name
列中的用户名，使其不同
于源用户名，只要它已经
使用该不同名称存在于目
标服务器系统上即可。例
如，用户的 source_
name 值可以是
- 117 -
jsmith@myco.com，
target_name 值可以是
johnsmith@example.com
，只要目标服务器上存在
用户名
johnsmith@example.com
即可。
target_
domain_
name
是
不能将源站点上的一个用
户映射到目标站点上的多
个用户名。
目标站点上的用户身份验
证类型：local 对于本
地身份验证 或域名称
对于 Active Directory，
例如 example.com 或
example.lan 。
4. 如果进行编辑，请保存所做更改并保留 CSV 文件的格式设置。将映射文件保留
在其当前位置。
完成站点导入
完成站点导入：
1. 以管理员身份打开命令提示符，然后转到 Tableau Server 上的 bin 目录。例如：
C:\Program Files\Tableau\Tableau Server\8.2\bin
2. 键入以下命令：
tabadmin importsite_verified <site ID> --importjobdir <PATH>
其中，<site ID> 是目标站点的站点 ID，<PATH> 是您在验证站点的映射 在本
页 115中使用的映射目录的上一级目录。 例如：
tabadmin importsite_verified esales --importjobdir
C:\ProgramData\Tableau\Tableau
Server\data\tabsvc\temp\import_esales_20140409185810071
有关可与 importsite_verified 命令一起使用的其他选项的示例，请参见
importsite_verified 在本页 317。
3. 打开刚刚导入的新站点，并确保一切都符合预期。
多站点导航
下面是一些有关如何在站点间导航和识别您正在使用的站点的提示。
- 118 -
站点登录
如果您是多个站点的成员，则在您登录服务器时，会提示您选择站点：
导航到其他站点
如果您属于多个站点，则您将会在页面顶部看到“站点”菜单：
若要登录到不同的站点，请单击“站点”菜单并选择相应站点：
识别站点
如果服务器正在运行多个站点，然而您只属于一个站点，则在登录服务器时，不会
看到选择站点的提示。登录后，您将不会在页面顶部看到“站点”菜单：
不过，Web 浏览器 URL 将显示一个 t，后跟您的站点的“站点 ID”：
- 119 -
如果服务器未在运行多个站点，则 Web 浏览器 URL 看起来将类似于：没有 t，没有
“站点 ID”。如果您看到是这样，则表示您正在使用 Tableau 的内置站点，名为“默
认”。
服务器维护
系统管理员需要检查服务器的状态，分析和监视服务器上的活动，管理计划的任
务，或执行某些维护活动 如重新生成搜索索引 。另外，可能需要指定几种设置
以自定义使用服务器的人员的用户体验。可从“维护”页面执行所有这些任务。
查看服务器进程状态
您可以使用“维护”页面上的“状态”表查看各个 Tableau Server 上的 Tableau 进程状态：
有关 VizQL Server 进程的未许可状态的信息，请参见处理未许可的 VizQL
Server 进程 在本页 349。
若要显示以上信息的计算机可读版本，请从“维护”页面上将 URL 中的词 status 替换为
systeminfo 例如，http://jsmith/admin/systeminfo 。将显示一个与下面类似的网页：
- 120 -
Tableau Service 的状态类型为“正常”、“忙”、“关闭”和“备用”。
远程访问状态
作为 Tableau 管理员，只有您可以查看“维护”页面上的工具，包括“状态”表。不过，您
可以将计算机可读版本的“状态”表提供给非管理员用户和承载 Tableau Server 的计算
机以外的计算机使用 — 例如，作为远程监视过程的一部分。授予对 Tableau Service
状态的远程访问权限：
1. 在运行主 Tableau Server 的计算机上，打开 Tableau Server 配置文件：
ProgramData\Tableau\Tableau Server\config\tabsvc.yml
2. 将行 wgserver.systeminfo.allow_referrer_ips: <IP address or
name> 添加到 tabsvc. yml，其中 <IP address or name> 是要添加的计算机的
IPv4 地址或计算机名称。如果要授予对多台计算机的服务状态访问权限，请使
用逗号 无空格 分隔每个条目。 例如：
- 121 -
3. 保存并关闭 tabsvc.yml。
4. 以管理员身份打开命令提示符，然后键入：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
5. 然后，使用以下命令重新启动 Tableau Server 进程：
tabadmin restart
现在，其 IP 地址或计算机名称已添加到 tabsvc.yml 的计算机的用户可查看
Tableau 进程状态，方法是在浏览器中或从命令行输入 URL
http://<server>/admin/systeminfo，例如 curl
http://jsmith/admin/systeminfo。 此功能也可作为自动远程监控过程的
一部分。
重新生成搜索索引
如果出于任何原因，搜索索引停止返回正确结果或缺少结果，则需要重新生成搜索
索引。另外，如果索引器长时间无反应，也应重新生成索引。
- 122 -
1. 要重新生成搜索索引，请单击“管理”选项卡上的“维护”：
2. 单击重新生成搜索索引开始生成。
清除保存的数据连接密码
作为管理员，如果您启用了保存的密码设置，那么服务器的用户就可以保存数据源
密码以供多次访问和通过多个浏览器使用。您可以重置所有 Tableau Server 用户的所
有密码，这样，当用户下次访问需要进行数据库身份验证的视图时，会强制登录到
数据源。服务器用户也可以通过用户首选项页单独删除保存的数据连接密码。
要清除为所有服务器用户保存的数据连接密码，请执行以下操作：
- 123 -
1. 单击页面左侧“管理”部分中的“维护”链接：
2. 在“活动”下，单击清除为所有用户保存的数据连接密码。
在 “维 护 ”页 面 上 对 日 志 进 行 存 档
快照
您可以从 Web 浏览器生成并下载 Tableau Server 日志文件的快照 存档 ，而无需打
开命令提示符。这种压缩的快照包含 Tableau Server 和任何工作服务器 如果您具有
分布式环境 中的最多七天的日志文件数据的副本。快照过程不会更改或删除
Tableau Server 日志文件或使用 tabadmin 创建的日志存档。
注意：若要指定要收集的数据量或要创建的 zip 文件的名称，请使用 tabadmin
创建服务器日志的存档。有关详细信息，请参见对日志文件进行存档 在本页
341。
生成服务器日志文件的快照：
- 124 -
1. 在“管理”选项卡上，单击“维护”：
2. 在“活动”下，单击“生成并下载日志文件的快照”以打开快照选项：
3. 单击“生成快照”以创建 Tableau Server 日志的快照。仅当没有现有快照时，“生
成快照”按钮才可用。
使用 tabadmin 创建的日志存档不影响此选项的可用性。
4. 单击“下载快照”将日志快照下载到您的 Web 浏览器的默认下载位置。此选项在
您创建快照后可用。
Google Chrome 在窗口底部向您显示下载：
- 125 -
5. 单击箭头，然后单击“打开”以解压缩快照，或单击“在文件夹中显示”以查看它
的下载位置：
6.
可选 单击“删除快照”可删除日志快照。此选项在您创建快照后可用。您需
要删除现有快照，然后才能创建新快照。
例如，您可能需要删除在要调查的事件之前创建的快照。
- 126 -
维护设置
服务器上“维护”页面的“设置”部分中提供了以下设置：
设
置
嵌
入
式
凭
据
计
划
保
存
的
密
码
启
用
来
宾
默
认
开
始
页
面
默
认
语
言
和
区
域
将
所
有
设
置
重
说明
允许发布者为发布的工作簿附加密码，从而自动对 Web 用户进行身份验证以
连接至数据源。密码附加至工作簿，只能在服务器上进行访问。也就是说，
在 Tableau Desktop 中打开工作簿时，用户仍需要输入用户名和密码才能连接
至数据源。如果关闭此设置，将保存所有现有的嵌入式密码，但不会使用这
些密码进行身份验证。这样，如果再次启用该设置，用户不必重新嵌入密
码。
允许发布者为计划分配工作簿。只有在启用“嵌入式凭据”的情况下，此选项才
可用。如果启用此设置，发布者将在“发布”对话框中看到计划选项。
允许用户在多次访问和多个浏览器中保存数据源密码。默认情况下，用户可
以选择“在退出前记住我的密码”，这样，用户可以在单个浏览器会话期间保存
其密码。如果选中“保存的密码”设置，用户还可以选择“记住我的密码”，这
样，可以保存密码供多次访问和多个浏览器使用，且无论用户使用哪台计算
机，都会自动通过身份验证。管理员可以随时清除所有保存的密码。另外，
用户还可清除自己保存的密码。
允许用户查看嵌入式视图并与其交互，而无需登录到 Tableau Server 帐户。可
以向“来宾用户”帐户分配权限以控制每个视图可具有的交互性。只有拥有基于
内核的服务器许可证时，此选项才可用。此选项可与“启用自动登录”这个可在
安装过程中选择的选项结合使用。
将您转至服务器所有用户当前的默认开始页面。有关更改方法的步骤，请参
见为所有用户设置默认开始页面 下一页。单个用户可覆盖此设置 有关详细
信息，请参见“用户首选项”页面 在本页 70 。
控制服务器用户界面所使用的语言和视图所使用的区域。各用户可在用户首
选项页面上覆盖此设置。另外，在确定使用哪种语言和区域设置时，Web 浏
览器设置的优先级最高。有关更多信息，请参见语言和区域设置 在本页 142。
安装后更改的所有服务器设置都返回为其原始状态。
- 127 -
置
为
其
默
认
值
为所有用户设置默认开始页面
默认情况下，Tableau Server 安装时将“视图”页面作为所有用户的默认开始页面。作
为系统管理员，您可将此页面更改为所有用户都可访问的其他页面，例如“工作簿”页
面。用户可以覆盖您的设置 有关详细信息，请访问“用户首选项”页面 在本页 70页
面 。
要为所有用户设置默认开始页面，请执行以下操作：
1. 导航到要作为默认页面的网页。
2. 在页面右上角单击您的名称。
3. 选中将此页作为所有用户的开始页面。
Tableau Server Monitor
Tableau Server Monitor 是作为 Tableau Server 的一部分安装的，可通过 Windows 系统
任务栏进行访问。
- 128 -
使用此工具，可以启动和停止服务器、启动 Tableau Server 并显示服务器状态。
打开服务器
此命令可在 Web 浏览器中启动 Tableau Server。这是一种访问 Web 应用程序和关联的
维护工具的方便方法。
启动/停止服务器
可使用这些命令启动和停止服务器。在停止服务器时，所有用户都无法使用服务
器，当前正在进行的所有会话都将中断。如果服务器停止时有人正在发布工作簿，
则发布过程无效。因此，工作簿中只有部分工作表发布到了服务器。停止服务器可
能会对用户造成很大影响，因此在执行此操作前，请务必向用户发出警告或将维护
工作安排在非工作时间。
重新启动服务器
此命令将重新启动服务器。在服务器重新启动时，所有用户都将无法使用服务器。
在执行此操作前，请务必向用户警告将中断运行。如果对 Tableau Server 配置进行了
更改，则需要重新启动服务器。
显示状态
此命令将打开一个包含每个进程的状态的屏幕提示。要了解更详细的状态信息，请
访问维护页面。
管理产品密钥
此命令将打开产品密钥管理器，您可在其中添加或删除产品密钥。
退出
此命令将关闭 Tableau Server Monitor。但不会停止 Tableau Server。通过在
Windows“开始”菜单上选择“所有程序”>“Tableau Server 8.2”>“Tableau Server
Monitor”，可以重新打开该应用程序。
数据源
Tableau Server 数据源是一种可重用的数据连接。它可包含数据提取或与实时关系数
据库直通连接有关的信息。它还可包括一个自定义层，例如计算、组或集。 多维
数据集数据源具有特定限制。有关详细信息，请参见多维 多维数据集 数据源 在
本页 132。
Tableau Server 数据源在 Tableau Desktop 中创建，然后发布到服务器。有关如何创
建、下载和编辑 Tableau Server 数据源的详细信息，请参见 Tableau Desktop 帮助。
在发布数据源后，拥有相应权限的 Tableau Server 用户可以使用数据源在服务器上从
头创建工作簿。 有关详细信息，请参见创建工作簿和构建视图 在本页 153。
管理员可以使用 Tableau Server 数据源执行以下任务：
- 129 -
l
l
编辑和查看数据源权限：使用权限来指定哪些用户或组可以连接到数据源、修
改和下载数据源。有关更多信息，请参见设置数据源的权限。
计划用于刷新的数据源数据提取：如果数据源中包含数据提取，则可以将该数
据提取分配给刷新计划。 有关更多信息，请参见计划任务。
虽然上述任务还可由发布数据源的人员在 Tableau Desktop 中执行，但通常最佳做法
是由管理员在服务器上来管理这些任务。管理员还可删除数据源或向其添加标记。
管理数据源
使用 Tableau Server 数据源的用户需要有该数据源的相应权限。对于作为代理连接的
数据源，您还应知道如何向数据库对用户进行身份验证，以及您是否在 Tableau
Server 上安装了相应驱动程序。有关更多信息，请参见以下主题。
设置数据源的权限 在本页 175
数据库驱动程序 在本页 38
数据安全 在本页 202
关 于 Tableau Data Server
Tableau Data Server 是一个可用来集中管理和存储 Tableau Server 数据源的服务器组
件。 数据源是一种可重用的数据连接。数据可以位于 Tableau 的数据引擎中 作为数
据提取 或位于实时关系数据库中。对于关系数据库连接，存储在数据源中的信息
用于直通连接。数据源还可包含在 Tableau Desktop 中的字段级别进行的自定义，例
如计算、维度别名、组或集。
对于管理员，使用 Tableau Server 数据源有许多优点。因为一个数据源数据提取可由
许多工作簿使用，因此可以节省服务器空间和处理时间。可以针对每个数据提取
而不是每个工作簿 来计划数据提取刷新，并且当下载使用 Tableau Server 数据源
的工作簿时，数据提取将保留在服务器上，从而减少网络流量。最后，如果连接时
需要使用数据库驱动程序，则只需在 Tableau Server 上安装一次驱动程序，而不是在
所有用户的桌面上进行多次安装。
若要使用 Data Server，作者只需要通过创建数据提取或与实时关系数据库的连接来
连接到 Tableau Desktop 中的数据，并将其发布到 Tableau Server。发布后，这些可重
用的数据源以及服务器包含工作簿作者快速连接到数据并开始制作所需的所有内
容。要更改已发布的数据源，请将其下载至 Tableau Desktop，作出更改，然后发
布，同时覆盖原始数据源。请注意，您添加到参数的任何新成员或您对默认排序作
出的任何更改都不是数据源的部分 而是工作簿的部分 。
如果您正在运行分布式安装的 Tableau Server 并预计数据源会被大量使用，则可通过
多种方式来优化服务器部署。有关更多信息，请参见分布式环境 在本页 34。
注意：要使用已发布的多维 多维数据集 数据源，您必须将其下载到
Tableau Desktop，因此上述许多优点不适用。有关详细信息，请参见多维
维数据集 数据源 在本页 132。
- 130 -
多
使用数据源
如果您是工作簿作者，则可以使用 Tableau Server 数据源来创建新工作簿或编辑现有
工作簿。可以从 Tableau Desktop 或 Tableau Server Web 创作环境使用数据源。
从 Tableau Desktop 使 用 数 据 源
在 Tableau Desktop 中的“连接到数据”页面上，单击“Tableau Server”，然后提供您的
凭据：
登录到 Tableau Server 后，可供使用的数据源在右侧列出。
注意：有关特定于多维数据集数据源的注意事项，请参见多维
数据源 下一页。
多维数据集
若要查看数据源，发布该数据源的人必须为作为用户的您将“连接”权限设置为“允
许”。默认情况下，所有用户都拥有此权限。
- 131 -
选择要使用的数据源。数据源将在工作簿的数据窗口中加载。Tableau Server 数据源
具有一个 Tableau 图标而不是数据库图标：
在 Web 创 作 环 境 中 使 用 数 据 源
登录到 Tableau Server 后，在左侧导航栏中，选择“数据源”。如果您是管理员，该选
项位于“内容”选项卡上。
在数据源列表中，选中要使用的数据源旁边的复选框，然后选择“新建工作簿”。
有关详细信息，请参见创建工作簿和构建视图 在本页 153。
有关从 Tableau Desktop 发布数据源的详细信息，请参见 Tableau Desktop 帮助中的发
布数据源。
多维
多维
多维数据集
多维数据集
数据源
数据源的某些特征使其在 Tableau 中独一无二。
多维数据集数据源不支持直通连接。这意味着在发布多维数据集数据源后，您不能
使用该数据源从 Tableau Server 建立连接。这还意味着您不能在 Tableau Server 中使
用该数据源创建工作簿。
通过将多维数据集数据源发布到 Tableau Server，您可以将该数据源存储在服务器
上。但是，要使用该数据源，您必须将其下载到 Tableau Desktop 并在本地使用它。
要下载已发布的数据源，您需要：
l
l
该数据源的“下载/另存到 Web”权限。有关更多信息，请参见使用权限 在本页
172和设置数据源的权限 在本页 175。
运行 Tableau Desktop 的计算机上安装了正确的驱动程序并打开了相应端口。
数据源疑难解答
对于使用 Tableau Server 数据源的用户，最多需要满足三个条件：
- 132 -
l
数据源的权限：任何连接到数据源的人员必须同时具有该数据源的“连接”和“查
看”权限。这同样适用于访问与数据源相连的视图的用户。任何人要发布和修
改数据源，都必须获得“发布”许可并具有“写入/另存为”和“下载/Web 另存为”的
权限。有关更多信息，请参见使用权限 在本页 172和设置数据源的权限 在本页
175。
必须下载多维 多维数据集 数据源并在 Tableau Desktop 中使用它们，因此它
们需要“下载/另存到 Web”权限。有关 Tableau 中的多维数据集的详细信息，请
参见多维 多维数据集 数据源 上一页。
l
l
能够通过数据库身份验证：您可通过多种方式连接到 Tableau 中的数据并控制
谁可以访问哪些数据。基本上，无论哪个实体要连接数据库，都必须能够通过
身份验证。该实体可以是执行数据提取刷新的 Tableau Server。该实体可以是连
接到数据源随后再连接到实时数据库的 Tableau Desktop 用户。该实体还可以是
要访问连接到实时数据库的视图的 Tableau Server 用户。若要了解这些选项的
更多信息，请参见数据安全 在本页 202。
数据库驱动程序：如果在 Tableau Desktop 中创建和发布数据源的人需要安装其
他数据库驱动程序，则您可能也需要在 Tableau Server 上安装这些驱动程序。
如果您正在运行分布式安装的 Tableau Server，例如，数据服务器进程在工作服
务器上运行，则必须在该工作服务器上和主服务器上安装任何需要的数据库驱
动程序。其他进程也需要驱动程序。有关更多信息，请参见数据库驱动程序 在
本页 38。
数据源错误消息
下面是工作簿作者和其他用户使用数据源和视图时可能遇到的一些错误：
访问此 Tableau Server 数据源的权限被拒绝：连接到数据源需要拥有“连接”权限。有
关更多信息，请参见使用权限 在本页 172和设置数据源的权限 在本页 175的权限。
未找到数据源： 如果已从 Tableau Server 中删除数据源，或者使用视图的用户的“连
接到数据”页面需要更新，则该用户可能会看到此错误。若要更新 Tableau Desktop 中
的“连接到数据”页面，请单击“刷新”图标：
无法连接到此 Tableau Server 数据源：如果数据源的连接信息已发生改变 例如，
由于数据库服务器名称已更改 ，则可能会出现此错误。检查该数据源的“数据连接”
信息并确认其设置正确。
- 133 -
无法列出 Tableau Server 数据源： 如果用户尝试访问 Tableau Server 数据源且
Tableau Server 和 Tableau Desktop 之间存在连接问题，则可能发生此错误。
无法连接到多维数据集数据源：要使用已发布的多维 多维数据集 数据源，您必
须下载该数据源并在 Tableau Desktop 中使用它。验证您是否拥有该数据源的“下载/另
存到 Web”权限。有关 Tableau 中的多维数据集的详细信息，请参见多维 多维数据
集 数据源 在本页 132。
数据连接
发布到 Tableau Server 的每个工作簿都包含一个或多个连接。这些连接列在“管理”选
项卡下的“数据连接”页面上：
数据连接与数据源之间的差异
数据连接与数据源的不同之处在于，每个连接都与一个工作簿相关联，并描述连接
到数据源所需的属性 例如，服务器名称、数据库名称等 。这意味着如果三个工
作簿连接到同一个数据源，则连接页面上将列出三个连接。
搜索数据连接
“数据连接”页面顶部的“搜索”区域可帮助您按数据库服务器名称、用户名、端口、一
般连接类型以及按是否为嵌入式数据库凭据来查找连接。若要使用此区域搜索连
接，请填写一个或多个区域并单击“搜索”：
- 134 -
我可以编辑哪些连接？
您可以编辑实时数据库连接以及需要由 Tableau Server 刷新的数据提取的连接信息。
例如，您可能有大量工作簿连接到特定数据库服务器上的数据库。如果服务器的名
称发生变化，您可以一起更新所有工作簿，以便它们引用新服务器名称。另一个示
例是某个工作簿使用特定用户名和密码连接到数据库的情况。您可以快速更新所有
工作簿以使用一组不同的凭据。
有关如何编辑数据连接的详细信息，请参见以下相关主题链接。
编辑数据连接
在“数据连接”页上，服务器管理员可以管理已发布工作簿的连接信息。在这里，您可
以更改连接类型以存储不同的用户帐户或数据源身份验证类型，或者移除嵌入式密
码并要求用户每次都登录。
例如，对于一些云端数据源，您可能希望连接使用预配置的 OAuth 访问令牌而非数
据库凭据。有关 OAuth 连接的信息，请参见保护云端数据源的凭据 在本页 255。
注意：如果您不是服务器管理员，但对数据源拥有编辑权限，则可以访问“数据
源”页上的数据连接设置。
- 135 -
1. 登录到含有要修改的数据连接的站点并单击“数据连接”以显示“数据连接”页。
2. 浏览连接列表或使用列表顶部的搜索筛选器来缩小结果范围。
可以按数据服务器名称和端口、连接类型以及数据库用户名搜索。还可以排除
或包括带有嵌入式密码的数据源。
键入到“服务器”和“数据库用户名”字段中的值将被视为正则表达式。
3. 选中要修改的连接对应的复选框，然后单击列表顶部的“编辑”链接。
- 136 -
4. 键入一个或多个连接属性的新值。
有关 Google 和 Salesforce.com 数据源的连接选项，请参见本主题后面的 Google
和 Salesforce.com 的身份验证选项 向下。
如果数据库或数据库驱动程序不支持通过 IP 地址进行连接，则为“服务器”输入
的值必须是数据库名称。当您单击“提交”时将更新“更改?”列中选择的所有属
性。如果您选中某属性的复选框并将“新值”字段留空，则该属性将为空。
5. 单击“提交”。
6. 刷新“数据连接”页
按 F5 或 Ctrl+R
以使更改生效。
Google 和 Salesforce.com 的身份验证选项
Google BigQuery、Google Analytics 和 Salesforce.com 提供了受保护的身份验证选项。
在选择此选项时，将通过 OAuth 访问令牌创建连接。数据库凭据无需存储在 Tableau
中，并且所有用户都通过此访问令牌进行连接，包括希望使用此连接创建或编辑工
作簿的 Tableau Desktop 用户。
有关 OAuth 过程的概述，请参见保护云端数据源的凭据 在本页 255。
Google 身 份 验 证 选 项
在编辑 Google BigQuery 或 Google Analytics 连接时，请在“编辑数据连接”对话框中选择
以下任一选项：
l
选择“Always access…”可通过指定的帐户进行身份验证，然后从列表中选择现
有帐户或选择“authenticate account now...”来添加新帐户。
- 137 -
在添加新帐户时，将显示 Google 登录页。在提供数据库凭据后，Google 会提示
您确认 Tableau 对数据的访问权限。单击“Accept”后，Google 会返回用于连接
到数据的访问令牌。
如果您创建 Google 数据源的数据提取，请选择这里的第一个选项，以便
可以计划刷新任务。
l
选择“Prompt users”要求用户通过自己的访问令牌进行连接或每次连接时都登
录。
Salesforce.com 身 份 验 证 选 项
在编辑 Salesforce.com 连接时，可以在“编辑数据连接”对话框中选择以下任一选项：
l
选择“Enable scheduled extract refreshes using...”可使用受保护的 OAuth 连接
并计划刷新任务，然后从列表中选择现有帐户或单击“authenticate account
now on Salesforce”来添加新帐户。
在添加新帐户时，将显示 Salesforce.com 登录页。在提供数据库凭据后，
Salesforce.com 会提示您确认 Tableau 对数据的访问权限。
当您允许 Tableau 访问时，Salesforce.com 会创建用于连接到数据的访问令牌。
l
选择“Embed a username and password”可使用传统身份验证方法。
l
选择“No scheduled refreshes”可要求用户每次连接时都登录 Salesforce.com。
- 138 -
监视进度
当您保存在“编辑数据连接”对话框中进行的更改时，该对话框将显示进度。如果关闭
该对话框，则修改将继续在后台运行，直至完成。Tableau Server 将进行尽可能多的
更改。将跳过任何错误，但不会妨碍其他更改。例如，如果您尝试更改服务器名称
并向多个连接添加密码，则服务器名称和工作簿上的密码都将更改。不过，因为您
无法向数据源添加密码，所以数据源的密码不会更改。
有关检查这些任务的进度的信息，请参见后台任务 在本页 147。
自定义服务器
您可以自定义 Tableau Server 的外观以使其符合自己公司或组的个性化需要。例如，
可以更改出现在屏幕提示和消息中的名称，并更改出现在大多数服务器页面上的徽
标。
您还可以自定义用户与服务器交互的方式。例如，您可以允许工作簿发布者嵌入自
己的数据源凭据，以便用户在单击与实时数据源连接的已发布视图时，可以立即访
问该视图，而不必首先提供自己的数据库凭据。
您还可以控制服务器用户界面所使用的语言和以及视图所使用的区域设置。
有关对 Tableau Server 进行自定义的更多信息，请参见以下主题：
更改名称或徽标
您可以自定义 Tableau Server 外观的以下方面：
更改名称
通过自定义出现在工具提示和消息中的名称，可以自定义 Tableau Server 的外观。例
如，如果将名称更改为 MyCo，服务器登录页上的文本将显示为“输入用于登录的
MyCo 用户名和密码”，主页导航图标的工具提示将显示“MyCo 主页”而不是“Tableau
Server 主页”：
每个服务器页面底部的版本信息仍列出 Tableau
及其许可方。保留所有权利 。
例如，©2013, Tableau Software, Inc.
如果您使用 Active Directory 进行身份验证，则无法自定义登录页上的公司名称。
若要更改出现在工具提示和消息中的名称，请执行以下操作：
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
- 139 -
2. 通过键入以下内容更改名称：
tabadmin customize name "new_name"
在上面的行中，将“new_name”替换为您希望在服务器上作为名称出现的文本。
示例：tabadmin customize name "Company Server"
3. 通过键入以下内容来重新启动服务器以使更改生效：
tabadmin restart
更改徽标
通过自定义出现在 Tableau Server 登录页面和大多数页面 例如“项目”页面、“工作簿”
页面和“维护”页面等 左侧一栏中的大徽标，可以自定义 Tableau Server 的外观。支
持的大徽标尺寸最大为 160 x 160 像素，通过运行 tabadmin customize logo 命令
实现。还可以自定义出现在每个工作簿和视图左上角的小徽标。支持的小徽标尺寸
最大为 32 x 32 像素，通过运行 tabadmin customize smalllogo 命令实现。
如果图像大于 160 x 160 像素 大图标 或 32 x 32 像素 小图标 ，则会先经过剪裁
再显示出来。您应使用 GIF、JPEG 或 PNG 格式的图像文件。出现在服务器的 Web 浏
览器选项卡上以及 URL 地址左侧的 Tableau 徽标无法更改。
- 140 -
更改徽标：
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
2. 通过键入以下内容将徽标更改为“大尺寸”徽标
32 x 32 像素 ：
小于 160 x 160 像素且大于等于
tabadmin customize logo "C:\My Pictures\logo.png"
如果您的徽标尺寸为 32 x 32 px 或更小，请使用以下命令：
tabadmin customize smalllogo "C:\My Pictures\logo.png"
3. 通过键入以下内容来重新启动服务器以使更改生效：
tabadmin restart
恢复默认名称或徽标
通过执行以下操作，可恢复 Tableau Server 的默认外观：
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
2. 通过键入以下内容更改徽标：
tabadmin customize <parameter> -d
在上面的行中，将 <parameter> 替换为要恢复的内容，即 name 或 logo。
3. 通过键入以下内容来重新启动服务器以使更改生效：
tabadmin restart
- 141 -
语言和区域设置
Tableau Server 已本地化为多种语言，提供语言和区域设置供您按用户 请参见“用户
首选项”页面 在本页 70 和在系统范围 请参见维护设置 在本页 127 进行配置。
“语言”设置用于控制用户界面 (UI) 项，如菜单和消息。“区域设置”设置用于控制视图
中的各项，如数字格式设置和货币。
默认设置
Tableau Server 在安装过程中获得其默认语言设置。如果宿主计算机设置为 Tableau
Server 支持的语言，则该计算机使用该语言执行安装。如果该语言不受支持，则
Tableau Server 使用英语执行安装。
如何确定语言和区域设置
用户的 Web 浏览器也会影响用户单击视图时的语言和区域设置显示。如果服务器用
户未在其“用户帐户”页面上指定“语言”设置，并且其 Web 浏览器设置为 Tableau
Server 支持的语言，则将使用该浏览器的语言，即使 Tableau Server 本身设置为其他
语言也是如此。
下面是一个示例：假设 Tableau Server 将系统范围的英语设置作为所有用户的“语
言”。服务器用户 Claude 未在其 Tableau Server“用户帐户”页面上指定语言。Claude 的
浏览器使用德语 德国 作为其语言/区域设置。
当 Claude 登录到 Tableau Server 时，服务器 UI 将用德语显示，当他单击视图 A 时，
数字和货币使用“德国”区域设置。如果 Claude 已将其用户帐户“语言”和“区域设置”设
置为法语 法国 ，则 UI 和视图将用法语显示。他的用户帐户设置将取代其 Web 浏
览器的设置，而这两种设置又优先于 Tableau Server 的系统范围设置。
需要注意的另一个设置是 Tableau Desktop 中的“区域设置”设置 “文件”>“工作簿区域
设置” 。此设置确定视图中数据的区域设置，例如列出哪种货币或如何对数字进行
格式设置。默认情况下，Tableau Desktop 中的“区域设置”设置为“自动”。不过，用户
可通过选择特定区域设置覆盖该设置。在上面的示例中，如果视图 A 的作者将“区域
设置”设置为“希腊语(希腊)”，则视图 A 中数据的某些方面将使用“希腊语(希腊)”区域
设置进行显示。
下面按优先顺序列出了 Tableau 用来确定语言和区域设置的设置：
1. 工作簿区域设置
在 Tableau Desktop 中设置
2. Tableau Server 用户帐户语言/区域设置
3. Web 浏览器语言/区域设置
4. Tableau Server 维护页面语言/区域设置
5. 宿主计算机的语言/区域设置
管理视图
Tableau Server 为管理员提供多个视图，以帮助监视 Tableau Server 中的活动。这些管
理视图位于“维护”页面的“分析”表中：
- 142 -
有关更多信息，请参见以下内容：
服务器活动
服务器活动管理视图提供过去 30 天内 Tableau Server 活动的快照。
在“阶段总视图”中，您可将鼠标悬停在图线上的任意一点，就会看到有关当天打开的
视图数量和其他信息的工具提示：
单击图线上的某一点可更新下方出现的条形图，以显示当天查看的工作簿以及查看
次数最多的人：
- 143 -
在“阶段总视图”中选择相应标记也能针对“24 小时总查看模式”进行筛选，从而显示
某一天的查看模式。如果未在阶段总视图中选择标记， 24 小时总查看模式会合计长
期综合视图中的数据并在 24 小时内持续显示结果，以便您能够全天查看典型模式。
用户活动
通过用户活动视图，可以帮助衡量所安装的 Tableau Server 的负荷如何，是否需要购
买更多许可证。具体而言，此视图显示登录 Tableau Server 的用户，来自何处，以及
他们上次与服务器交互的时间。
如果某个用户从多个浏览器登录，这也会显示出来。例如，如果某个用户从 Internet
Explorer 登录一次，从 Mozilla Firefox 登录一次，该用户的姓名会出现两次。但是如果
用户从 Mozilla Firefox 登录两次，该用户的姓名只会出现一次。
- 144 -
“当前活动”指用户在过去五分钟内与服务器交互。“最近活动”指用户在最近 5 分钟至
15 分钟处于活动状态。“空闲”指最近 15 分钟内用户没有活动。默认情况下，如果用
户在四个小时内没有活动，则将退出 Tableau Server。您可以使用 tabadmin 选项 名
为 tabadmin set 选项 在本页 324 来更改此设置。
在“详细用户活动”视图中，圆表示正在执行某个操作，例如登录或筛选视图。存在活
动的整个时间段会显示指示条。若需了解详细信息，将光标悬停于某个区域上就会
出现提示：
- 145 -
性能历史记录
使用“查看性能历史记录”可查看在服务器性能方面哪些视图开销最大。
有两种不同的请求与视图关联：初始加载请求，橙色；计算请求，蓝色。后者是使
Tableau Server 重新计算呈现给用户的内容的所有请求。这包括重新加载请求、在视
图中选择和筛选项目。 离群标记表示对服务器性能影响最大的请求：
- 146 -
后台任务
后台任务视图显示服务器运行的任务。最常见的任务是与用户动作关联的任务。默
认情况下，这些任务在“任务类型”下选择：
任务的状态可以是成功完成、错误、正在进行或挂起：
图标 说明
错误—服务器无法完成任务。
成功—服务器已完成任务。
正在进行—服务器当前正在执行任务。
挂起—服务器尚未开始执行的任务。
- 147 -
若要查看任务的详细信息，请将鼠标悬停在其图标上：
Tableau Server 可同时运行多个后台进程。 后台任务视图中后台 ID 下的 IP 地址显示
分配了哪些计算机来运行后台进程：
运行多个后台进程的多内核计算机的第一个进程以 <IP address>:0 的形式列出，
第二个进程以 <IP address>:1 的形式列出，依此类推。
空间使用情况
通过空间使用情况视图，可以确定哪些工作簿和数据源占用的服务器磁盘空间最
多。磁盘空间使用情况按用户、项目以及工作簿或数据源的大小显示，并舍入为最
接近的数字：
- 148 -
将光标移到任何大小条上可以显示使用情况详细信息：
您还可以访问工具提示中的链接。例如转至查看相关的用户详细信息或工作簿。
自定义视图
处理视图的人员可使用“记住我的更改”选项保存其自定义视图，发布者可允许或阻止
共享自定义视图。
自定义视图管理视图中列出了服务器中使用“记住我的更改”自定义的所有视图。它可
以用作视图常用度或重要性的指标：
- 149 -
创建自定义管理视图
除了服务器“维护”页面中可用的预制管理视图外，您还可以使用 Tableau Desktop 查询
和生成自己的服务器活动分析视图。Tableau Server 存储库设置有多个数据库视图供
您连接和查询。tabadmin 选项 auditing.enabled 用于控制 Tableau Server 是否要将历史
用户活动和其他信息收集到存储库中。该选项默认情况下处于启用状态。tabadmin 选
项 wgserver.audit_history_expiration_days 用于控制事件历史记录将在存储库中保存多
久。默认情况下设置为 183 天。有一点需要注意，收集历史事件会影响 Tableau
Server 备份文件 (.tsbak) 的大小。
如果要访问这些视图，您必须首先使用命令行工具启用对 Tableau Server 数据库的外
部访问。然后，需要连接并在 Tableau Server 数据库中查询。
启 用 对 Tableau Server 数 据 库 的 外 部 访 问
Tableau Server 存储库设置有多个数据库视图供您连接和查询，这是生成自己的
Tableau Server 活动分析视图的一部分。如果要访问这些视图，您必须首先使用
tabadmin 命令行实用工具启用对数据库的外部访问。
1. 以管理员身份打开命令提示符，然后键入：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
2. 接下来，使用以下命令启用用户“tableau” 对数据库的外部访问，并指定密码。
tabadmin dbpass [password]
用您自己的密码替换 [password] 选项。例如：
tabadmin dbpass P@ssw0rD!
3. 重新启动 Tableau Server。
- 150 -
启用对数据库的外部访问后，只要提供了正确的密码，Tableau 就允许任何 IP 地址访
问数据库。按照连接 Tableau Server 数据库 向下中的步骤进行连接。
以后若要禁用外部访问，请运行 tabadmin dbpass --disable，然后重新启动服
务器。
连 接 Tableau Server 数 据 库
启用对 Tableau Server 数据库的外部访问后，按照以下步骤连接并查询数据库。
1. 在 Tableau Desktop 中，选择“数据”>“连接数据”，然后选择“PostgreSQL”作为
要连接的数据库。您可能需要安装 PostgreSQL 数据库驱动程序。可从
www.tableausoftware.com/drivers 下载驱动程序。
2. 在“PostgreSQL 连接”对话框中，键入 Tableau Server 的名称或 URL。如果您拥有
分布式服务器安装，并且用一个工作软件来承载存储库，请输入该工作软件的
名称。
应使用为 pgsql.port 设置的端口 默认情况下为 8060
更多信息，请参见TCP/IP 端口 在本页 284。
进行连接。有关端口的
3. 键入 workgroup 作为要连接的数据库。
4. 使用以下用户名和密码连接：
用户名：tableau
密码：您在启用 Tableau Server 数据库访问时指定的密码。
5. 单击“连接”。
6. 选择要连接的一个或多个表。“tableau”用户可以访问所有以下划线和 hist_ 开头
的表。例如，可连接到 _background_tasks 和 _datasources。以 historical_ 开
头的表指向 hist_ 表。hist_ 表包含有关用户活动 在本页 144视图中当前未呈现
的服务器用户的信息。
- 151 -
7. 单击“确定”。
编辑和创建视图
拥有 Web 制作环境的相应权限的用户可以编辑现有工作簿或创建新工作簿。
登录 Tableau Server 时，默认情况下显示“视图”部分。您有权访问的视图在这里显示
为以下过程之一的结果：
l
l
Tableau Desktop 用户将包含该视图的工作簿发布到 Tableau Server。
用户创建该视图，并将工作簿直接保存在 Tableau Server Web 编辑环境中。
- 152 -
创建工作簿和构建视图
您可以通过在现有工作簿中创建新工作表或创建新工作簿的方式构建新视图。本主
题介绍如何在新工作簿中构建视图。
以下过程使用 Tableau Desktop 附带且发布到 Tableau Server 的 Superstore 示例数据源
来构建视图，该视图合并了有关按类别和区域分类的销售情况的信息。如果您有权
访问 Superstore 示例数据源，则可以执行以下过程中的步骤。
1. 在“内容”选项卡上，选择“数据源”。
2. 在数据源列表中，选中要显示的数据源旁边的复选框，然后选择“新建工作
簿”。
将在 Tableau Server 创作环境中打开一个新的空白视图。
注意： 如果数据源用于基于多维数据集的数据库，则“新建工作簿”选项
不可用。有关详细信息，请参见多维 多维数据集 数据源 在本页 132。
3. 从“度量”窗格中，将“Sales”拖到“列”功能区。
- 153 -
4. 从“维度”窗格中，展开“产品”以显示其子类别，然后将“类别”拖动到“行”功能
区。
- 154 -
Tableau 现在有足够的信息将数据转换为可视化项
条形图。
视图
，此处为一个水平
5. 从“维度”窗格中，将“区域”拖到“行”功能区。
视图现包含另一层级的数据，即按地区细分的类别。
现在假定您需要按类别查看和比较单个区域中的销售额。您可使用筛选器实现
这一目的。
6. 从“维度”窗格中，将“区域”拖到“筛选器”功能区。
当您将鼠标悬停在“筛选器”功能区上时，字段左侧会出现一个小三角，指示您
可以将“区域”拖到功能区上。
“筛选器”控件将出现在页面右侧边缘。
- 155 -
7. 除要分析的区域外，清除所有其他项的复选框，然后再次选中它们。
8. 您可以使用颜色优化可视项的显示。将“区域”拖到“标记”卡上的“颜色”中。
现在，这一实用的视图可让您比较各地区不同产品类别的销售额：
提示： 若要了解为条形图选择不同调色板或调整其大小的信息，请参见
“标记”卡 在本页 166。
9. 您可能更希望使用让您能够更轻松地分析某个区域的整体产品销售额的视图，
- 156 -
而不是侧重于每种产品的区域销售额。在“行”功能区上，将“区域”拖到“类别”的
左侧。
视图会刷新，以便按区域显示所有产品的销售额。
10. 如果决定使用前一种视图，可单击工具栏中的“撤消”。
11. 如果要创建第二个工作表，请选择视图底部的“新建工作表”选项卡。
选择工作表标签，然后选择“重命名工作表”为其提供更具描述性的名称。
- 157 -
12. 单击“保存”以保存工作簿。在“保存工作簿”对话框中，完成以下步骤：
l 指定工作簿名称，并将“项目”保留为“Default”。
l 如果创建了多个工作表，并且希望其标签显示在视图的底部，请选择“将
工作表显示为标签”。
l 如果您希望没有数据库帐户的用户也能看到视图，请选中“嵌入数据源的
密码”。
l 完成后，单击“保存”。
编辑视图
在“视图”部分，可通过下列方式之一打开要编辑的视图：
l
l
单击工具提示中的“编辑”，将指针悬停在缩略图视图上时将会出现该工具提
示。
选择一个视图以显示它，然后单击视图上方的“编辑”。
- 158 -
如果工作簿发布者未嵌入数据库凭据，系统会提示您提供凭据。
保存或放弃更改
编辑视图时，可随时使用视图区域上方的链接来保存或放弃更改。
保存所做工作后，即使是从单个视图进入创作环境，也会保存整个工作簿，包括您
可能已编辑或未编辑的其他视图。
l
“保存”会覆盖原始工作簿。
l
“另存为”会在同一项目中创建新工作簿。
如果要同时保留视图的原始版本和已编辑版本，请使用“另存为”创建新工作
簿。
如果选择“将工作表显示为标签”，则工作簿权限会覆盖工作簿中单个视图上的
权限，直到在不带标签的情况下再次保存该工作簿。
l
“恢复”会放弃编辑并返回到最新保存的工作簿版本。
l
“完成”会退出创作环境。
如果您未保存更改，系统会提示您进行保存。如果您选择不保存更改，那么当
您返回到视图的创作模式时，未保存的更改仍会显示出来，只要您仍然登录到
当前服务器会话。
可保存工作簿的方式取决于管理员授予您的权限。有关更多信息，请参见示例：授
予编辑和保存权限 在本页 192。
- 159 -
Tableau Server 制 作 环 境
Web 制作环境与 Tableau Desktop 类似。左侧是数据窗口，其中显示工作簿中包含的
数据源的名称，以及当前数据源中包含的字段、参数和集。
同样，主区域的顶部是工具栏，视图的左侧是“标记”卡以及“页面”和“筛选器”功能
区，视图的上方是“列”和“行”功能区。工作簿中包含的任何工作表标签都显示在视图
的底部。
- 160 -
打开要编辑的视图后，可以编辑同一工作簿中的其他视图，但不能编辑仪表板或故
事。还可以选择“新建工作表”选项卡开始创建新视图。
工具栏
编辑视图时，可使用视图顶部的工具栏执行常见操作。
撤 消 /重 做
撤消和重做一个动作或一系列动作，次数不限。可通过选择这些工具栏按钮撤消或
重做视图中几乎所有类型的更改。
暂停更新
将字段置于功能区上时，Tableau 会通过查询数据源来生成视图。如果在编辑视图时
更新似乎很慢，则可以在进行一系列编辑时暂停更新，然后重新打开它们。
交换
这会交换“行”功能区和“列”功能区上的字段。最常用于基于 x 轴和 y 轴的视图类型。
合计
您可以自动计算视图中数据的总计和小计。选择“合计”可查看四个选项：
- 161 -
l
l
l
l
显示列总计：添加一行，显示视图中所有列的总计。
显示行总计：添加一列，显示视图中所有行的总计。
添加所有小计：如果在一列或一行中有多个维度度，则在视图中插入小计行和
列。
移除所有小计：移除小计行或列。
显 示 /隐 藏 标 签
选择以显示或隐藏视图中的标记标签。
视图大小
使用“视图大小”下的选项可更改浏览器窗口中视图的比例，并且可在查看详细信息和
查看概要信息之间切换。“单元格大小”命令具有不同的影响，具体取决于可视化类
型。
工作表
包含在工作表级别进行更改的选项。创建工作表、修改工作表名称、清除工作表格
式设置或清除整个工作表。
导出
使用“导出”下的选项可捕获视图部分以用在其他应用程序中。
l
l
l
l
图像：在新的浏览器标签中将视图、仪表板或故事显示为图像。
数据：在新浏览器窗口中使用两个选项卡显示视图中的数据：摘要 显示视图
中所显示的字段的聚合数据 和基础 显示可视化项中所选标记的基础数
据 。如果新窗口未打开，则您可能需要禁用浏览器的弹出窗口阻止程序。
交叉表：将可视化项中所选标记的基础数据保存为 CSV 逗号分隔值 文件，
然后可在 Microsoft Excel 中打开该文件。
PDF：在新的浏览器窗口中将当前视图作为 PDF 打开。从该窗口中，您可以将
视图保存为文件。如果新窗口未打开，则您可能需要禁用浏览器的弹出窗口阻
止程序。
向我显示
打开一个显示可在 Tableau 中使用的一系列可视化类型的控件。显示“智能显示”列表
时，Tableau 使用当前视图中的数据确定可供您选择的可视化类型。在可用类型中，
Tableau 在其确定为最适合您的数据的类型周围绘制不同的彩色轮廓。
还可将鼠标悬停在可视化类型上，以查看需要哪些字段类型才能使可视化类型可
用。
数据窗口
数据窗口的顶部是工作簿的可用数据源的列表。如果要编辑现有工作簿，则可能存
在多个数据源。选择某个数据源可查看该数据源的维度和度量。如果要创建新工作
簿，则您只会看到从中创建工作簿的数据源。
所有数据源都包含字段。这些字段出现在数据窗口中的数据源列表下方。维度和度
量始终显示，其他字段类型如果存在于数据源中则会显示：
- 162 -
l
l
l
l
“维度”是包含离散定性数据的字段。维度的例子包括日期、客户名称和客户
群。
度量是包含可以聚合的数字数据的字段。度量的示例包括销售额、利润、员工
数、温度、频率和压力。
“集”是根据某些条件定义数据子集的自定义字段。集可能基于计算条件 随数
据更改而进行更新 或基于固定值列表。集可以放在所编辑的工作簿中，但您
不能在其中创建集。
“参数”是可在计算、筛选器和参考线中替换常量值的动态值。参数可以放在所
编辑的工作簿中，但您不能创建参数。
若要生成可视化内容，请将数据窗口中的字段拖到“行”和“列”功能区、标记卡或其他
某个可用功能区中。要查看演示，请参见创建工作簿和构建视图 在本页 153。
“列”和“行”功能区
将字段拖到“列”功能区可创建表列，拖到“行”功能区可创建表行。可以将多个字段拖
到任一功能区。
离散值 通常为维度
示为绿色。
在“列”和“行”功能区上显示为蓝色；连续值
通常为度量
显
您在“列”或“行”功能区上放置的任何字段的右端都有下拉菜单，您可以使用该下拉菜
单来配置维度或度量：
可用选项取决于字段类型。完整的选项列表包含：
l
包含在工具提示中
- 163 -
默认情况下，“列”和“行”功能区上的所有字段都包括在当您将鼠标移到视图中的
一个或多个标记之上时出现的工具提示中。取消选中该选项可从工具提示中移
除字段。
l
显示筛选器
选择此选项可将用于此字段的筛选器添加到视图中。然后，用户可以指定要为
此维度或度量包含和排除的数据。
l
离散/连续
使用这些选项可实现一个连续范围内的值和一组离散值间的来回转换。
l
维度/属性/度量
使用此选项范围可来回转换维度与度量。
还可以将选项定义为属性，如果组中所有行都只有单个值，则返回给定表达式
的值，否则显示星号 (*) 字符。会忽略 Null 值。
l
快速表计算
提供一组用于重新定义值标记含义的选项。
l
移除
从“列”或“行”功能区中移除值。
数据维度选项
一组附加选项可用于日期维度：
从上面的组中选择某个选项可将数据粒度定义为离散值。例如，如果选择月，您的
视图会将每个已指定月的数据汇总到全年数据中：
- 164 -
数据中恰好有十二个标记，一个标记代表一个月。“11 月”标记组合了 2008 年 11 月、
2009 年 11 月等的数据。
从下面的组中选择某个选项可将数据粒度定义为连续值。例如，如果选择“月”，则视
图将顺序显示可用月范围内的数据。
此处数据中有 48 个标记，每个标记代表自 2008 年 11 月以来的每个月。
- 165 -
“标记”卡
将字段拖到视图时，将使用标记来显示数据。每个标记都表示视图中所有维度的交
叉点。例如，在具有“Region”和“Year”维度的视图中，有一个表示这两个字段的每种
组合 “East 2011”、“East 2012”、“West 2011”、“West 2012”等 的标记。
可通过多种方式来显示标记，包括线、形状、条、地图等。您可以使用标记属性
如颜色、大小、形状、标签等 显示有关数据的其他信息。所使用的标记类型以
及标记属性由“标记”卡来控制。将字段拖到“标记”卡可显示更多数据。例如，下面显
示了与上面相同的视图，但这次“颜色”上包含“Profit”。通过此附加信息，可清楚地
看到 2010 年“Southern”地区未盈利。
可使用“标记”卡控制视图中的标记。使用下拉菜单可指定要显示的标记的类型。将字
段拖到“标记”卡并使用下拉控件向视图添加更多信息，并控制视图中的颜色、形状、
大小、标签和标记数。
标记类型
“标记”卡下拉菜单中提供标记类型。
- 166 -
标记属性
您可以控制视图中标记的颜色、大小、形状和其他属性。将字段拖到“标记”卡的属性
上以使用数据对标记进行编码。
标记类型不同，可用属性也不同。例如，只有“形状”标记类型可以使用“形状”属性，
而且只有“饼图”标记类型可使用“角度”属性。
以下是各种属性：
属性
颜色
说明
通过根据字段的值为数据视图中的标记分配不同的颜色对数据
进行编码。
定量 调色板适用于连续字段，如利润度量。 分类 调色板适用
于离散字段，如表示地理区域的字段。
通过选择“颜色”，然后使用调色板控件和滑块，可更改调色板
或透明度。
- 167 -
大小
根据维度中的成员分开标记，并为每个成员分配唯一大小。由
于大小具有固定的顺序 从小到大 ，因此分类大小最适合年
份或季度之类的有序数据。
若要更改视图中标记的整体大小，请选择“大小”，然后拖动滑
块。
标签/文本
通过为标记分配文本标签对数据进行编码。使用文本表时，此
属性称为“文本”，并显示与数据视图关联的数字。
若要显示或隐藏标记上的标签，请选择“标签”，然后选中或清
除相应的复选框。
- 168 -
详细信息
工具提示
路径
形状
当您将维度放在“行”或“列”功能区上时，分类成员就会创建表
标题。这些标题表示详细级别，因为它们将数据源行划分到特
定的类别之中。可以按成员名称标识每个类别。
使用“详细信息”属性可以根据维度的成员 详细级别 来分离
数据视图中的标记。但与使用“行”和“列”功能区不同的是，此
属性不会更改表结构。
将字段名称和值添加到每个标记的工具提示上。
您可以按照特定的绘制顺序连接标记，从而对数据进行编码。
使用度量或维度都可以对数据进行路径编码。将维度放在“路
径”上时，Tableau 会根据该维度中的成员连接标记。如果维度
为日期，则由日期顺序指定绘制顺序。如果维度包含客户名称
或产品类型等文本，则绘制顺序由数据源中的成员顺序指定。
将度量放在“路径”上时，Tableau 会根据该度量的值连接标记。
仅当从“标记”菜单中选择线或多边形标记类型时，“路径”属性
才可用。
根据维度中的成员分开标记，并为每个成员分配唯一形状。
“筛选器”功能区
使用“筛选器”功能区可以指定要为维度或度量包含和排除的数据。例如，您可能希望
对每个客户分区的利润进行分析，但希望只限于特定的装运容器和交货时间。通过
将 Container 维度放在“筛选器”功能区上，可以指定要包含的容器。同样，也可以将
Delivery Date 字段放在“筛选器”功能区上来定义要包含的交货时间。
将维度或度量拖到“筛选器”功能区时，Tableau 会自动在视图中插入一个筛选器控
件，用于选择要显示的值。例如：
对于维度，筛选器控件显示如上所示的离散值。对于度量，控件显示连续范围：
将鼠标悬停在筛选器控件标题右侧可指定要如何显示控件中的值：
- 169 -
“页面”功能区
将维度或度量拖到“页面”功能区可以将视图划分为一系列页面，使您可以更好地分析
特定字段对视图中其他数据的影响。将某个维度拖到“页面”功能区就像为该维度的每
个成员添加一个新行。将某个度量拖到“页面”功能区会自动将该度量转换为可划分为
各个页面的离散度量。
将维度或度量拖到“页面”功能区时，Tableau 会自动在视图中插入一个控件，让您可
以在视图中导航页面。例如：
通过以下任意方式，可以手动翻阅页面序列：
l
l
l
使用下拉菜单选择一个值。
使用下拉列表任意一侧的向前和向后按钮，一次浏览一个页面。
使用“页面”滑块快速在页面序列中向前和向后滚动。
选择“显示历史记录”显示前几页中的标记
除了当前页面的标记
工具提示
将光标放在视图中的某个标记上方可查看该标记的工具提示。
工具提示提供有关所选标记的维度和度量值的信息：
- 170 -
。
工具提示还提供以下选项：
l
仅保持
从视图中排除这一个标记之外的所有标记。
l
排除
只排除此标记。
l
组成员
选择回形针图标可从所选标记创建新组 即，维度 。通常，您会选择多个标
记，然后创建一个组。例如，如果维度 Region 的值是 North、South、East 和
West，则可以选择 South 和 West，然后从中创建一个组。
l
查看数据
选择表图标可打开新的浏览器窗口以显示以下两个选项卡：摘要
标记的数据 和基础 显示整个视图的数据 。
- 171 -
仅显示当前
使用权限
可以对 Tableau Server 上的视图、工作簿、项目和数据源执行的操作由许可级别
管理员指定 以及视图或数据源作者设置的权限来控制。
由
如果您拥有交互者许可级别，并且至少满足以下一个条件，就可以更改某一项的权
限：
l
您是工作簿或数据源的所有者
是您将工作簿或数据源发布到服务器上
l
您分配有“设置权限”的权限。
l
您分配有包含相关项的项目的“项目主管”权限。
l
您拥有“管理”权限。
有关更多信息，请参见以下主题：
如何确定权限
下图说明了如何评估权限。
- 172 -
。
如果工作簿配置为了以选项卡的形式显示工作表，那么所有视图都会继承工作
簿权限，即使在单个视图上指定了不同权限也是如此。
设置工作簿与视图的权限
请按照以下步骤设置工作簿或视图的权限。
1. 在显示一个或多个工作簿
图，然后单击权限：
视图
的页面上，单击选中一个或多个工作簿或视
2. 在“权限: 工作簿”或“权限: 视图”页面上单击“添加/修改权限”：
- 173 -
分配对内容的权限选项会针对工作簿显示，但不会对视图显示。
3. 在“添加/修改权限”窗口中，从左侧列表选择用户或组：
您可以对列表进行配置，以显示用户、组或同时显示两者。
4. 从角色下拉菜单中选择预定义角色，或在以下区域中指定单个权限。权限列表
和预定义角色稍有不同，具体取决于您是为工作簿还是视图设置权限。要查看
定义各种权限和权限应用项的表格，请参见权限参考 在本页 179。
以下是可用的工作簿和视图角色：
角色
查看者
应用对象 说明
工作簿
允许用户或组查看服务器上的工作簿或视图。
交互者
视图
工作簿
视图
编辑器
工作簿
数据源连接器
视图
视图
允许用户或组查看服务器上的工作簿或视图、
编辑工作簿视图、应用筛选器、查看基础数
据、导出图像和数据。其他所有权限都是从用
户或组的项目权限继承而来的。
向用户或组授予所有权限
允许用户或组连接到服务器上的数据源。在访
问与数据源连接的某个视图时，该权限与视图
相关。
- 174 -
数据源编辑器
视图
允许用户或组连接到服务器上的数据源。同样
允许发布、修改、下载、删除和设置数据源的
权限并为您发布的数据源安排刷新。在访问与
数据源连接的某个视图时，该权限与视图相
关。
5. 您可以为一个或多个用户和组配置权限，数量不限。完成后，单击提交。
设置数据源的权限
请按照以下步骤设置数据源的权限。
1. 在“数据源”页面上，单击选择一个或多个数据源，然后单击权限。
2. 在“权限: 数据源”页面上单击“添加/编辑权限”：
3. 在“添加/修改权限”窗口中，从左侧列表选择用户或组：
- 175 -
4. 从角色下拉菜单中选择预定义角色或在以下区域中指定单个权限。要查看定义
各种权限和权限应用项的表格，请参见权限参考 在本页 179。
以下是可用的数据源角色：
角色
数据源连接器
数据源编辑器
说明
允许用户或组连接到服务器上的数据源。
允许用户或组连接到服务器上的数据源。同样允许发
布、修改、下载、删除和设置数据源的权限并为您发布
的数据源安排刷新。
注意： 必须在本地使用多维数据集数据源，如 Microsoft Analysis Services
或 Oracle Essbase 连接的那些数据源。要将已发布的数据源下载到
Tableau Desktop，您需要“下载/另存到 Web”权限。您必须显式授予“下载/
另存到 Web”权限，因为数据源连接器角色不提供这些权限。有关详细信
息，请参见多维 多维数据集 数据源 在本页 132。
5. 您可以为一个或多个用户和组配置权限，数量不限。完成后，单击提交。
设置项目权限
管理员和项目主管可以指定项目权限。创建新项目时，具有与默认项目相同的权
限。您可以设置项目权限，以允许或拒绝授予单个用户或组访问该项目的权限。指
定项目权限：
1. 单击“管理”>“项目”。
2. 单击选中一个或多个项目，然后单击权限：
- 176 -
3. 在“权限: 项目”页面上单击“添加/修改权限”：
4. 在“添加/修改权限”窗口中，从左侧列表选择用户或组：
- 177 -
您可以对列表进行配置，以显示用户、组或同时显示两者。
5. 从角色下拉菜单中选择预定义角色，或在以下区域中指定单个权限。要查看定
义各种权限和权限应用项的表格，请参见权限参考 下一页。
以下是可用的项目角色：
角色
查看者
交互者
编辑器
数据源连接器
数据源编辑器
项目主管
发布者
说明
允许用户或组查看项目中的工作簿和视图。
允许用户或组查看项目中的工作簿和视图、编辑工作簿
视图、应用筛选器、查看基础数据、导出图像和数据。
向用户或组授予所有权限
允许用户或组连接到项目中的数据源。
允许用户或组连接到项目中的数据源。同样允许发布、
修改、下载、删除和设置数据源的权限并为您发布的数
据源安排刷新。在访问与数据源连接的某个视图时，该
权限与视图相关。
允许用户或组设置一个项目中所有项的权限。
向用户或组授予将工作簿发布到服务器所需的所有权
限。
- 178 -
指定的权限应用于该项目本身。对项目中包含的工作簿、视图和数据源设置的任何
明确权限都不受影响。不过，您可以选择将项目权限分配给该项目中包含的所有工
作簿、视图和数据源。在这种情况下，这些权限会覆盖工作簿和视图上的现有权
限。例如，假设有多个工作簿，每个工作簿都已使用自定义权限进行发布，并且您
将这些工作簿分组到一个具有新权限集的新项目中。您可通过单击“权限”页面上的分
配对内容的权限， 将新权限应用到每个工作簿中。
检查用户权限
可以随时查看用户对特定视图、工作簿、项目或数据源的权限。在您可设置权限的
任何页面上，从检查用户权限 下拉列表中选择一个用户。
显示的权限专用于您选中的视图、工作簿、数据源或项目。
权限参考
管理员和其他授权用户可以允许或拒绝用户获得在 Tableau Server 上执行某些动作的
权限。 在向 Tableau Server 发布工作簿或数据源时也可在 Tableau Desktop 中设置权
限。
管理员始终拥有对 Tableau Server 上所有资产的完全控制权限，而站点管理员拥有对
站点上所有资产的完全控制权限。如果您向 Tableau Server 发布了工作簿或数据源，
您就是这项资产的发布者并且拥有对该资产的完全控制权限。
下表显示了哪些权限应用于 Tableau Server 中的哪些项，并介绍了用户可利用每项权
限执行的操作。
- 179 -
权限
视图
影响...
工作簿
数据源
视图
Web 编辑
项目
工作簿
视图
项目
写入/另存 工作簿
到 Web
数据源
视图
项目
下载/另存 工作簿
到 Web
数据源
项目
删除
工作簿
允许时，用户可以...
查看 Tableau Server 中的项。访问某个与数据源连接的
视图的用户必须同时具有工作簿的“查看”权限和数据源
的“连接”权限。
编辑工作簿中的视图。请参见示例：授予编辑和保存
权限 在本页 192。
当您发布 Tableau Desktop 中的工作簿时，工作簿中的
工作表 视图 权限是从工作簿权限复制 覆盖 而
来的。当您单击“权限: 工作簿”页面上的“分配对内容的
权限”时，这些权限同样会被复制。在保存工作簿时，
如果您选择“将工作表显示为标签”，则工作簿权限会覆
盖其中所有的工作表 视图 权限，直到标签禁用为
止。
“所有用户”组的特殊注意事项：为了保护发布者的内容
不被其他用户覆盖 通过从 Tableau Desktop 发布或者
在 Tableau Server 上保存通过 Web 编辑的工作簿 ，默
认情况下，每当用户发布到“所有用户”组在其中拥有权
限的项目时，“所有用户”组的“写入/另存到 Web”权限
都会从“允许”更改为“继承”。您可以按照设置工作簿与
视图的权限 在本页 173中的步骤将其从“继承”更改为“允
许”来手动修改此权限。
覆盖服务器上的项。得到允许后，用户可以重新发布
Tableau Desktop 中的工作簿或数据源，从而成为发布者
并获得所有权限。随后，原始发布者对工作簿的访问
将由该用户的组权限以及新发布者决定设置的任何进
一步权限来确定。
此权限还确定了用户或组在服务器上编辑工作簿之后
可对其进行覆盖。请参见示例：授予编辑和保存权限
在本页 192。
得到允许后，用户可以从服务器下载项，还可以将编
辑过的工作簿另存为服务器上的新工作簿。请参见下
载工作簿 在本页 185和示例：授予编辑和保存权限 在
本页 192。
删除项。
数据源
视图
筛选器
项目
工作簿
视图
修改快速筛选器、只保留筛选器并排除数据。请参见
向视图添加注释 在本页 184。
- 180 -
权限
添加注释
影响...
项目
工作簿
允许时，用户可以...
向工作簿中的视图添加注释。
视图
查看注释
项目
工作簿
查看与工作簿中的视图相关的注释。
视图
查看摘要
数据
查看基础
数据
导出图像
项目
工作簿
视图
项目
工作簿
查看视图中或视图内用户选定内容中的聚合数据，并
将这些数据下载为文本文件。
视图
查看视图中每一行背后的原始数据 受用户所选标记
限制 ，以及将这些数据下载为文本文件。
项目
工作簿
以图像形式导出每个视图。请参见导出视图 向下。
视图
共享自定
义
移动
项目
工作簿
视图
项目
工作簿
使保存的视图自定义项可供他人查看。用户可以使用
Tableau Server 中的“记住我的更改”选项来创建自定义
视图。请参见自定义视图 在本页 149。
在项目之间移动工作簿。
视图
设置权限
项目
工作簿
数据源
指定对项操作的权限。对于工作簿，此权限会扩展至
工作簿中的视图。
视图
连接
项目
数据源
视图
项目主管
项目
项目
连接到数据源。访问某个与数据源连接的视图的用户
必须同时具有视图的“查看”权限和数据源的“连接”权
限。
为项目中的所有项目和项目本身设置权限。
导出视图
可通过图像或 PDF 的形式导出视图。或者，可将数据以交叉表或逗号分隔值文件
数据 的形式导出。在视图顶部工具栏上的“导出”菜单中选择一个选项。
- 181 -
如果将仪表板导出为 PDF 并且仪表板包括一个网页对象，PDF 中将不包含该网
页对象。此外，在选择导出选项时，必须生成图像、PDF 或数据文件。当生成
结束后会打开一条消息，这样您就可以继续下载文件。
将 视 图 导 出 为 PDF：
1. 打开视图并从“导出”工具栏中选择“PDF”按钮：
2. 选择“纵向”或“横向”和“纸张尺寸”：
3. 选择是打印整个工作簿、所选仪表板或故事还是只打印特定工作表。单击突出
显示的工作表缩略图可将其排除在导出范围之外：
- 182 -
4. 单击“确定”，然后在“导出 PDF”对话框中，单击“下载”。您的 PDF 将会显示并
且可供打印：
- 183 -
向视图添加注释
您可以向在 Tableau Server 上有权访问的任何视图添加注释。 还可以查看与特定视图
关联的任何注释。
在位于视图下面的“注释”文本框中键入文本，然后单击“添加”。
可通过插入超链接、粗体、斜体和下划线来向注释添加格式。下表提供了如何添加
其中每种格式的示例。
- 184 -
设置格式
超链接
加粗
斜体
下划线
键入的内容
“我的链接”：http://www.tableausoftware.com
*粗体文本*
_斜体文本_
+下划线文本+
示例
我的链接
粗体文本
斜体文本
下划线文本
下载工作簿
可以使用视图右上角的“下载”链接来下载工作簿。下载的工作簿可使用某个版本的
Tableau Desktop 打开。从服务器下载工作簿与在桌面应用程序中选择“服务器”>“打开
工作簿”效果相同。只有在工作簿仍发布到服务器的情况下才能将其打开。
只有当工作簿作者或管理员向您提供下载/另存到 Web 权限时，此选项才可用。有关
详细信息，请访问 使用权限 在本页 172。
刷新数据
如果更改了数据源，如添加了新字段或修改了数据值和字段名，则视图将在您下次
加载该页面时反映这些更改。不过，您可能需要使用工具栏上的“刷新数据”按钮来手
动更新视图。
- 185 -
刷新数据时，将会清除可能存在的任何缓存，并从数据源检索最新数据。此选项与
“暂停自动更新 向下”选项不同，后者仍会基于缓存的数据加载视图。根据数据源和视
图的大小，刷新数据所用的时间可能比操作缓存数据的查询所用的时间要长。
暂停自动更新
与服务器上的视图交互时，有时必须向数据源发送查询以更新视图中的数据。如果
所使用的视图具有大量数据或非常大的数据源，则自动更新可能需要很长时间。为
避免在进行多个更改时每次都等待更新，可以单击工具栏上的“暂停自动更新”。
使用同一工具栏按钮“继续自动更新”时，只需等待一次数据源查询即可。
保存密码
有时，视图会要求您输入数据库用户名和密码。如果您可以访问该数据库，就应在
相应的文本框中输入用户名和密码。如果选择“记住我的密码”选项，则每次查看该视
图时，您都会自动登录。登录信息将加密存储在服务器上，因此，即使在浏览器会
话之间切换以及从多台计算机访问该视图，您也会自动登录。这在您拥有始终要访
问的多个视图时非常方便。
注意：
管理员可以限制是否允许用户记住数据库密码。如果您是管理员，请参见维护设置
在本页 127以了解更多信息。
- 186 -
清除和重置保存的密码
如果您目前保存密码 在“维护”页面上启用“保存的密码” ，则可以清除保存的密
码。执行此操作后，下次访问该服务器时，系统就会提示您输入用户名和密码。如
果您的用户名和密码发生更改，可能就需要这样做，以便可以开始使用和保存新凭
据。
1. 从右上角的下拉菜单中打开“用户首选项”页面：
2. 在“保存的数据连接密码”下，单击“全部清除”。
管理员还可使用“维护”页面上的“清除所有用户的所有保存的密码”链接来清除
服务器上所有保存的密码。
保存自定义视图
在对视图进行筛选、排序和交互时，“记住我的更改”菜单或视图名称旁边会出现一个
灰色圆点。该圆点表示已进行更改。使用此菜单可将所做的更改保存为自定义视
图。
您或其他人创建的任何自定义视图将始终与原始视图相关。当更新或重新发布原始
视图时，也将更新该视图的自定义版本。如果从服务器删除原始视图，则也将删除
与其相关的自定义视图。如果从原始视图移除筛选器并重新发布该视图，则这些筛
- 187 -
选器在该视图的自定义版本中将不可用。如果恢复筛选器并重新发布该视图，则将
恢复该视图的自定义版本。
下面是有关如何保存自定义视图的更详细信息：
1. 打开要自定义的视图。
2. 筛选数据、更改排序顺序、突出显示、放大或缩小等。
单击“记住我的更改”链接或自定义视图的名称。然后键入自定义视图的名称并
单击“记住”。
3.
若要使自定义视图成为首次打开视图时默认显示的视图，请选择“将默认设置更改为
<自定义视图名称>”。自定义视图名称的右侧将显示 (默认值 ) 一词，表示此版本的视
图是默认视图。
- 188 -
共享视图
发布的每个视图和工作簿都可通过电子邮件进行共享或嵌入到其他网页、wiki 或 Web
应用程序中。查看共享视图的任何人都必须拥有 Tableau Server 帐户以及访问该视图
的权限。
通过电子邮件发送视图
通过单击视图左上角的“共享”链接，可以轻松地将链接通过电子邮件发送给视图。然
后复制提供的链接并将其粘贴到电子邮件中。
- 189 -
嵌入视图
通过将视图嵌入到其他网页 如您的 wiki、博客或 Web 应用程序 中，可以共享该
视图。单击视图左上角的“共享”链接，然后复制并粘贴提供的 HTML 代码。
- 190 -
调整嵌入视图的外观
通过调整“显示选项”，可以更改嵌入视图的外观。可以指定固定宽度、高度以及是否
显示工具栏或选项卡。
- 191 -
示例：授予编辑和保存权限
管理员总是可以编辑和保存现有工作簿或创建新工作簿。他们还可为其他用户和组
分配权限，以允许他们在服务器 Web 创作环境中编辑和保存工作簿中的视图，以及
对服务器执行其他操作。
设置用户许可和发布级别
管理员在创建或修改用户时会分配许可级别和用户权限。若要允许用户编辑工作
簿，请先按如下方式配置用户：
l
用户必须拥有 Interactor 许可级别。
l
必须向用户授予“发布”用户权限。
有关详细信息，请参见用户 在本页 57及许可和用户权限 在本页 74。
允许编辑和保存工作簿
设置用户或组，设置许可级别以及授予发布权限后，需要在项目和工作簿级别设置
权限，具体取决于要允许的编辑类型。在管理员可允许或拒绝用户和组拥有的任务
级别权限列表中，用于编辑和保存视图的主权限包括：
l
l
“Web 编辑”确定用户能否通过 Web 创作编辑工作簿视图。
“下载/Web 另存为”确定用户在编辑视图时是否可看到“保存”和“另存为”命令，
以及是否可将所做更改另存为新工作簿。还确定用户是否可使用 Tableau
Desktop 在服务器上打开工作簿。
- 192 -
l
“写入/Web 保存”确定用户是否可将更改保存到服务器上的现有工作簿
作簿 。
覆盖工
若要允许用户或组将更改保存到现有工作簿或新工作簿，请根据以下部分中的表设
置三个任务级别权限。
允许用户将更改保存到现有工作簿和新工作簿
权限
对项目
对项目中的相应工作簿
Web 编辑
下载/另存为
写入/保存
允许
允许
允许
允许
允许
允许
在此情形下，由于项目和工作簿的权限设置方式相同，如果要将项目级别的权
限更改应用于项目中的所有工作簿，则可在位于“权限: 项目”页时选择“分配对
内容的权限”。
允许用户保存新工作簿但不能覆盖现有工作簿
权限
Web 编辑
下载/另存为
写入/保存
对项目
允许
允许
允许
对项目中的相应工作簿
允许
允许
拒绝
重要信息： 在此情形下，必须对每个工作簿手动设置权限。如果选择“分配对
内容的权限” 如允许用户将更改保存到现有工作簿和新工作簿 向上中所
述 ，则项目权限将覆盖工作簿权限，因此会授予用户将更改保存到现有工作
簿的权限。
工作簿中视图的权限
用户从 Tableau Desktop 中发布工作簿时，工作簿中视图的权限是从工作簿权限继承
而来的。
如果在从 Tableau Desktop 中发布工作簿或将其保存到 Tableau Server 时用户选择“将
工作表显示为标签”，则工作簿权限会覆盖单个视图上的权限，直到在不带标签的情
况下再次保存该工作簿。
有关详细信息，请参见权限参考 在本页 179以及知识库文章创建基于项目的权限。
- 193 -
示 例 ： 禁 用 Web 制 作
如果您希望用户能够在 Tableau Server 上查看已发布工作簿但无法访问服务器制作环
境，您可以使用站点级设置禁用制作。
例如，您可能有一组精选的分析师使用 Tableau Desktop 生成和发布工作簿，以及一
组销售经理处理字段而并不使用 Tableau Desktop 或执行数据分析，但需要通过 Web
环境查看和共享已发布仪表板。
要禁用制作，请完成以下步骤。
1. 在 Web 浏览器中，以管理员身份登录服务器环境。
2. 在“管理”选项卡上，选择“站点”。
3. 在“站点”页上，选中您要对其禁用制作的复选框，然后单击“编辑”。
4. 在“编辑站点”对话框中，清除“允许对此网站进行 Web 制作”复选框，并单击“确
定”。
在“站点”页上，您可以确认 Web 制作已禁用。
- 194 -
5. 如果您的站点已在生产中，并且您希望更改立即生效，请重新启动服务器。
或者，您可以等待服务器会话缓存过期。如果用户在视图中看到一个“编辑”链
接，或者如果他们为视图的编辑模式输入该 URL，则直到它过期，用户才可能
拥有制作权限。例如，在他们打开视图进行编辑时将该 URL 标记为书签。
如果您在创建新站点时禁用 Web 制作，则不存在缓存的会话，且设置将立即生
效。
- 195 -
管理所有权
在 Tableau Server 上发布数据源或工作簿，或者创建项目时，您成为其所有者。所有
权可更改。例如，如果作为原来的所有者的员工离职，则管理员可以将所有权重新
分配给其他用户。在更改所有权后，原来的所有者将不具有与该项的特殊连接，并
且他们能否访问该项由他们的 Tableau Server 权限决定。
如果 Tableau Server 用户拥有任何项，则您将无法删除该用户。在您尝试删除
用户时，他们的许可级别将设置为“未许可”。您必须先更改项的所有权，然后
再删除用户。有关详细信息，请参见从 Tableau Server 删除用户。
您能否更改所有权或能否向您授予所有权取决于您的权限以及您与项的关系：
项类型
项目
工作簿和数据
源
谁可以更改所有权
系统管理员
可以向谁授予所有权
系统管理员
站点管理员
系统管理员
站点管理员
系统管理员
站点管理员
站点管理员
包含项的项目的项目主 包含项的站点的成员，具有“来宾”之外的许
管
可证
项的所有者
有关更多信息，请参见以下主题：
更改工作簿的所有者
默认情况下，工作簿的发布者就是其所有者。管理员、项目主管和工作簿的当前所
有者都可以更改工作簿的所有权。新所有者必须是系统管理员或站点管理员或者在
工作簿所在的同一站点上拥有“来宾”之外的许可级别。
更改工作簿的所有者：
1. 在“内容”选项卡上，选择“工作簿”。
2. 在“工作簿”页上，选择一个或多个工作簿，然后单击“更改所有者”：
- 196 -
3. 键入用户的名称或从列表中选择用户：
4. 单击“确定”更改所有者。
更改数据源的所有者
默认情况下，数据源的发布者就是其所有者。管理员、项目主管和当前数据源所有
者都可以更改其所有者。新所有者必须是系统或站点管理员或者在数据源所在的同
一站点上拥有“来宾”之外的许可级别。
更改数据源的所有者：
1. 在“内容”选项卡上，选择“数据源”。
2. 选择一个或多个数据源，然后单击“更改所有者”。
- 197 -
3. 键入用户的名称或从列表中选择用户：
4. 单击“确定”更改所有者。
更改项目的所有者
默认情况下，项目的创建者就是其所有者。管理员可以更改项目的所有者。新所有
者必须是系统管理员或项目站点的管理员。
更改项目的所有者：
1. 在“管理”选项卡上，选择“项目”。
2. 选择一个或多个项目，然后单击“更改所有者”：
- 198 -
3. 键入用户的名称或从列表中选择用户：
4. 单击“确定”更改所有者。
- 199 -
安全性
Tableau Server 中有四个主要安全组件：
身份验证
身份验证用于建立用户的身份。这是为了防止对 Tableau Server 进行未授权的访问，
并允许有个性化用户体验。Tableau Server 支持四种类型的身份验证：
l
Active Directory：基于 Tableau Server 用户的 Windows 凭据对其进行身份验
证。
l
本地身份验证：使用 Tableau Server 提供的内部身份验证机制。
l
SAML：使用外部身份提供程序 (IdP) 验证 Tableau Server 用户身份。
l
受信任的身份验证：通过 Tableau Server 与一个或多个 Web 服务器之间的信任
关系处理身份验证。
是使用 Active Directory 身份验证还是使用本地身份验证是在 Tableau Server 安装期间
选择的。安装之后，将无法在这两者间切换。若要切换身份验证类型，请卸载
Tableau Server 您的数据将被保留 并重新运行安装程序。
还可选择在安装过程中配置 SAML，但这并不是可配置它的唯一时机。当 SAML 处理
用户身份验证时，将使用 Active Directory 或本地身份验证来管理 而非验证 您的
Tableau Server 用户。无需卸载 Tableau Server 并重新运行安装程序，即可启用或禁用
SAML。
Active Directory
使用 Active Directory 进行身份验证时，所有用户名和密码都由 Active Directory 进行管
理。当用户输入凭据以登录 Tableau Server 时，Tableau 会将凭据传递给 Active
Directory 服务器。虽然该服务器在其存储库中存储用户名 但不存储密码 ，但它并
不参与身份验证过程。
通过 Active Directory 用户身份验证，管理员还可以基于用户的当前 Windows 凭据使用
户自动登录 启用自动登录 。这意味着用户凭据将从其本地计算机传递，而不是
从他们可能已登录的其他系统或门户传递。
例如，如果用户以“MSmith”身份登录其本地计算机，然后以“Mary”身份登录到一个
SharePoint 门户，则传递给 Tableau Server 的凭据将是“MSmith”的凭据。若要使用来自
SharePoint 站点的凭据 “Mary” 自动登录，SharePoint 门户必须使用采用受信任的
身份验证的 Tableau Web 部件。
管理员可以使用 tabcmd 以手动或编程方式将组与 Active Directory 同步。有关详细信
息，请参见同步 Active Directory 组 在本页 82和 tabcmd 命令 在本页 291中的
syncgroup group-name。
- 200 -
本地身份验证
使用本地身份验证进行用户身份验证时，Tableau Server 将管理用户、组、密码和整
个身份验证过程。可方便地将用户列表导入到 Tableau Server，并可通过 tabcmd 在
本页 289 以编程方式执行大多数用户管理功能。用户可通过在提示时输入其凭据来手
动登录，或在访问门户中的内容时，通过透明的受信任的身份验证来登录。
SAML
使用 SAML 进行用户身份验证时，外部身份提供程序 (IdP) 会验证 Tableau Server 用户
身份。您仍需使用 Active Directory 或本地身份验证来管理 Tableau Server 用户，将其
添加到 Tableau Server 等，但身份验证信息由 IdP 处理。当用户使用 SAML 登录
Tableau Server 时，他们看到的登录过程属于 IdP，而非 Tableau Server。 有关如何在
站点中设置 SAML 的信息，请参见 SAML 在本页 264。
受信任的身份验证
受信任的身份验证意味着您已在 Tableau Server 与一个或多个 Web 服务器之间建立受
信任的关系。例如，您可以使您的公司 wiki 使用受信任的身份验证来向登录到 wiki 的
员工显示仪表板，而无需其他登录。
当 Tableau Server 接收来自受信任 Web 服务器的请求时，它会假设该 Web 服务器已
处理必要的身份验证。Tableau Server 接收带有可兑现令牌或票证的请求，并向用户
显示考虑进用户的角色与权限的个性化视图。
有关如何在站点上设置受信任的身份验证的信息，请参见受信任的身份验证 在本页
246。
身份验证
身份验证就是用户通过身份验证后可访问什么内容和执行什么操作。在 Tableau 中，
身份验证是通过以下方式处理的：
l
l
角色和权限：定义用户对 Tableau 中的特定项目可以或不能执行的特定功能。
定义用户对 Tableau 中的特定项目可以或不能执行的特定功能。一个角色就是
管理员可以原样使用或进行自定义的一组权限。有关详细信息，请参见 使用权
限 在本页 172。
许可和用户权限：控制用户可拥有的最大权限集。控制用户可拥有的最大权限
集。请参见许可和用户权限 在本页 74许可和用户权限 在本页 74和允许或拒绝
用户权限 在本页 78。
上面的项用于控制用户能够执行的动作和执行对象，但它们不控制视图中显示哪些
数据。用户看到的数据由您的数据安全选择控制。
初始权限
项目的初始权限是从默认项目复制而来的。工作簿的初始权限是从其项目权限复制
而来的。视图的初始权限是从其工作簿权限复制而来的。这是对父级权限的一次性
- 201 -
复制。对父级权限的更改不会自动应用于子级，除非将新权限主动分配给这些内
容。
任何项都可以具有不同于父级的权限。例如，一个组可能没有查看项目 X 的权限，
但该组有权查看发布到项目 X 的视图。Tableau Server 不支持分层项目权限；但它为
用户和组提供了一个继承模型。如果用户没有将某一权限明确设置为“允许”或“拒
绝”，则将从该用户所属的组继承相应设置。
权限和默认项目
如果 Tableau Server 部署在知识和信息共享十分关键的开放环境中，就应考虑将默认
项目的权限设置为包含“所有用户”组，并将其角色设置为“交互者”。用户将能够自动
发布到新项目并使用新项目中的内容。
如果 Tableau Server 部署在数据安全和访问控制十分关键的限制环境中，就应考虑清
空默认项目的权限：删除所有用户和组的权限。删除所有用户和组的权限。需要向
用户和组明确授予在新项目中发布和使用内容的权限。
数据安全
Tableau 提供了几种方法来控制哪些用户可以查看哪些数据。对于连接到实时数据库
的数据源，您还可以控制用户单击已发布的视图时是否显示提供数据库凭据的提
示。一起使用以下三个选项，可取得不同的结果：
l
l
l
数据库登录帐户： 创建连接到实时数据库的数据源时，您可以选择是通过
Windows NT 还是通过数据库的内置安全机制对数据库进行身份验证。
身份验证模式：发布具有实时数据库连接的数据源或工作簿时，可以选择一种
“身份验证模式”。可用的模式取决于上面的选择。
用户筛选器：您可以在工作簿或数据源中设置筛选器，以基于用户的 Tableau
Server 登录帐户控制其可在已发布视图中查看的数据。
下表概括了上述选项的一些依赖项：
数据库连接选项
数据库登 身份验证模式
录帐户使
用...
数据安全问题
是否每个
用户筛选器是
Tableau
否是限制各用
Server 用户 户可查看的数
都可实现数
据的唯一方
据库安全
法？
性？
Window NT 用户运行身份帐户 否
是
集成安全
性
否*
Windows 通过服务器运行身 是
份帐户进行模拟
身份验
证
- 202 -
Web
缓存是
否在用
户间共
享？
是
否
数据库连接选项
数据库登 身份验证模式
录帐户使
用...
用户名和
密码
数据安全问题
是否每个
用户筛选器是
Tableau
否是限制各用
Server 用户 户可查看的数
都可实现数
据的唯一方
据库安全
法？
性？
提示用户 ：当查看 是
否
者单击视图时，提
示其提供数据库凭
据。可以保存凭
据。
嵌入式凭据 ：工作 否
是
簿或数据源发布者
可以嵌入其数据库
凭据。
通过嵌入式密码进 是
否*
行模拟 ：嵌入带
IMPERSONATE 权
限的数据库凭据。
Web
缓存是
否在用
户间共
享？
否
是
否
* 由于可能会产生意外结果，Tableau 建议您不要将此身份验证模式用于用户筛选
器。
用户筛选器、嵌入式凭据选项和模拟模式具有类似的效果 — 当用户单击视图时，不
会显示提供数据库凭据的提示，用户只会看到与自己相关的数据。但是，用户筛选
器是由作者在工作簿应用的，而模拟身份验证模式则依赖于管理员在数据库本身中
定义的安全策略。
上面介绍的一些选项要求配置步骤必须在 Tableau Server 安装期间进行，或必须在发
布工作簿或数据源之前进行。有关更多信息，请参见以下主题：
l
用户运行身份 在本页 270
l
SQL Server 模拟 在本页 278
l
嵌入式凭据
l
保存的密码
网络安全
Tableau Server 中有三个主要网络接口：
l
l
客户端到 Tableau Server：客户端可以是 Web 浏览器、Tableau Desktop 或
tabcmd 实用工具。
Tableau Server 到数据库：为了刷新数据提取或处理实时数据库连接，Tableau
- 203 -
Server 需要与数据库进行通信。
l
服务器组件通信：这仅适用于分布式部署。
客 户 端 到 Tableau Server
Tableau Server 客户端可以是 Web 浏览器、Tableau Desktop 或 tabcmd。Tableau Server
与其客户端之间的通信使用标准 HTTP 请求和响应。也可以针对 HTTPS 来配置
Tableau Server 请参见SSL 在本页 14 。当针对 SSL 配置 Tableau Server 时，客户
端之间的所有内容和通信都将被加密，并使用 HTTPS 协议。
将使用公钥/私钥将来自浏览器和 tabcmd 的密码传送到 Tableau Server。Tableau
Server 向浏览器发送一个公钥，浏览器使用此密钥对密码加密以进行传输。每个加密
传输都使用一个一次性密钥，然后将其丢弃。这意味着无论是否使用 SSL，密码始
终是安全的。
Tableau Server 到 数 据 库
Tableau Server 动态连接到数据库以处理结果集并刷新数据提取。每当可能时，它都
会使用本机驱动程序连接到数据库，并在没有本机驱动程序时依赖于一个通用 ODBC
适配器。与数据库的所有通信都通过这些驱动程序来路由。这样，本机驱动程序安
装过程将包括配置驱动程序以在非标准端口上通信或提供传输加密。这种配置类型
对 Tableau 是透明的。
服务器组件通信
分布式服务器安装中的 Tableau Server 组件间通信有两个方面：信任和传输。Tableau
群集中的每个服务器都使用一个严格信任模型来确保其接收来自群集中其他服务器
的有效请求。群集中运行网关进程的计算机可接受第三方 客户端 的请求，除非
它们前面有负载平衡器，在这种情况下负载平衡器将接收请求。未运行网关进程的
服务器仅接受来自群集的其他受信任成员的请求。信任是通过 IP 地址、端口和协议
的白名单建立的。如果任何一部分无效，请求就会被忽略。群集的所有成员都可以
互相通信。除许可证验证和访问存储库外，所有内部通信的传输都是通过 HTTP 执行
的。
在群集内传输密码时，会使用密钥来加密在 Tableau Server 组件之间 例如，在应用
程序服务器和 VizQL 服务器进程之间 传输的密码。每个加密传输都使用一个一次性
密钥，然后将其丢弃。
保护云端数据源的凭据
对于一些基于云的数据源，在 Tableau Server 中存储敏感数据库凭据的替代方法是在
Tableau 和数据源提供程序之间建立有限用途的信任关系。通过这种关系，您可以访
问您的数据，同时通过数据源提供程序保证您的凭据安全。
若要建立这种类型的关系，您需要授权 Tableau 访问您的云数据。然后，云数据提供
程序向 Tableau 发送有限用途的访问令牌，它唯一地标识来自 Tableau 的请求并允许
Tableau 代表您访问数据。
- 204 -
Tableau 按照 OAuth 2.0 开放授权标准中的规定使用这些受保护连接。使用 OAuth 连
接可提供以下好处：
l
l
安全：您的敏感数据库凭据从不会被 Tableau Server 知道或存储在其中，并且
访问令牌只能由 Tableau 使用。
方便：不必在多个位置嵌入您的数据源 ID 和密码，您可以对访问特定数据提供
程序的所有已发布工作簿和数据源使用为该数据提供程序提供的令牌。
另外，对于 Google BigQuery 数据的实时连接，每个工作簿查看者都可以拥有标
识用户的唯一访问令牌，而不是共享单个用户名和密码凭据。
受保护身份验证适用于 Google BigQuery、Google Analytics 和 Salesforce.com 数据源。
受保护身份验证过程概述
下列步骤介绍 Tableau 环境中调用 OAuth 过程的一个工作流。
1. 您执行的操作需要访问云端数据源。
例如，您打开发布到 Tableau Server 的工作簿。
2. Tableau 将您定向到托管数据提供程序的登录页面。发送给托管数据提供程序
的信息将 Tableau 标识为请求站点。
3. 当您登录到托管数据源时，它会提示您确认您授权 Tableau Server 访问数据。
4. 确认后，数据源提供程序会向 Tableau Server 发送访问令牌。
5. Tableau Server 向您显示您的工作簿和数据。
下列是可以使用 OAuth 过程的其他工作流：
l
l
从 Tableau Desktop 或从 Tableau Server 创建工作簿并连接到数据源。
从 Tableau Desktop 发布数据源。
- 205 -
管理凭据
用户可以在用户首选项中管理他们自己的访问令牌，还可以选择只允许管理员和具
有“数据源连接器”角色的用户跨数据源和连接管理访问令牌。
不管访问令牌是用作已发布数据源的嵌入式凭据还是用于到 Google BigQuery 数据的
实时连接，以下说明都适用：
l
l
l
当 Tableau Server 通过访问令牌所表示的连接请求数据时，数据源提供程序通
过该令牌确认授权的 Tableau 访问，然后返回请求的数据。您无需每次连接时
都提供凭据。
如果令牌用作已发布数据源的嵌入式凭据，则您可以从 Tableau Desktop 或
Tableau Server 创建连接到该数据的新工作簿，而不必每次访问数据时都登录。
除非用户或数据提供程序撤消访问令牌，否则它们会一直有效。
注意：可能超出了数据源提供程序允许的访问令牌数。在这种情况下，
当创建新令牌时，数据提供程序将使用自上次访问以来已经过去的时间
长度来决定使哪个令牌失效以便为新令牌腾出空间。数据提供程序还可
以出于其他原因使令牌失效。例如，管理员可能撤消所有应用程序访问
权限。
- 206 -
性能
每个服务器环境都是唯一的，且有很多影响性能的变量。这些变量包括硬件详细信
息 例如，磁盘速度、内存和内核 ；部署中的服务器数目；网络流量；使用因素
例如，工作簿复杂性、并行存在的用户活动和数据缓存 ；Tableau Server 配置设
置 例如，运行的每个服务器进程数 以及数据考虑因素 例如数据卷、数据库类
型和数据库配置 。由于这种复杂性，没有一种公式用于提高服务器性能，但有一
些基本准则可以遵循。使用以下主题可了解更多信息：
一般性能准则
硬件和软件
使用 64 位操作系统和 64 位产品：尽管 Tableau Server 在 32 位 Microsoft 操作系统上运
行良好，但为了获得最佳性能，请选择 64 位操作系统并安装 64 位版本的 Tableau
Server。
添加更多内核和内存：无论您是在一台计算机上还是多台计算机上运行 Tableau
Server，一般规则是，CPU 核数和 RAM 越多，性能越高。请确保您满足 Tableau
Server 建议的硬件和软件要求，并参见 添加工作服务器和重新配置的时间 下一页 以
评估是否应添加其他计算机。如果您是在虚拟环境中运行 Tableau Server 的，请将您
虚拟机的最佳做法用于 vCPU 分配，这与虚拟机主机上物理 CPU 的数量相关。
配置
安排在非高峰时段进行刷新：备份任务会拖慢其他后台任务的运行速度，直到备份
完毕为止。使用 后台任务 在本页 147 管理视图来查看您的刷新和备份任务计划。您
应安排在非高峰时期进行刷新任务，以免与备份窗口重叠。
查看缓存：缓存有助于 Tableau Server 快速地响应客户端请求，尤其是对于连接到实
时数据库的视图。缓存有助于 Tableau Server 快速地响应客户端请求，尤其是对于连
接到实时数据库的视图。确认是否选择了“配置”对话框的“数据连接”选项卡上的“刷新
频率低于”。
考虑更改两个会话内存设置：
l
l
VizQL 会话超时限制：默认情况下，VizQL 会话超时限制为 30 分钟。即使
VizQL 会话空闲，它仍会占用内存和 CPU 周期。如果使用下限可以完成，则可
使用 tabadmin 在本页 306 更改 vizqlserver.session.expiry.timeout 设
置。
VizQL 清除会话：默认情况下，VizQL 会话保留在内存中，即使是在用户离开
视图时。这将占用大量的会话内存。而您可以通过将 vizqlserver.clear_
session_on_unload 设置的值更改为 true 默认为 false ，在用户离开视
图时结束会话。
评估进程配置：Tableau Server 分为六个不同组件，称为服务器进程。虽然这些进程
的默认配置旨在适用于各种情况，但也可以重新配置它们，以实现不同的性能目
- 207 -
标。具体来说，您可以控制在哪些计算机上运行进程以及运行多少个进程。有关单
节点、两节点和三节点部署的准则，请参见提高服务器性能 向下。
添加工作服务器和重新配置的时间
Tableau Server 可以随需求的变化纵向和横向扩展。下面是一些准则，有助于您确定
应该向系统添加更多节点、重新配置服务器还是两者都执行：
l
l
l
l
l
超过 100 个同时存在的用户：如果部署是用户密集型 超过 100 个同时存在的
查看者 ，则应务必有足够的 VizQL 进程，但进程数量不能超过硬件用于处理
它们的容量。另外，启用 Tableau Server 来宾用户帐户可以将同时存在的潜在
查看者数量增加到超过您可能认为自己拥有的用户列表范围。管理视图 用户活
动 在本页 144 可帮助您对此进行衡量。有关如何配置或扩展部署的提示，请参
见提高服务器性能 向下。
大量使用数据提取：数据提取可能会占用大量内存和 CPU 资源。没有一种度量
方法可以将站点限定为数据提取密集型。仅有一些过大的数据提取时，可能会
将站点归入此类别，这与有众多小数据提取一样。对于大量使用数据提取的站
点，在自己的计算机上将数据引擎进程隔离开，会获益良多。有关准则，请参
见 提高服务器性能 向下。
频繁刷新数据提取：刷新数据提取是一个大量占用 CPU 的任务。通常，对于频
繁刷新数据提取 例如，一天刷新多次 的站点，通过更多地强调处理刷新任
务的后台进程，会比较有益。使用后台任务 在本页 147管理视图可查看当前的
刷新速度，有关如何扩展的详细信息，请参见 提高服务器性能 向下。
性能疑难解答：如果加载视图速度较慢或者服务器性能通常较低，则可能有多
种原因。请参见 一般性能准则 上一页 和 提高服务器性能 向下。
停机可能性：如果服务器系统被视为任务关键的服务器系统，且要求高级别的
可用性，则可以配置服务器系统，使处理数据提取、存储库和网关的服务器进
程有冗余。有关详细信息，请参见 高可用性 在本页 39。
提高服务器性能
使用下面的主题可以获得有关如何提高数据提取密集型、用户密集型或两者的部署
性能的指南：
一台计
算机示
例：数
据提取
两台计
算机示
例：数
据提取
两台计
您的目标是什么？
要运行的进程数
配置进程的位置
- 208 -
算机示
例：查
看
三台计
算机示
例：数
据提取
和查看
优化数据提取和工作簿
评估视图响应性 下一页
您的目标是什么？
为数据提取进行优化
数据引擎进程用于存储数据提取和回答查询；后台进程用于刷新数据提取。由于两
者均需要大量的 CPU 资源，因此提高数据提取密集型部署的性能的最佳方法是将这
两个进程相互隔离，并与其他服务器进程隔离。这可能需要三台计算机。如果您没
有三台计算机可供使用，则仍有其他策略可以采用 请参见下面的部署示例 。
为用户和查看进行优化
VizQL Server 进程用于为 Tableau Server 用户处理视图加载和呈现。如果您尝试针对
大量用户和视图交互优化部署，则这是您应重点关注的进程。
要运行的进程数
本主题假定您在 64 位操作系统上运行 64 位版本的 Tableau Server。在此情形下，每
个进程两个实例应该能够满足您的需求。如果您的计算机仅满足 Tableau Server 的最
低 RAM 要求 即 8 GB ，则应限制为每个进程一个实例。
后台进程
单个后台进程可能会占用 100% 的单个 CPU 内核，对于某些任务有时甚至占用更
多。因此，应运行的实例总数取决于计算机的可用内核以及您尝试提高的方面。下
面的部署示例使用 N 表示计算机的内核总数，且每个部署示例均建议采用与后台进
程有关的不同策略。如有疑问，请从所建议范围的低端开始，逐渐增加数字，来评
估相应的性能。
数据引擎进程和存储库进程
数据引擎进程应在其自身节点上进行隔离的情况有两种，例如，如果您尝试改进数
据提取密集型部署，且与数据提取刷新相比，您希望更多地侧重查询。部署示例提
供了具体信息。由于数据引擎存储的是实时数据，因此转移数据引擎是一个多阶段
的过程。移动数据引擎进程和存储库进程 在本页 31 描述了如何执行此操作。
另一个隔离数据引擎 和/或存储库 的原因是最大限度地减少部署停机的可能性。
有关详细信息，请参见高可用性 在本页 39。除非您要配置高可用性，否则存储库通
常可以保留在主 Tableau Server 上。
- 209 -
配置进程的位置
您可以使用“Tableau Server 配置”对话框配置任何计算机正运行的进程的类型和数
量。如果您在重新配置过程中要添加新计算机，则必须已在这些新计算机上安装
Tableau 工作软件。有关步骤，请参见 安装和配置工作服务器 在本页 36。
如果您要在主 Tableau Server 或独立 Tableau Server 上重新配置进程，请参见 重新配
置进程 在本页 22。
优化数据提取和工作簿
通过数据提取提高服务器性能是数据提取和工作簿本身的部分功能。工作簿作者可
以使数据提取的数据集保持较短，利用筛选或聚合，以及隐藏未使用的字段来缩小
范围，所有这些方法有助于提高服务器性能。为此，使用 Tableau Desktop 选项“隐藏
所有未使用的字段”和“聚合可视维度的数据”。有关步骤，请参见创建数据提取
Tableau Desktop 帮助 。有关构建性能良好的工作簿的一般提示，请在 Tableau
Desktop 帮助中搜索 性能 。要查看工作簿发布到 Tableau Server 后的执行情况，可以
创建性能记录。有关详细信息，请参见创建性能记录 在本页 219。
评估视图响应性
用户打开视图时，视图组件会先经过检索和解释，然后再显示到用户的 Web 浏览器
中。对大多数视图来说，显示呈现阶段在用户的 Web 浏览器中进行，且大多数情况
下会生成最快的结果和最高级的交互响应性。在客户端 Web 浏览器中处理大多数交
互可减轻带宽压力，并降低往返请求延迟。如果视图非常复杂，Tableau Server 将在
服务器 而非客户端 Web 浏览器 中处理呈现阶段，因为这样做通常可获得最佳性
能。如果您发现视图的响应情况不尽如人意，可以测试和更改导致视图由服务器呈
现 而非在客户端 Web 浏览器中呈现的阈值 。有关详细信息，请参见关于客户端
呈现 在本页 215。
一台计算机示例：数据提取
数据提取使用量很大的 64 位 Tableau Server 安装可在单台 64 位计算机上运行，配置
如下：
- 210 -
上面的配置会与 Tableau Server“维护”页面上的以下各项类似：
配置说明：
l
l
l
l
运行 2 个 VizQL Server 进程。
将计算机的内核总数除以 4，计算要运行的后台进程的最少数量。若要确定最
大数量，请将内核总数除以 2。
后台进程和数据引擎进程均大量占用 CPU，上面的配置可平衡它们。
将数据提取刷新安排在非高峰时段执行，这样有助于数据引擎进程和后台进程
不会相互争用系统资源。
两台计算机示例：数据提取
下面说明您如何配置两台计算机的 Tableau Server 部署，以使该部署可以处理高数据
提取使用量。在本例中要注意的最重要问题是，将数据引擎进程与后台进程隔离。
- 211 -
采用上面的配置时，“维护”页面上的“状态”表会如下所示：
配置说明：
l
l
l
l
一旦您从一台计算机部署转移到两台计算机部署，第一个服务器便成为主
Tableau Server。在“状态”表中，它得到“网关”值。
在每台计算机上运行 2 个 VizQL Server 进程。
若要确定在主 Tableau Server 上要运行的后台进程的最小数量，请将计算机的
内核总数除以 4。对于最大进程数量，请将内核总数除以 2。
将主 Tableau Server 中的数据引擎移动到工作服务器是一个多阶段的过程。有
关步骤，请参见移动数据引擎进程和存储库进程 在本页 31。
两台计算机示例：查看
如果两台计算机的数据提取使用量低，但查看较频繁，可按照如下配置进行部署：
- 212 -
以上配置的“状态”表会如下所示：
配置说明：
l
l
l
l
l
在每台计算机上运行 2 个 VizQL Server 进程。
在主 Tableau Server 上应最少运行 2 个后台进程。应运行的最大进程数量等于计
算机的内核总数。
在不经常刷新数据提取的部署中，数据引擎进程和后台进程可与其他进程位于
同一台计算机上。
如果仅在非工作期间运行数据提取刷新作业，则可以在每台计算机上安排多个
后台进程，以使它们的并行度最大化。
群集中的计算机数仅由核心和可用主内存的总数确定。
三台计算机示例：数据提取和查看
如果数据提取刷新量和使用量均较高，且同时存在的用户数量较高，则三台计算机
配置是为获得最佳性能建议的最少计算机数量。
- 213 -
下面是以上配置的对应“状态”表：
- 214 -
配置说明：
l
l
l
l
l
运行 2 个 VizQL Server 进程。
后台进程位于自己的计算机上，这样它们的工作不会与其他进程的工作发生竞
争。由于计算机专用于后台进程，并且后台进程可能会占用 100% 的 CPU 资
源，因此所建议范围的低端等于内核总数。根据刷新的数据大小，对于某些部
署来说，运行后台进程的数量可能最多是内核的两倍，并且仍会获得并行加
速。
由于数据引擎进程可能会占用计算机上的所有 CPU 资源，因此该进程在自已的
计算机上隔离。
应用程序服务器进程和 Data Server 进程的用户负载通常可以分别由 1 个进程处
理，但会设置为 2 以提供冗余。
在大多数情况下，只要主 Tableau Server 和数据引擎存在充足的 CPU 周期，它
们就不会是系统总吞吐量的瓶颈。若要增加查看容量，请添加专用于 VizQL
Server 进程的计算机。若要为刷新数据提取增加容量，请添加专用于后台进程
的计算机。
关于客户端呈现
视图的标记和数据是经过检索、解释和呈现才显示在客户端 Web 浏览器中的。
Tableau Server 可在客户端 Web 浏览器中或服务器上执行此过程。由于在服务器上处
理呈现和所有交互会导致网络数据转移量和往返延时增多，因此客户端呈现为默认
模式。有了客户端呈现，大多数视图互动速度更快，因为它们会直接在客户端中进
行解释和呈现。
但如果服务器的计算能力更强，那么某些视图在服务器上的呈现就更为高效。如果
某个视图十分复杂以至于创建图像所用数据占用的带宽远远高于图像文件占用的带
宽，那么服务器端呈现就十分重要了。另外，由于通常情况下平板电脑的性能要比
个人电脑低得多，因此平板电脑只能处理较为简单的视图。在某些情况下，同样的
视图在个人电脑 Web 浏览器上打开时是通过客户端呈现的，而在平板电脑 Web 浏览
器上打开时是通过服务器呈现的。
将 Tableau Server 配置成使用阈值计算 下一页触发在服务器上 而非 Web 浏览器
中 进行的视图呈现。作为管理员，您可以在个人电脑和平板电脑上对此设置进行
测试和微调。有关更多信息，请参见以下主题。
要求
l
受支持的浏览器：Internet Explorer 9.0 版或更高版本、Firefox、Chrome 和 Safari
都支持客户端呈现。所有这些 Web 浏览器都包含客户端呈现需要使用的 HTML
- 215 -
5 <canvas> 元素。
l
多边形、自定义形状和页面历史记录功能：如果视图使用了多边形、自定义形
状或页面历史记录功能，那么即使已另外启用了客户端呈现，系统也会执行服
务器端呈现。
阈值计算
启用客户端呈现后，Tableau Server 会使用算法来确定视图的复杂程度。如果复杂度
值超过了 100 对于个人电脑浏览器 或者 20 对于平板电脑浏览器 ，则视图会在
服务器上而非 Web 浏览器中呈现。以下是计算方法：
(# of marks) + 3(# of headers) + 3(# of annotations) + 3(# of
reference lines) = view complexity
例如，如果您的视图有 2,000 个标记、150 个标题 有时您可以通过叠加视图中的行
列数量来确定该值 、1 个注释和 1 条参考线，将使用以下等式：
2,000 + 3(150) + 3(1) + 3(1) = 2,456
现在，将当前获得的阈值除以 100，然后乘以 5,000 将阈值除以 100 是标准化算
法，而所乘的 5,000 是 Tableau 的比例因数 。假设当前阈值为 100，则等式如下：
100/100 * 5,000 = 5,000
比较得到的两个和。考虑到 5,000 表示复杂度为 100，2,456 应表示大约一半的复杂度
(49)。因此，要在个人电脑浏览器上为此特定视图执行服务器端呈现，您需要将该阈
值设置为 48。请务必记住，类似筛选的交互会更改视图的复杂度，而视图复杂度一
旦更改，会话就会切换呈现模式。
有关测试和配置客户端呈现的详细信息，请参见以下主题：
使用网址参数进行测试
将 Tableau Server 配置为在默认情况下执行客户端呈现 如果符合相关要求 。要在
会话基础上测试服务器端呈现，请在视图网址末尾键入 ?:render=false。例如：
http://localhost/views/Supplies/MyView?:render=false
如果 Tableau Server 上的客户端呈现已停用，请输入 ?:render=true 来为会话启用
客户端呈现：
http://localhost/views/Supplies/MyView?:render=true
您也可以在单个视图上测试特定的复杂度阈值，以查看能否针对您的服务器和网络
状况调整服务器范围的阈值。例如，您可能会发现在到达低复杂度 例如 80 或高
复杂度 例如 120 的临界点时，用户交互得到的响应会更强。要测试阈值，您可以
保留服务器的默认配置 在已启用客户端呈现的情况下 并在视图网址末尾输入测
试阈值数字。例如：
http://localhost/views/Supplies/MyView?:render=80
- 216 -
使用 tabadmin 设置选项进行配置
您可以使用 tabadmin 选项 vizqlserver.browser.render 来停用或启用客户端呈
现，而 vizqlserver.browser.render_threshold 和
vizqlserver.browser.render_threshold_mobile 则用来更改客户端呈现的阈
值。有关详细信息，请参见 tabadmin set 选项 在本页 324。
Tableau Server 进 程
存在六个 Tableau Server 进程，可以更改其默认配置以获得不同的结果。主题提高服
务器性能 在本页 208和高可用性 在本页 39介绍了您可以采用的某些方法。每个进程
的高级别状态显示在服务器的“维护”页面，与某些进程 例如后台进程 有关的详细
信息位于 管理视图 在本页 142 主题中。
从结构上说，64 位版本的 Tableau Server 使用本机 64 位进程；32 位版本的 Tableau
Server 使用 32 位进程。但数据引擎例外。如果 32 位版本的 Tableau Server 安装在 64
位操作系统上，则会使用 64 位版本的数据引擎进程。
有关这些进程生成的日志文件的信息，请参见服务器日志文件位置 在本页 341。
进程
文件名
应用程序服 wgserver.exe
务器
后台
是否
为多
用途
线
程？
处理 Web 应用程 是
序，支持浏览和
搜索
backgrounder.exe 执行服务器任务 否
包括数据提取
刷新 、“立即
运行”任务以及
通过 tabcmd 启
动的任务
- 217 -
性能特征
在不经常使用的操作
例如，发布包含数
据提取的工作簿，或
者生成视图的静态图
像 中仅占用显而易
见的资源。可通过基
于浏览器的交互和
tabcmd 创建该进程的
负载。
可在群集内的任何或
所有计算机上运行多
个进程以扩展容量的
单线程进程。后台程
序通常不会占用很多
进程内存，但后台程
序可能会根据面向它
的工作负载的性质占
用 CPU 资源、I/O 资源
或网络资源。例如，
执行大量数据提取刷
新时，可能会使用网
络带宽来检索数据。
数据检索或复杂的
进程
数据引擎
文件名
是否
为多
线
程？
用途
tdeserver64.exe 存储数据提取和 是
回答查询
tdeserver.exe
Data Server dataserver.exe
处理至 Tableau 是
Server 数据源的
连接
- 218 -
性能特征
tabcmd 任务可能会占
用 CPU 资源。
数据引擎的工作负载
是来自 VizQL Server 进
程的请求产生的。该
进程是将数据提取加
载到内存并针对数据
提取执行查询的组
件。内存占用主要基
于所加载的数据提取
的大小。在 64 位操作
系统上，默认使用 64
位二进制文件，即使
安装的是 32 位 Tableau
Server，也是如此。数
据引擎是多线程的进
程，可以一次处理多
个请求。在高负载的
情况下，该进程可能
会占用 CPU 资源、I/O
资源和网络资源，所
有这些资源都可能是
高负载的性能瓶颈。
高负载时，数据引擎
的单个实例可能会占
用所有 CPU 资源，以
便处理请求。
由于该进程是一个代
理，因此它通常仅受
限制于网络，但在有
很多同时存在的用户
会话时，可能会受限
制于 CPU。该进程的
负载是以下内容产生
的：基于浏览器的交
互，基于 Tableau
Desktop 的交互，以及
针对 Tableau Server 数
据源的数据提取刷新
作业。
进程
文件名
存储库
postgres.exe
VizQL
Server
vizqlserver.exe
是否
为多
用途
性能特征
线
程？
Tableau Server 不适用 通常仅占用很少的资
数据库，用于存
源。执行诸如用户查
储工作簿和用户
看所有工作簿或更改
元数据
权限等操作时，在极
少情况下，对于超大
型部署 存在数千位
用户 ，该进程可能
会成为瓶颈。
加载和呈现视
是
在从 Web 浏览器加载
图，计算和执行
视图和交互使用的过
查询
程中，占用明显的资
源。可能受限制于
CPU、I/O 或网络。进
程负载只能由浏览器
的交互创建。进程内
存可能不足。
创建性能记录
利用 Tableau 中的性能记录功能，您可以在与工作簿交互时记录关键事件的相关性能
信息，然后可在 Tableau 自动创建的性能工作簿中查看性能指标。然后可在 Tableau
自动创建的性能工作簿中查看性能指标。对于 Tableau Desktop 和 Tableau Server，用
于创建和查看性能记录的步骤会略有不同。过，在 Tableau Desktop 和 Tableau Server
中，所生成的性能工作簿的格式是相同的。
使用性能工作簿可分析和解决已知会影响性能的各种事件的相关性能问题，这些事
件包括：
l
l
l
l
l
l
l
查询执行
地理编码
连接到数据源
布局计算
数据提取生成
混合数据
服务器混合 仅限 Tableau Server
Tableau 支持人员在帮助您诊断性能问题时可能会请求您创建性能工作簿。
- 219 -
在 Tableau Server 中 创 建 性 能 记 录
服务器管理员决定是否在站点级别启用性能记录。默认情况下，在默认站点中或您
创建的任何站点中不会启用性能记录。若要为站点启用性能记录，请按以下步骤操
作：
1. 在 Tableau Server 中选择“管理”按钮。
2. 选择“站点”。
3. 选择一个站点。
4. 选择“编辑”。
5. 在“编辑站点”对话框中，选择“允许性能记录”。
6. 选择“确定”。
可通过将 ?:record_performance=yes 添加到 URL 中来启动性能记录。例如：
http://localhost/views/Variety/BaseballStatistics?:record_performance=yes
记录启动的可视确认为工具栏中的显示性能记录命令：
选择显示性能记录以打开性能工作簿，它是性能数据的最新快照。当您继续使用视
图时，可以继续创建其他快照，性能数据是累计的。在您浏览页面离开视图之后或
者从 URL 中移除 ?:record_performance=yes 之后，记录将停止。
解释性能记录
性能记录工作簿是 Tableau 仪表板，其中包含三个视图：“时间表”、“事件”和“查
询”。
有关如何在 Tableau Server 中创建性能记录的信息，请参见创建性能记录 上一页。
时间表
性能记录仪表板的最上方视图从左向右显示记录期间发生的事件 按时间先后顺序
排列 。底部的轴显示自 Tableau 启动以来所经过的时间 以秒为单位 。
在“时间表”视图中，“工作簿”、“仪表板”和“工作表”列标识事件的上下文。“事件”列
标识事件的性质，最后一列显示每个事件的持续时间以及按时间先后顺序与其他所
记录事件的比较情况：
- 220 -
事件
性能记录工作簿中的中间视图显示按持续时间排序 从最长到最短
在您希望加快使用工作簿的速度时帮助您确定最先查看的位置。
的事件。这可
不同的颜色指示不同类型的事件。可记录的事件范围如下：
l
正在计算布局。
如果布局所花的时间过长，请考虑简化工作簿。
l
正在连接到数据源。
连接可能会因网络或数据库服务器问题而较慢。
l
正在执行查询。
如果查询所花的时间过长，请参考数据库服务器的文档。
l
正在生成数据提取。
若要加快数据提取生成的速度，请考虑仅从原始数据源导入部分数据。例如，
可以筛选特定的数据字段，或者创建基于指定行数或数据百分比的示例。
l
地理编码。
若要加快地理编码性能，请尽量使用较少的数据或筛选出数据。
l
混合数据。
若要加快数据混合，请尽量使用较少的数据或筛选出数据。
l
服务器呈现。
通过在其他计算机上运行其他 VizQL Server 进程，可以加快服务器呈现。
查询
如果在性能记录仪表板的“时间表”或“事件”部分中单击“正在执行查询”事件，则将在
“查询”部分中显示该查询的文本。例如：
- 221 -
有时，查询会被截断，您需要访问 Tableau 日志才能找到完整查询。大多数数据库服
务器会向您提供有关如何通过添加索引或其他方法来优化查询的建议。有关详细信
息，请参见数据库服务器文档。
- 222 -
嵌入视图
您可以将 Tableau Server 中的视图嵌入到网页、博客、wiki、Web 应用程序和 Intranet
门户中。嵌入的视图能够与网页融为一体，并且可以交互。视图会随着基础数据的
变化或工作簿在服务器上的更新而更新。嵌入的视图遵守服务器上使用的相同许可
和权限限制。通常，要加载带有嵌入视图的网页的人还必须在 Tableau Server 上拥有
帐户。 如果您具有基于内核的许可证，也可以选择“启用来宾”，这样用户无需登录就
能加载视图。可通过三种方式嵌入视图：
l
l
l
按原样使用共享嵌入代码：每个视图左上角的“共享”链接提供了自动生成的嵌
入代码。每个视图左上角的“共享”链接提供了自动生成的嵌入代码。您只需要
将该代码复制并粘贴到网页中即可。
编写自己的嵌入代码： 您可以增强 Tableau 提供的默认嵌入代码，或者生成自
己的代码。无论采用哪种方式，都可以添加用于控制工具栏、选项卡等的参
数。
使用 Tableau JavaScript API： 您可以在自己的 Web 应用程序代码中使用
Tableau JavaScript 对象。有关详细信息，请参见 JavaScript API 在本页 356。
要让用户在单击嵌入视图时成功进行身份验证，其浏览器必须配置为允许第三
方 Cookie。
有关嵌入视图的详细信息，请参见以下主题：
编写嵌入代码
如果您要编写您自己的嵌入代码，则可采用以下两种方法之一：
l
l
使用 Tableau JavaScript：这是首选方法。只需将“共享”嵌入代码用作自己代码
的起点，然后添加或编辑用于控制工具栏、选项卡等的对象参数。只需将“共
享”嵌入代码用作自己代码的起点，然后添加或编辑用于控制工具栏、选项卡等
的对象参数。依赖于 Tableau JavaScript 文件的默认嵌入代码也是控制多个嵌入
视图的加载顺序的唯一方法。
指定视图 URL：与早期版本的 Tableau 一样，当源是视图的原始 URL 时，您可
以使用 Iframe 或 Image 标记来嵌入视图。与早期版本的 Tableau 一样，当源是
视图的原始 URL 时，您可以使用 Iframe 或 Image 标记来嵌入视图。如果您无法
在网站中使用 JavaScript，则可能需要这样做。可能还有一些只能指定 URL 的
情况，例如，当使用 SharePoint 的页面查看器 Web 部件嵌入视图时。
无论采用何种方法，都必须在嵌入视图时定义宽度和高度。
Tableau JavaScript
下面是单击“共享”时在默认情况下得到的嵌入代码的示例：
- 223 -
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<div class="tableauPlaceholder" style="width:800; height:600;">
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="/t/Sales" />
<param name="name"
value="MyCoSales/SalesScoreCard/jsmith@myco.com/EastCoastSales"
/>
<param name="tabs" value="yes" />
<param name="toolbar" value="yes" /></object></div>
<script> 标记的源是 Tableau Server JavaScript 文件 (viz_v1.js) 的 URL。JavaScript 文
件负责处理向您的用户显示的视图的完整 URL 的汇编。name 和 site_root 对象参
数是唯一的必需参数；所有其他参数都是可选参数。有关示例，请参见嵌入参数列
表 向下以及示例 在本页 229部分中的“脚本标记示例”。
查 看 作 为 源 的 URL
下面是使用 IFrame 嵌入相同视图的示例，其中，源是该视图的 URL：
<iframe
src="http://myserver/t/Sales/MyCoSales/SalesScoreCard?:embed=yes&:tabs=yes&:toolbar=yes" width="800" height="600"></iframe>
必须指定 embed URL 参数，并可以包括用于控制工具栏和恢复选项等的参数。您还
可向用于控制加载视图时显示的特定数据的 URL 添加筛选器。有关示例，请参见嵌
入参数列表 向下以及示例 在本页 229部分中的“Iframe 标记示例”。
在使用原始 URL 创建 Iframe 标记时，不要包含 URL 末尾的井号标记 (#) 和数
字。例如，在您的源代码中使用 MyCoSales/SalesScoreCard 而不是
MyCoSales/SalesScoreCard#2。
嵌入参数列表
可以使用 Iframe 标记 此标记使用 URL 参数 或 JavaScript 标记
数 来嵌入视图。下表列出了参数集以及参数集的用法。
对象参 URL 参 值
数
数
custom- :custo- no
Views mViews
此标记使用对象参
说明
示例
隐藏“记住
我的更改”
选项。
<param name="customViews"
value="no"/>
http://tabserver/views/DateTime/DateCalcs?:embed=yes&:custom-
- 224 -
对象参
数
URL 参
数
值
说明
URL 参数
所必需。
隐藏顶部
导航区
域，使视
图更好地
融入网页
中。
filter
字符 自定义视
串
图打开时
显示的内
容。也可
以按网址
参数筛
选。请参
见以下位
置中的
Iframe 标记
示例：添
加筛选器
在本页 229
和筛选多
个字段 在
本页 230。
:format
pdf;
以 PDF 或
png
.png 文件显
示视图。
:highd- fals- 对于高分
pi
e
辨率显示
器和设
备，使用
标准 DPI
每英寸
点数 呈
现视图。
host_
字符 显示在
url
串
URL 中的
服务器名
称。
-
:embed
yes
示例
Views=no
http://tabserver/views/DateTime/DateCalcs?:embed=yes
<param name="filter"
value="Team=Blue"/>
http://tabserver/views/Sales/Q2?:format=pdf
http://tableauserver/views/Sales/Q2?:highdpi=false
<param name="host_url"
value="http://myserver.bigco.com/">
<param name="host_url"
value="http://localhost/">
- 225 -
对象参 URL 参 值
数
数
linkta- :linkt- 字符
rget
arget
串
loadorder
-
数字
name
-
字符
串
path
-
字符
串
说明
示例
外部超链
接的目标
窗口名
称。
<param name="linktarget" value="_
blank"/>
当嵌入多
个视图
时，默认
加载顺序
是列出视
图的顺
序。使用
此设置可
覆盖该顺
序。允许
使用负
数。
对象参数
所必需。
工作簿和
工作表名
称，可能
还包含自
定义视图
(username@domain/
[custom
view
name])。如
果参考
Tableau
Server URL
来确认
name 的
值，请不
要包含
URL 末尾
的井号标
记 (#) 和数
字。
仅适用于
http://tabserver/views/DateTime/DateCalcs?:embed=yes&:linkta
rget=_blank
<param name="load-order"
value="2"/>
<param name="name"
value="MyCoSales/Sales"/>
<param name="name"
value="MyCoSales/Sales/jsmith@myc
o.com/EastCoastSales"/>
<param name="path"
value="trusted/Etdpsm_Ew6rJY-
- 226 -
对象参
数
-
URL 参
数
值
说明
受信任的
身份验
证，不能
与“ticket”参
数一起使
用。覆盖
“name”参数
的值并用
作 URL。
请参见受
信任的身
份验证示
例。
:refre重新呈现
sh
该页面。
有关详细
信息，请
参见刷新
数据 在本
页 185。
:render true; 如果客户
fals- 端呈现已
e;
启用 默
numb- 认设
er
置 ，设
置为
false 将
会对该会
话强制实
现服务器
端呈现。
如果客户
端呈现已
禁用，设
置为 true
将会对该
会话启用
客户端呈
现。可以
使用数字
来测试复
杂度阈
示例
9kRrALjauU/views/workbookQ4/Sales
Q4"/>
http://tableauserver/trusted/Etdp
sm_Ew6rJY9kRrALjauU/views/workbookQ4/Sales
Q4?:embed=yes&:tabs=yes
http://tabserver/views/DateTime/DateCalcs?:embed=yes&:refresh
http://tabserver/views/DateTime/DateCalcs?:render=false
- 227 -
对象参
数
-
site_
root
tabs
ticket
URL 参
数
值
说明
值。请参
见关于客
户端呈现
在本页
215。
:revert all; 使该项返
filt- 回到其原
ers; 始状态。
sorts;
axes;
shelves
-
:tabs
-
字符
串
必需。站
点名称。
默认站点
值为空
(
value=""
)。如果服
务器是多
站点的，
并且您希
望使用受
信任的身
份验证，
请参见受
信任的身
份验证示
例。
yes; 显示或隐
no
藏选项
卡。
数字 仅适用于
受信任的
身份验
证，不能
与“path”对
象参数一
起使用。
必须与
示例
http://tabserver/views/DateTime/DateCalcs?:embed=yes&:revert=all
<param name="site_root"
value="/t/Sales"/>
<param name="site_root"
value=""/>
<param name="tabs" value="yes"/>
<param name="ticket"
value="Etdpsm_Ew6rJY9kRrALjauU"/>
http://tableauserver/trusted/Etdp
sm_Ew6rJY9kRrALjauU/views/workbookQ4/Sales
Q4?:embed=yes&:tabs=yes
- 228 -
对象参
数
URL 参
数
值
说明
“name”对象
一起使
用，用来
构造受信
任的票证
兑现
URL。请参
见受信任
的身份验
证示例。
toolba- :toolb- yes; 如果未设
r
ar
no;
置此参
top
数，默认
情况下显
示工具
栏。当选
择 no 时，
工具栏将
从嵌入视
图中排
除。当选
择 top
时，工具
栏将置于
视图之
上。
示例
<param name="toolbar"
value="top"/>
http://tabserver/views/DateTime/DateCalcs?:embed=yes&:toolba
r=no
示例
下面是自定义或使用嵌入代码的某些方法的示例：
添加筛选器
您可以传递筛选器值，以便视图打开时仅显示您想要的数据。例如，您可能希望在
嵌入的销售业绩视图中包括 Web 应用程序其他部分中的一个超链接，该销售业绩视
图仅显示特定地区。如果您使用原始 URL 来指定 name 参数的值或创建您的 Iframe
源，请不要包含 URL 末尾的井号标记 (#) 和数字。例如，使用 Sales/SalesPerformance 而不是 Sales/Sales-Performance#1。
脚本标记示例
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js">
- 229 -
</script>
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name="name" value="Sales/Sales-Performance" />
<param name="filter" value="Region=East" />
</object>
若要传递多个筛选器，只需用逗号将每个值分隔开。例如：
<param name="filter" value="Region=East,West" />
Iframe 标记示例
<iframe
src="http://myserver/views/CalculatedFields?:embed=yes&Region=East"width="800" height="600"></iframe>
<iframe src="http://myserver/views/Sales/SalesPerformance?:embed=yes&Region=East,West" width="900px"
height="700px"></iframe>
筛选多个字段
您可针对所需的任意多个字段传递筛选器，包括原始视图中没有的字段。
脚本标记示例
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js">
- 230 -
</script>
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name="name" value="Sales/Sales-Performance" />
<param name="filter" value="Region=East,West&Customer
Segment=Consumer,HomeOffice" />
</object>
Iframe 标记示例
<iframe
src="http://myserver/views/CalculatedFields?:embed=yes&Region=East,West&Customer Segment=Consumer,Home Office" width="800"
height="600"></iframe>
如果筛选器值包含特殊字符 例如逗号 ，请将该字符替换为 \ 反斜
杠，%5c 的网址编码顺序，后接特殊字符的网址编码顺序。需要使用反斜杠
对特殊字符进行转义。例如，\, 反斜杠，逗号 的 URL 编码序列是
%5c%2c。 此外，如果您使用原始 URL 来指定 name 参数的值或创建您的 Iframe
源，请不要包含 URL 末尾的井号标记 (#) 和数字。例如，使用 Sales/SalesPerformance 而不是 Sales/Sales-Performance#1。
筛选日期和时间
如果需要筛选“日期/时间”字段，请使用下面显示的默认 Tableau 格式将该值包括进
来：
- 231 -
yyyy-mm-dd hh:mm:ss
时间部件使用 24 小时时钟。许多数据库将所有日期值存储为“日期时间”字段，因
此，您可能需要与日期一起传递时间值。
脚本标记示例
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name="name" value="Sales/Sales-Performance" />
<param name="filter" value="Date=2012-12-01" />
</object>
本示例将同时筛选日期字段和日期时间字段：
<param name="filter" value="2012-12-01%2022:18:00" />
Iframe 标记示例
<iframe src="http://myserver/Sales/SalesPerformance?:embed=yes&Date=2008-12-01%2022:18:00" width="800"
height="600"></iframe>
若要筛选多个日期，请用逗号将每个日期分隔开。
如果您使用原始 URL 来指定 name 参数的值或创建您的 Iframe 源，请不要包含 URL
末尾的井号标记 (#) 和数字。例如，使用 Sales/Sales-Performance 而不是
Sales/Sales-Performance#1。
筛选度量
可通过包括一个或多个值来筛选度量。不支持大于、小于或范围。下面的示例在筛
选后仅显示 $100 和 $200 的销售。
脚本标记示例
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js">
</script>
<object class="tableauViz" width="800" height="600
"style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name="name" value="Sales/Sales-Performance" />
- 232 -
<param name="filter" value="Profit=100, 200" />
</object>
Iframe 标记示例
<iframe src="http://myserver/Sales/SalesPerformance?:embed=yes&Profit=100,200" width="800"
height="600"></iframe>
如果您使用原始 URL 来指定 name 参数的值或创建您的 Iframe 源，请不要包含 URL
末尾的井号标记 (#) 和数字。例如，使用 Sales/Sales-Performance 而不是
Sales/Sales-Performance#1。
控制多个视图的加载顺序
您可以针对使用您的视图的人员，对多个视图的加载顺序进行控制。只能使用依赖
于 Tableau JavaScript 文件的嵌入代码来访问此功能。
在下面的示例中，嵌入了两个视图。首先加载第二个视图，然后加载上面的视图。
如果嵌入多个视图并为它们指定相同的加载顺序值，或者不指定加载顺序参数，则
这些视图将按出现在页面上的顺序加载。
脚本标记示例
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js">
</script>
<object class="tableauViz" width="600" height="400"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name ="name" value="MyCoSales/TopPerformers" />
<param name="tabs" value="yes" />
<param name="toolbar" value="yes" />
<param name="filter" value="Salesperson=Top 5" />
<param name="load-order" value="0" />
</object>
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js">
</script>
<object class="tableauViz" width="600" height="400"
style="display:none;">
<param name="host_url" value="http://myserver/" />
<param name="site_root" value="" />
<param name="name" value="MyCoSales/SalesScoreCard" />
<param name="tabs" value="yes" />
<param name="toolbar" value="yes" />
- 233 -
<param name="load-order" value="-1" />
</object>
将 视 图 嵌 入 SharePoint (Microsoft SSPI)
可以将 Tableau Server 视图嵌入 SharePoint 页面中。若要自动对访问嵌入式视图的
Tableau Server 用户进行身份验证，您有两个选项，这两个选项都依赖于在 Tableau
Server 安装期间选择的用户身份验证方法。您可以使用 Active Directory 并“启用自动
登录”对 Tableau Server 用户进行身份验证 也称为使用 Microsoft SSPI ，也可以使
用“本地身份验证”- 然后还可以将 Tableau Server 配置为进行受信任的身份验证。
本主题适用于第一个选项，其中 Tableau Server 和 SharePoint 都使用 Microsoft SSPI。
如果 Tableau Server 使用的是“本地身份验证”，请参见将视图嵌入 SharePoint 本地
身份验证 在本页 237，了解相关步骤。
要求
许可用户：任何访问嵌入视图的人都必须是 Tableau Server 上的许可用户。
SharePoint 版本：若要在 SharePoint 页面中嵌入 Tableau Server 视图，您必须使用
SharePoint 2013。此版本的 SharePoint 使用 Microsoft .NET Framework 4.5 版，这满足
Tableau Server 的安全要求。
将视图嵌入 SharePoint
请按照以下步骤使用 SharePoint 的页面查看器 Web 部件在 SharePoint 页面中嵌入视
图。
1. 导航到要嵌入视图的 SharePoint 页面
页面类型应该是“Web 部件页”
。
2. 在页面左上角的“网站操作”菜单中，选择“编辑页面”。
3. 在要嵌入视图的页面部分中，单击“添加 Web 部件”。
4. 在“类别”下，选择位于“其他”或“自定义”文件夹中的
“TableauEmbeddedView”，然后单击“添加”。
5. 返回到 SharePoint 页面，在新 Web 部件的“编辑”菜单中选择“编辑 Web 部件”。
- 234 -
6. 在页面的右侧，可以指定“页面视图 Web 部件”的属性。键入您要嵌入的视图的
URL，不要在 URL 的末尾包含井号标记 (#) 和数字。使用嵌入视图 在本页 223
中指定的格式。例如，可以键入：
http://tableauserver/views/DateTime/DateCalcs?:embed=yes&:toolbar=no
7. 在“外观”部分指定 Web 部件的“标题”、“高度”和“宽度”。通常应该指定固定高
度 例如，700 像素 ，并调整宽度以适应该区域大小。
- 235 -
8. 单击“确定”应用更改并退出编辑模式。
该视图将嵌入到刚创建的 Web 部件中。您的用户不需要登录到 Tableau Server
来查看嵌入视图，而是将使用 Microsoft SSPI 自动对他们进行身份验证。
将 视 图 嵌 入 Wiki
只需将视图放在一个 <iframe> 标记内，即可轻松将视图嵌入 Wiki 或其他网页中。
1. 导航到要嵌入视图的 Wiki 页面。
2. 编辑该页面，并添加 <iframe>，其源为该视图的 URL，但不包括末尾的井号
标记 (#) 和数字。例如：
<iframe src="http://tableauserver/views/DateTime/DateCalcs?:embed=yes&:toolbar=no" width="800"
height="600"></iframe>
3. 保存所做的更改。
该视图将嵌入到 Wiki 页面中。
如果 Tableau Server 和 Wiki 都配置为使用 Microsoft SSPI，则访问 Wiki 上的嵌入
视图的用户将会自动登录，以便能够查看该视图。
如果服务器和 Wiki 没有使用相同的身份验证方法，则用户需要先登录到服务器
- 236 -
中，才能看到该视图。
嵌入图像
除了将视图嵌入到 <script> 或 <iframe> 标记中之外，还可以将视图作为图像嵌
入。嵌入图像时，该视图不具有交互性，但在每次该页面完全重新加载时，该视图
将会更新。这样，即使基础数据发生变化，图像也会显示最新数据。
1. 导航到要嵌入图像的页面。
2. 编辑该页面，并添加 <img> 标记，其源为该视图的 URL 加上 .png 文件扩展名
但不包括井号标记和数字 。例如：
<img src="http://tableauserver/views/Date-Time/DateCalcs.png"
width="900" height="700">
注意：
由于临时产品限制，仅当访问嵌入式图像的用户在 Tableau Server 中还有一个活动
Web 浏览器会话，并使用 Microsoft SSPI 登录到 Tableau Server 时，以上方法才有效。
将 视 图 嵌 入 SharePoint
本地身份验证
可以将 Tableau Server 视图嵌入 SharePoint 页面中。如果“本地身份验证”是 Tableau
Server 的用户身份验证方法，在开始嵌入视图之前，需要执行一些额外步骤。这些步
骤向 SharePoint 标识 Tableau Server 用户及其他信息。Tableau 通过补充性文件
TableauEmbeddedView.dll 和 TableauEmbeddedView.wsp 提供此功能。本主题介绍如何
安装和设置这些文件，测试您的配置，然后使用 SharePoint Web 部件嵌入视图。如
果 Active Directory 是您的用户身份验证方法，则不需要执行这些额外步骤，因为
Active Directory 和 SharePoint 都使用 Microsoft SSPI。您可以立即开始嵌入。请参见将
视图嵌入 SharePoint (Microsoft SSPI) 在本页 234，了解相关步骤。
- 237 -
要求
许可用户和匹配的用户名：任何访问嵌入视图的人都必须是 Tableau Server 上的许可
用户，并且他们在 SharePoint 上的用户名必须与其在 Tableau Server 上的用户名相
同。
SharePoint 版本：若要在 SharePoint 页面中嵌入 Tableau Server 视图，您必须使用
SharePoint 2013。此版本的 SharePoint 使用 Microsoft .NET Framework 4.5 版，这满足
Tableau Server 的安全要求。
编辑 DLL 的安全权限
第一步是编辑 .dll 的安全权限，以便操作系统的所有用户都可以使用它。
1. 找到随 Tableau Server 安装的 TableauEmbeddedView.dll 和
TableauEmbeddedView.wsp 文件：
C:\Program Files\Tableau\Tableau
Server\8.2\extras\embedding\sharepoint\
2. 将文件复制到 SharePoint 服务器的根目录中。根目录通常位于
C:\Inetpub\wwwroot\wss\VirtualDirectories\<port>\bin，例如：
C:\Inetpub\wwwroot\wss\VirtualDirectories\80\bin
该过程的其余部分以及下一过程将重点介绍该 .dll 文件。
3. 右键单击 TableauEmbeddedView.dll 然后选择“属性”>“安全性”，来编辑该文件
的安全权限。
4. 在“组或用户名”下，选择“所有人”，然后单击“编辑”。
5. 在“所有人的权限”下，对“完全控制”权限选择“允许”。
- 238 -
6. 单击“确定”。
安装和部署 WSP 文件
上述过程向所有操作系统用户授予了使用 .dll 文件的权限。在下面的过程中，您将向
SharePoint 提供有关如何处理该 .dll 文件的更多信息。这由 TableauEmbeddedView.wsp
文件处理。您已经在编辑 DLL 的安全权限 上一页的步骤 2 中复制了此文件。若要安
装和部署 .wsp 文件，请执行以下步骤：
1. 以管理员身份打开命令提示符。
2. 导航到以下文件夹：
C:\Program Files (x86)\Common Files\Microsoft Shared\Web
Server Extensions\14\BIN
3. 运行以下命令以添加 .wsp 文件：
stsadm -o addsolution -filename
"C:\Inetpub\wwwroot\wss\VirtualDirectories\80\bin\TableauEmbe
ddedView.wsp"
4. 接下来运行以下命令部署它。在此命令中，http://<your SharePoint
- 239 -
site>/ 应该是 SharePoint 网站的根目录，例如 http://mySharePoint/。
stsadm -o deploysolution -name TableauEmbeddedView.wsp
http://<your SharePoint Site>/ -local -force allowgacdeployment
-url
5. 最后，通过运行以下命令激活 Web 部件功能：
stsadm -o activatefeature -name TableauEmbeddedView_Feature1
-url http://<your SharePoint Site>/
验证 Web 部件的部署
安装和部署 TableauEmbeddedView.wsp 文件后，通过执行以下操作，验证您的设置：
1. 在 Web 浏览器中打开 SharePoint 网站。可能需要几分钟网站才能出现。
2. 从“网站操作”列表中，选择“网站设置”。
3. 在“库”下，选择“Web 部件”。
4. 确认 TableauEmbeddedView 已列出。
- 240 -
5. 返回“网站设置”，在“网站集管理”下，选择“网站集功能”。
确认“TableauEmbeddedView 功能”的状态为“活动”。
使用 Web 部件嵌入视图
现在您可以在 SharePoint 页面中嵌入视图：
1. 导航到要嵌入视图的 SharePoint 页面
页面类型应该是“Web 部件页”
。
2. 在页面左上角的“网站操作”菜单中，选择“编辑页面”。
3. 在要嵌入视图的页面部分中，单击“添加 Web 部件”。
4. 在“类别”下，选择位于“其他”或“自定义”文件夹中的
“TableauEmbeddedView”，然后单击“添加”。
5. 返回到 SharePoint 页面，在新 Web 部件的“编辑”菜单中选择“编辑 Web 部件”。
- 241 -
6. 在页面的右侧，可以指定 TableauEmbeddedView Web 部件的属性。键入您
Tableau Server 的名称，然后键入要嵌入视图的路径。例如，您可以键入
/views/Date-Time/DateCalcs 不要包含 URL 末尾的井号标记 (#) 和数
字 。
7. 指定其他属性，例如是否显示工具栏，或者是否将该视图作为图像而不是作为
交互式视图嵌入。
8. 在“外观”部分指定 Web 部件的“标题”、“高度”和“宽度”。通常应该指定固定高
度 例如，700 像素 ，并调整宽度以适应该区域大小。
- 242 -
9. 单击“确定”应用更改并退出编辑模式。
现在，该视图已嵌入页面中，访问该视图的用户将基于其 SharePoint 用户名和
密码自动登录。任何人访问嵌入视图的人都应该是 Tableau Server 上的许可用
户，并且其在 SharePoint 上的用户名必须与其在 Tableau Server 上的用户名相
同。
下面是使用提供的 .dll 文件将视图嵌入 SharePoint 的示例。您还可以将视
图嵌入到其他类型的 Web 应用程序中。有关更多信息，请参见
JavaScript API 在本页 356。
- 243 -
代理服务器
Tableau Server 可以配置为使用代理服务器。在此类环境中，代理服务器充当 Tableau
Server 与对 Tableau Server 上的资源发出请求的客户端之间的媒介。可通过多种方式
来配置代理服务器 — 例如，配置为正向代理或反向代理。这些主题假定您已配置代
理服务器，现在需要向 Tableau Server 来标识该代理服务器。
使用以下主题可了解更多信息：
准备配置代理环境
若要将 Tableau Server 配置为使用代理服务器，您需要有关代理服务器的以下信息：
l
l
l
l
IP 地址：代理服务器的 IP 地址。该 IP 地址必须采用 IPv4 格式，例如
123.45.67.890，并且必须是静态 IP。
FQDN：代理服务器的完全限定域名。例如，bigbox.myco.com。
非 FQDN：代理服务器的任意非完全限定域名。在以上示例中，代理服务器的
非完全限定域名为 bigbox。
别名：代理服务器的任何别名。别名是使用 CNAME 典型名称记录 指定
的。例如，CNAME 为 bigbox.myco.com、别名为 ftp.myco.com 和 www.myco.com
的代理服务器。
如果 Tableau Server 使用 SSPI 使用 Active Directory 并启用自动登录 对
Tableau Server 用户进行身份证，则不支持 Apache 反向代理服务器。如果
Tableau Server 仅使用 Active Directory 不“启用自动登录” 、“本地身份验证”或
“SAML”对服务器用户进行身份验证，则支持 Apache 反向代理服务器。
配 置 Tableau 以 使 用 代 理 服 务 器
在收集准备配置代理环境 向上中描述的信息后，您可通过执行以下步骤来配置
Tableau Server 以使用代理。有关以下设置的信息，请参见tabadmin set 选项 在本页
324。
1. 停止服务器。
2. 还是在 Tableau Server 的 bin 目录中，输入以下命令，其中 name 是代理服务器
的典型 外部可见 名称：
tabadmin set gateway.public.host "name"
3. 默认情况下，Tableau 假定代理服务器在端口 80 上侦听外部通信。若要指定其
他端口，请输入以下命令，其中 port_number 是端口：
tabadmin set gateway.public.port "port_number"
4. 现在，输入以下命令，其中 server 是代理服务器的 IPv4 地址或计算机名称：
- 244 -
tabadmin set gateway.trusted "server"
server 的值可以是逗号分隔的列表，例如：
tabadmin set gateway.trusted "123.45.67.890, 123.45.67.880,
123.45.67.870"
或
tabadmin set gateway.trusted "proxy1, proxy2, proxy3"
5. 在下一个命令中，您将为代理服务器提供任何备用名称，例如它的完全限定域
名、任何非完全限定域名和任何别名。这些是用户可能在浏览器中键入的名
称。用逗号分隔每个名称：
tabadmin set gateway.trusted_hosts "name1, name2, name3"
例如：
tabadmin set gateway.trusted_hosts "proxy1.example.com,
proxy1, ftp.example.com, www.example.com"
6. 启动服务器以使更改生效。
- 245 -
受信任的身份验证
将 Tableau Server 视图嵌入到网页中时，访问该页面的所有用户都必须是 Tableau
Server 上的许可用户。用户访问该页面时，将会看到先登录到 Tableau Server 中才能
查看视图的提示。如果您已经有一种在该网页上或 Web 应用程序中对用户进行身份
验证的方法，就可以通过设置受信任的身份验证来避免此提示，并避免您的用户必
须登录两次。
受信任的身份验证意味着您已在 Tableau Server 与一个或多个 Web 服务器之间建立受
信任的关系。当 Tableau Server 接收来自这些受信任 Web 服务器的请求时，它会假设
您的 Web 服务器已处理必需的身份验证。
如果您的 Web 服务器使用 SSPI 安全支持提供程序接口 ，则无需设置受信任的身
份验证。您可以嵌入视图，这样，只要您的用户是 Tableau Server 许可用户且是您
Active Directory 的成员，就可以安全地访问这些视图。不不支持同时使用“启用自动登
录” 在安装过程中配置的选项，该选项使用 Microsoft SSPI 和受信任的身份验证。
如果您没有将 SSPI 与 Active Directory 结合使用并且希望您的用户能够安全地访问
Tableau Server 视图而不提示其输入凭据，则可以设置受信任的身份验证。
用户的浏览器必须配置为允许第三方 Cookie，这样他们在点击嵌入视图时就能
进行身份验证了。
受信任的身份验证的工作原理
下图说明了受信任的身份验证在客户端的 Web 浏览器、您的 Web 服务器和 Tableau
Server 之间是如何工作的。
- 246 -
用户访问网页：当用户访
问具有嵌入式 Tableau
Server 视图的网页时，该
网页会向您的 Web 服务器
发送一个 GET 请求，要求
提供该网页的 HTML。
Web 服务器 POST 到
Tableau Server：Web 服
务器向受信任的 Tableau
Server 例如
http://tabaserver/tr
usted，而非
http://tabserver 发
送了 POST 请求。该 POST
请求必须有一个
username 参数。
username 值必须是
Tableau Server 许可用户的
用户名。如果服务器在运
行多个站点，且视图在
Default 站点之外的其他站
点上，则 POST 请求还必
须包含 target_site 参
数。
Tableau Server 创建票
证：Tableau Server 检查发
送 POST 请求的 Web 服务
器的 IP 地址或主机名 上
图中的 192.168.1.XXX 。
如果该服务器已设置为受
信任主机，则 Tableau
Server 将创建一个票证，
形式为包含 24 个字符的唯
一字符串 URL 安全、
Base64 编码 。Tableau
Server 使用该票证来响应
POST 请求。如果存在错
误并且无法创建票证，则
Tableau Server 将使用值“1”进行响应。
Web 服务器将 URL 传递给浏览器：Web 服务器
使用该视图的 URL 或其对象标记 如果是嵌入
式视图 构造该视图的 URL，并将其插到该网
页的 HTML 中。包括票证 例如
http://tabserver/trusted/<ticket>/views/requestedvie
wname 。Web 服务器将该网页的所有 HTML
传递回客户端的 Web 浏览器。
浏览器从 Tableau Server 请求视图：客户端
Web 浏览器使用 GET 请求向 Tableau Server 发送
请求，该 GET 请求包含带有票证的 URL。
Tableau Server 兑换票证：Tableau Server 检查
是否 Web 浏览器请求了含有票证的 URL，并兑
换该票证。票证必须在发出后三分钟内兑换。
票证必须在发出后三分钟内兑换。兑换票证
后，Tableau Server 将用户登录，从 URL 中删除
该票证，并发送回该嵌入式视图的最终 URL。
- 247 -
向 Tableau Server 添 加 受 信 任 的 IP 地 址 或 主 机 名 称
设置受信任的身份验证的第一步是将 Tableau Server 配置为识别并信任来自一个或多
个 Web 服务器的请求：
1. 以管理员身份打开命令提示符，导航到 Tableau Server 的 bin 目录
C:\Program Files\Tableau\Tableau Server\8.2\bin 。
例如
2. 然后键入以下命令：
tabadmin set wgserver.trusted_hosts "<trusted IP addresses or
host names>"
在上面的命令中，<trusted IP addresses> 应是您的 Web 服务器的 IPv4 地
址或主机名称的逗号分隔列表。例如：
tabadmin set wgserver.trusted_hosts "192.168.1.101,
192.168.1.102, 192.168.1.103"
或
tabadmin set wgserver.trusted_hosts "webserv1, webserv2,
webserv3"
注意：
该逗号分隔列表应位于引号内，每个逗号后跟一个空格。
指定的 Web 服务器必须使用静态 IP 地址，即使在此处使用主机名称也一
样 了解详情 。
3. 如果请求受信任票证的计算机 上面的步骤 2 中配置的计算机之一 和 Tableau
Server 之间有一个或多个代理服务器，则还需要将这些代理服务器添加为受信
任网关。有关步骤，请参见配置 Tableau 以使用代理服务器 在本页 244。
4. 最后，键入以下命令以重新启动服务器：
tabadmin restart
接下来，您需要配置 Web 服务器以便从 Tableau Server 接收票证。
从 Tableau Server 获 取 票 证
在向 Tableau Server 添加受信任的 IP 地址之后，您就可以将 Web 服务器配置为通过
POST 请求从 Tableau Server 获取票证 图中的步骤 3 。POST 请求必须发送至
http://<server name>/trusted，例如 http://tabserv/trusted，而非
http://tabserv。
有关可用来以 Java、Ruby 和 PHP 创建 POST 请求的代码示例，请参见以下内容：
C:\Program Files\Tableau\Tableau Server\8.2\extras\embedding
- 248 -
下面是可在向 Tableau Server 发送的 POST 请求中使用的数据：
l
l
l
username=<username> 必需 ：Tableau Server 许可用户的用户名。如果使
用的是本地身份验证，则用户名可以是简单字符串 例如，
username=jsmith 。如果将 Active Directory 用于多个域，则用户名中必须包
含域名 例如，username=MyCo\jsmith 。
target_site=<site id> 如果视图不在默认站点上，则为必需 ：如果
Tableau Server 运行多个站点，并且视图位于默认站点之外的其他站点上 例
如，target_site=Sales ，则指定包含该视图的站点。用于 <site id> 的
值应为创建该站点时提供的站点 ID。此值区分大小写。如果站点 ID 为
SAles，则 target_site=SAles。
client_ip=<IP address> 可选 ：用于指定 Web 浏览器要访问该视图的
计算机的 IP 地址 例如，client_ip=123.45.67.891 。该地址不是发出
Tableau Server 的 POST 请求的 Web 服务器 IP 地址。如果您决定使用此参数，
请参见可选： 配置客户端 IP 匹配 在本页 251以了解更多信息。
Tableau Server 对 POST 请求的响应将是一个包含 24 个字符的唯一字符串 即票
证 。如果 Tableau Server 无法处理该请求，则返回 -1。有关如何更正此问题的提
示，请参见从 Tableau Server 返回了票证值 -1 在本页 251。同样，为了让用户在单
击嵌入视图时成功进行身份验证，其服务器必须配置为允许第三方 Cookie。
接下来，您需要添加一段代码以允许 Web 服务器为该视图构造 URL，此 URL 应包含
该视图的位置以及票证。
显示视图及票证
在创建 POST 请求之后，您需要编写一段代码，以便向 Web 服务器提供来自 Tableau
Server 的视图位置和票证。服务器将使用此信息来显示视图。如何指定取决于视图是
否为嵌入式视图以及 Tableau Server 是否运行多个站点。
Tableau Server 视 图 示 例
下面是如何指定用户仅通过 Tableau Server 访问的视图的示例
图 。
该视图不是嵌入式视
http://tabserver/trusted/<ticket>/views/<workbook>/<view>
如果 Tableau Server 正在运行多个站点，并且该视图位于 Default 站点之外的其他站点
上，则需要向该路径添加 t/<site ID>。例如：
http://tabserver/trusted/<ticket>/t/Sales/views/<workbook>/<view>
使用在 Tableau Server URL 中看到的相同大小写形式。
嵌入式视图示例
下面是如何指定嵌入式视图的示例。您可采用两种方法来编写嵌入代码，下面便提
供了这两种方法。无论您采取哪种方法，您都必须提供一些唯一信息以便进行受信
- 249 -
任的身份验证。
脚本标记示例
此示例使用了 ticket 对象参数：
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="name" value="MyCoSales/SalesScoreCard" />
<param name="ticket" value="Etdpsm_Ew6rJY-9kRrALjauU" />
</object>
对于多站点 Tableau Server，以上示例为以下内容
的 ：
视图是在 Sales 站点上发布
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<object class="tableauViz" width="800" height="600"
style="display:none;">
<param name="site_root" value="/t/Sales" />
<param name="name" value="MyCoSales/SalesScoreCard" />
<param name="ticket" value="Etdpsm_Ew6rJY-9kRrALjauU" />
</object>
您可使用 path 参数来显式声明该视图的完整路径，而不使用 ticket。使用 path
时，也不需要 name 参数，此参数在 Tableau JavaScript 嵌入代码中通常是必需参数。
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<object class="tableauViz" width="900" height="700"
style="display:none;">
<param name="path" value="trusted/Etdpsm_Ew6rJY9kRrALjauU/views/MyCoSales/SalesScoreCard" />
</object>
下面是同一示例，但这次针对的是多站点服务器。请注意，此处使用的是 /t/<site
ID>：
<script type="text/javascript"
src="http://myserver/javascripts/api/viz_v1.js"></script>
<object class="tableauViz" width="900" height="700"
style="display:none;">
<param name="path" value="trusted/Etdpsm_Ew6rJY9kRrALjauU/t/Sales/views/MyCoSales/SalesScoreCard" />
</object>
Iframe 标记示例
- 250 -
<iframe src="http://tabserver/trusted/Etdpsm_Ew6rJY9kRrALjauU/views/workbookQ4/SalesQ4?:embed=yes" width="800"
height="600"></iframe>
可 选 ： 配 置 客 户 端 IP 匹 配
默认情况下，Tableau Server 在创建或兑换票证时不考虑客户端 Web 浏览器的 IP 地
址。若要对此进行更改，需要执行以下两个操作：在获取票证的 POST 请求中，使用
client_ip 参数指定一个 IP 地址，然后执行下面的步骤以配置 Tableau Server，以便
强制客户端 IP 地址匹配。
1. 打开命令窗口，并将目录更改为 Tableau Server 的 bin 目录中的位置。默认位置
为 C:\Program Files\Tableau\Tableau Server\8.2\bin
2. 以管理员身份打开命令提示符，然后键入以下命令：
tabadmin set wgserver.extended_trusted_ip_checking true
3. 然后键入以下命令：
tabadmin configure
4. 最后，通过键入以下内容重新启动服务器：
tabadmin restart
受信任的身份验证疑难解答
下面是配置受信任的身份验证时可能会遇到的一些常见问题和错误。受信任的身份
验证信息写入 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\vizqlserver\vizql-*.log。若要将日志记录级别
从 info 提高到 debug，请使用 tabadmin 设置 vizqlserver.trustedticket.log_level。
有关测试受信任的身份验证的提示，请参见 Tableau 知识库。
从 Tableau Server 返 回 了 票 证 值 -1
Tableau Server 在不能将票证作为受信任的身份验证过程的一部分发出时会返回票证
值“-1”。此消息的确切原因将写入到以下文件夹中的文件 production*.log 中：
ProgramData\Tableau\Tableau Server\data\tabsvc\logs\wgserver
以及以下文件夹中的 vizql*.log：
ProgramData\Tableau\Tableau Server\data\tabsvc\logs\vizqlserver
以下是需确认的一些内容：
- 251 -
l
所有 Web 服务器主机名称或 IP 地址都已添加到受信任主机
发送 POST 请求的计算机的 IP 地址或主机名称必须位于 Tableau Server 上的受
信任主机列表中。若要了解如何向此列表添加 IP 地址或主机名称，请参见向
Tableau Server 添加受信任的 IP 地址或主机名称 在本页 248。
l
wgserver.trusted_hosts 值的格式正确
使用 wgserver.trusted_hosts 设置提供的受信任主机列表必须是逗号分隔的列
表，每个逗号后有一个空格。例如，该列表应与下面类似：192.168.1.101,
192.168.1.102, 192.168.1.103, 或 bigbox1.example.lan, bixbox2.example.lan,
bigbox3.example.lan。
l
IP 地址是 IPv4
如果使用 IP 地址指定受信任主机，它们必须采用 Internet 协议版本 4 (IPv4) 格
式。IPv4 地址如下所示：123.456.7.890。不支持使用 IPv6 地址 例如
fe12::3c4a:5eab:6789:01c%34 输入受信任主机。
l
POST 请求中的用户名是有效的 Tableau Server 用户
在 POST 请求中发送的用户名必须是具有 Viewer 或 Interactor 许可级别的
Tableau Server 许可用户。通过以管理员身份登录到 Tableau Server 中并单击页
面左侧的“许可”链接，可查看用户及其许可级别的列表。
l
POST 请求中的用户名包含域
如果将 Tableau Server 配置为使用本地身份验证，则在 POST 中发送的用户名可
以是简单字符串。但是，如果将服务器配置为使用 Active Directory，则必须在
用户名中包含域名 域\用户名 。例如，username 参数可能
是：username=dev\jsmith
l
内容类型已指定
如果您要设计一个 ASP.NET 或 C# 应用程序，则需要在您的 HTTP 请求中声明
内容类型。例如，http.setRequestHeader("ContentType","application/x-www-form-urlencoded;charset=UTF-8")。如
果您没有指定内容类型且 Tableau Server 返回 -1，则日志文件包含错误："用户
名和/或 client_ip 丢失”。
HTTP 401 – 未 授 权
如果收到“401 - 未授权”错误，则可能是因为您已将 Tableau Server 配置为将 Active
Directory 与 SSPI 结合使用 请参见启用自动登录 。如果您的 Web 服务器使用
SSPI，则无需设置受信任的身份验证。您可以嵌入视图，这样，只要您的用户是
Tableau Server 许可用户并且是您的 Active Directory 的成员，他们就可以访问这些视
图。
不支持同时使用“启用自动登录”和受信任的身份验证。
- 252 -
HTTP 404 – 未 找 到 文 件
如果您的程序代码引用不存在的 Tableau Server URL，就可能会收到此错误。例如，
您的 Web 服务器可能会构造一个网页尝试检索时找不到的无效 URL。
无效用户
SharePoint 或 C#
如果您将 Tableau Server 配置为使用受信任的身份验证，则可能会遇到此错误。
SharePoint .dll 的示例代码引用以下 GET 请求：
SPContext.Current.Web.CurrentUser.Name
上面的请求将返回当前 Windows Active Directory 用户的显示名称。如果要使用登录
ID，则需要将代码更改为：
SPContext.Current.Web.CurrentUser.LoginName
进行更改后，请重新编译 SharePoint .dll。
尝 试 从 错 误 的 IP 地 址 检 索 票 证
如果您将 Tableau Server 配置为使用受信任的身份验证，则可能会遇到此错误。
默认情况下，兑换票证时不会考虑客户端 Web 浏览器 IP 地址。如果将 Tableau Server
配置为强制客户端 IP 地址匹配，请确保在 POST 中发送给 Tableau Server 的客户端
Web 浏览器 IP 地址与浏览器尝试检索嵌入式视图时的 IP 地址相同。例如，在受信任
的身份验证图中，如果步骤 3 中的 POST 请求发送参数 client_ip=74.125.19.147，则步
骤 5 中的 GET 请求必须来自同一 IP 地址。
若要了解如何配置 Tableau Server 以强制客户端 IP 地址匹配，请参见可选： 配置客
户端 IP 匹配 在本页 251。
Cookie 限 制 错 误
用户登录到 Tableau Server 时，会话 Cookie 会存储到他们的本地浏览器中。Tableau
Server 利用存储的 Cookie 来保留通过身份验证且可访问服务器的已登录用户。由于
Cookie 设置的域或子域与浏览器地址栏中的域或子域相同，因此该 Cookie 被认定为
第一方 Cookie。如果用户浏览器配置为阻止第一方 Cookie，则它们将无法登录到
Tableau Server。
如果用户通过嵌入式视图或在配置了受信任的身份验证的环境中登录到 Tableau
Server，则会发生同样的情况：系统会存储此 Cookie。但在这种情况下，浏览器会将
此 Cookie 当做第三方 Cookie 来处理。这是由于 Cookie 设置的域与浏览器地址栏中显
示的域不同。如果用户 Web 浏览器设置为阻止第三方 Cookie，则此 Cookie 将无法通
过 Tableau Server 所需的身份验证。要避免出现这种情况，Web 浏览器必须配置为允
许第三方 Cookie。
- 253 -
与 服 务 器 通 信 时 出 错 (403)
如果 Tableau Server 配置为使用受信任的身份验证，在浏览器中打开新视图并尝试导
航回之前打开的视图时，可能会收到此错误消息。Tableau Server 通过 tabadmin set 选
项 vizqlserver.protect_sessions 默认情况下设置为 true 防止未经授权地重用 VizQL
会话。由于 Tableau Server 配置为使用受信任的身份验证，因此您可能不需要同时启
用 vizqlserver.protect_sessions。若要禁用它，请使用 set 在本页 319 将其更
改为 false。
- 254 -
保护云端数据源的凭据
对于一些基于云的数据源，在 Tableau Server 中存储敏感数据库凭据的替代方法是在
Tableau 和数据源提供程序之间建立有限用途的信任关系。通过这种关系，您可以访
问您的数据，同时通过数据源提供程序保证您的凭据安全。
若要建立这种类型的关系，您需要授权 Tableau 访问您的云数据。然后，云数据提供
程序向 Tableau 发送有限用途的访问令牌，它唯一地标识来自 Tableau 的请求并允许
Tableau 代表您访问数据。
Tableau 按照 OAuth 2.0 开放授权标准中的规定使用这些受保护连接。使用 OAuth 连
接可提供以下好处：
l
l
安全：您的敏感数据库凭据从不会被 Tableau Server 知道或存储在其中，并且
访问令牌只能由 Tableau 使用。
方便：不必在多个位置嵌入您的数据源 ID 和密码，您可以对访问特定数据提供
程序的所有已发布工作簿和数据源使用为该数据提供程序提供的令牌。
另外，对于 Google BigQuery 数据的实时连接，每个工作簿查看者都可以拥有标
识用户的唯一访问令牌，而不是共享单个用户名和密码凭据。
受保护身份验证适用于 Google BigQuery、Google Analytics 和 Salesforce.com 数据源。
受保护身份验证过程概述
下列步骤介绍 Tableau 环境中调用 OAuth 过程的一个工作流。
1. 您执行的操作需要访问云端数据源。
例如，您打开发布到 Tableau Server 的工作簿。
2. Tableau 将您定向到托管数据提供程序的登录页面。发送给托管数据提供程序
的信息将 Tableau 标识为请求站点。
3. 当您登录到托管数据源时，它会提示您确认您授权 Tableau Server 访问数据。
4. 确认后，数据源提供程序会向 Tableau Server 发送访问令牌。
- 255 -
5. Tableau Server 向您显示您的工作簿和数据。
下列是可以使用 OAuth 过程的其他工作流：
l
l
从 Tableau Desktop 或从 Tableau Server 创建工作簿并连接到数据源。
从 Tableau Desktop 发布数据源。
管理凭据
用户可以在用户首选项中管理他们自己的访问令牌，还可以选择只允许管理员和具
有“数据源连接器”角色的用户跨数据源和连接管理访问令牌。
不管访问令牌是用作已发布数据源的嵌入式凭据还是用于到 Google BigQuery 数据的
实时连接，以下说明都适用：
l
l
l
当 Tableau Server 通过访问令牌所表示的连接请求数据时，数据源提供程序通
过该令牌确认授权的 Tableau 访问，然后返回请求的数据。您无需每次连接时
都提供凭据。
如果令牌用作已发布数据源的嵌入式凭据，则您可以从 Tableau Desktop 或
Tableau Server 创建连接到该数据的新工作簿，而不必每次访问数据时都登录。
除非用户或数据提供程序撤消访问令牌，否则它们会一直有效。
注意：可能超出了数据源提供程序允许的访问令牌数。在这种情况下，
当创建新令牌时，数据提供程序将使用自上次访问以来已经过去的时间
长度来决定使哪个令牌失效以便为新令牌腾出空间。数据提供程序还可
以出于其他原因使令牌失效。例如，管理员可能撤消所有应用程序访问
权限。
- 256 -
配 置 服 务 器 以 支 持 OAuth
OAuth 不使用单个用户名和密码，而是使用有限用途的访问令牌。您需要先配置服务
器以便发送令牌的数据提供程序可以将 Tableau Server 识别为受信任目标，然后您才
能获得在 Tableau 中创建 OAuth 连接所需的访问令牌。下面一节介绍如何准备设置
OAuth，而不考虑数据提供程序。它下面列出的主题包含针对特定数据提供程序配置
服务器的步骤。
为 配 置 OAuth 支 持 做 准 备
开始数据提供程序特定的配置步骤之前，请先满足以下先决条件：
l
获取将承载连接到此数据源的视图的每个 Tableau Server 节点的完全限定域
名。例如：
https://sales.your_domain.com
如果使用 Salesforce.com，将需要提供 https 地址。
l
确保至少为一个数据提供程序帐户启用 API 访问。
对于 Google BigQuery 和 Google Analytics，您需要访问 Google Cloud Platform
上的开发人员控制台。
对于 Salesforce.com，您需要访问 Force.com 平台。
l
确保您有数据源的最新驱动程序。
对于 Google BigQuery，使用 32 位版本。
您可以从 Tableau 网站上的驱动程序和激活页下载更新的驱动程序。
配置数据提供程序的设置
完成 OAuth 准备步骤后，可以对数据提供程序配置适当的设置。
l
l
为 Google 设置 OAuth 向下
为 Salesforce.com 设置 OAuth 在本页 261
为 Google 设 置 OAuth
本主题介绍如何设置 Google BigQuery 和 Google Analytics 数据源以使用 OAuth。为每
个 Tableau Server 实例完成这些步骤。
注意：在完成这些步骤之前，确保您已完成为配置 OAuth 支持做准备 向上中
介绍的步骤。
通过执行以下两个过程设置 OAuth：
- 257 -
l
l
从 Google 获得必需信息并启用 API 访问。
使用您获得的信息配置服务器。
获 取 客 户 端 ID 并 启 用 Google API
注意：这些步骤反映编写本文时 Google Cloud Platform 控制台中的设置。有关详
细信息，请参见 Google 开发人员控制台帮助中的对 Web 服务器应用程序使用
OAuth 2.0。
1. 登录到 Google Cloud Platform，然后单击“Go to my console”。
2. 选择“Projects”，然后在“Project”页上，单击“Create Project”。
3. 在出现的新项目表单中，完成以下操作：
l
l
为项目提供一个有意义的名称，以反映您将对其使用此项目的 Tableau
Server 实例。
确定您是否要更改项目 ID。
注意：在创建项目后，您将无法更改项目 ID。有关信息，请单击问
- 258 -
号图标。
4. 打开新项目，然后导航到“APIs & auth”>“Credentials”。
5. 单击“Create a New Client ID”，然后在“Create Client ID”页中，完成以下操作：
l
l
l
选择“Web Application”。
对于“Authorized JavaScript Origins”，键入您的 Tableau Server 的本地计算机
名称。
对于“Authorized Redirect URI”，将现有文本替换为您服务器的 Internet 地
址，并将以下文本添加到它的末尾：auth/add_oauth_token。例如：
https://data.your_server.com/auth/add_oauth_token
6. 单击“Create Client ID”。
7. 复制 Google 返回的以下值，并将其粘贴到您可以从 Tableau Server 计算机访问
的位置：
l
客户端 ID
l
客户端密码
l
重定向 URI
8. 在 Google 开发人员控制台中，打开您的新项目，选择“APIs & auth”>“APIs”，
然后针对“BigQuery API”或“Analytics API”将状态设置为“On”。
为 Tableau Server 配 置 Google OAuth
使用您通过完成获取客户端 ID 并启用 Google API 上一页 中的步骤获得的信息，您
可以配置您的 Tableau Server：
- 259 -
1. 在 Tableau Server 计算机上，以管理员身份打开命令提示符，并转到 Tableau
Server bin 目录。
cd C:\Program Files\Tableau\Tableau Server\<version>\bin
2. 键入以下命令停止服务器：
tabadmin stop
3. 键入以下命令使用您从 Google 获得的客户端 ID 和客户端密钥以及您的服务器
URI 配置服务器。在每个命令后按 Enter。
tabadmin set oauth.google.client_id <your_client_ID>
tabadmin set oauth.google.client_secret <your_client_secret>
tabadmin set oauth.google.redirect_uri <your_server_URI>
4. 键入以下命令完成配置并重新启动服务器：
tabadmin config
tabadmin start
允许用户保存访问令牌
OAuth 连接是通过访问令牌生成的，不使用单个用户名和密码。
服务器管理员可使用管理界面 (A) 允许用户在其“用户首选项”页 (B) 上管理其各自的
访问令牌。
启用这些设置：
1. 打开 Web 浏览器并登录到服务器。
2. 在“管理”选项卡上，显示“维护”页，然后在“设置”部分中，选中以下项：
- 260 -
l
保存密码以允许用户随数据源一起保存他们自己的凭据。
l
保存访问令牌以允许用户保存 OAuth 令牌。
服务器管理员也可以通过清除这些复选框并在发布数据源后编辑数据连接来集中管
理 OAuth 凭据。如果不启用用于保存密码和访问令牌的设置，则“用户首选项”页中将
不包括“管理凭据”部分。
为 Salesforce.com 设 置 OAuth
本主题介绍如何设置 Salesforce.com 数据源以使用 OAuth。为每个 Tableau Server 实例
完成这些步骤。
注意： 在完成这些步骤之前，确保您已完成为配置 OAuth 支持做准备 在本页
257中介绍的步骤。
通过执行以下两个过程设置 OAuth：
l
l
在 Salesforce 中创建连接的应用
使用您获得的信息配置服务器。
创 建 连 接 的 Salesforce 应 用
1. 登录您的 Salesforce.com 开发人员帐户，单击右上方您的用户名，然后选择“设
置”。
2. 在左侧导航列中的“应用设置”下，选择“创建”>“应用”。
3. 在“已连接应用”部分，单击“新建”。
- 261 -
4. 填写“基本信息”，然后在 API 部分选择“启用 OAuth 设置”。
5. 在出现的新 OAuth 设置中，对于“回调 URL”，键入您的服务器的完全限定域名
使用 https 协议 ，并将以下文本追加到 URL：auth/add_oauth_token。
例如：
https://www.your_server.com/auth/add_oauth_token
6. 将下列项目从可用 OAuth 范围移到所选 OAuth 范围：
l
访问和管理您的数据 (api)
l
访问您的基本信息 (id)
l
随时代表您执行请求 (refresh_token)
7. 单击“保存”。
在保存应用后，Salesforce 会在 API 部分中填充以下将用于配置 Tableau Server 的
ID：
l
l
l
使用者密钥
使用者密码
回调 URL
将 Tableau Server 配 置 为 使 用 Salesforce.com OAuth
1. 在 Tableau Server 计算机上，以管理员身份打开命令提示符，并转到 Tableau
Server bin 目录：
cd C:\Program Files\Tableau\Tableau Server\<version>\bin
2. 键入以下命令停止服务器：
tabadmin stop
3. 键入以下命令使用您从 Salesforce 获得的使用者 ID 和密钥以及回调 URL 配置服
务器。在每个命令后按 Enter：
- 262 -
tabadmin set oauth.salesforce.client_id <your_consumer_ID>
tabadmin set oauth.salesforce.client_secret <your_consumer_
secret>
tabadmin set oauth.salesforce.redirect_uri <your_callback_
URL_>
4.
可选
要更改默认登录服务器，请键入以下命令：
tabadmin set oauth.salesforce.server_base_url <URL>
默认情况下，这设置为 https://login.salesforce.com。
5. 键入以下命令完成配置并重新启动服务器：
tabadmin config
tabadmin start
允许用户保存访问令牌
OAuth 连接是通过访问令牌生成的，不使用单个用户名和密码。
服务器管理员可使用管理界面 (A) 允许用户在其“用户首选项”页 (B) 上管理其各自的
访问令牌。
启用这些设置：
1. 打开 Web 浏览器并登录到服务器。
2. 在“管理”选项卡上，显示“维护”页，然后在“设置”部分中，选中以下项：
l
保存密码以允许用户随数据源一起保存他们自己的凭据。
l
保存访问令牌以允许用户保存 OAuth 令牌。
服务器管理员也可以通过清除这些复选框并在发布数据源后编辑数据连接来集中管
理 OAuth 凭据。如果不启用用于保存密码和访问令牌的设置，则“用户首选项”页中将
不包括“管理凭据”部分。
- 263 -
SAML
您可以将 Tableau Server 配置为使用外部身份提供程序 (IdP) 通过 SAML 对 Tableau
Server 用户进行身份验证。所有用户身份验证都在 Tableau 外部进行，无论您是使用
Active Directory 还是 Tableau Server 中的本地身份验证来管理 Tableau Server 上的用户
帐户。这使您能够在组织中的所有应用程序之间提供单点登录体验。
注意：IdP 提供的身份验证是一次性限时令牌。
有关 SAML 的详细信息，请参见下面的链接:
SAML 身 份 验 证 的 工 作 原 理
SAML 是基于 XML 的开放标准，用于在服务提供程序 此处为 Tableau Server 和身
份提供程序 (IdP) 之间交换身份验证信息。将 Tableau Server 配置为使用 SAML 时，会
使用第三方 IdP 来验证用户身份并将身份信息以数字签名的 XML 文档的形式传递给
Tableau Server。
用户尝试访问 Tableau Server 工
作簿链接或其他资源。
IdP 向 Tableau Server 发送
SAML 成功响应。
Tableau Server 启动身份验证进
程并将用户重定向到 IdP。
用户在 Tableau Server 上打
开工作簿。
Tableau
Server
用户帐
户。此
用户名
必须与
IdP 存
储为用
户名 (
IdP 验证用户身份。
- 264 -
)的
内容相
匹配。
IdP 上
的用户
帐户。
SAML 要 求
若要将 Tableau Server 配置为使用 SAML，您需要以下内容：
证书文件： PEM 编码的 x509 证书，文件扩展名为 .crt。此文件由 Tableau Server 而非
IdP 使用。
证书密钥文件： 未受密码保护的 RSA 或 DSA 私钥文件，文件扩展名为 .key。此文件
由 Tableau Server 而不是 IdP 使用。
IdP 帐户： 您需要一个外部身份提供程序帐户。例如 PingFederate、SiteMinder 和
Open AM。
名为 username 的属性： 必须将身份提供程序配置为在 SAML 响应中返回名为
username 的属性。若要将此默认属性更改为其他值，请使用 tabadmin 设置
wgserver.saml.idpattribute.username。
匹配的用户名： Tableau Server 用户名与 IdP 中存储的用户名必须匹配。 例如，如果
史珍妮的用户名在 PingFederate 中存储为 jsmith，那么它在 Tableau Server 中也必须存
储为 jsmith。 此外，如果在 Tableau Server 安装过程中配置 SAML，则安装过程将会创
建 Tableau Server 管理员帐户。在运行安装程序之前，请确保您的 IdP 中存在计划要
使用的帐户。
无 Active Directory 自动登录： 如果您使用 SAML 且 Tableau Server 还配置为使用
Active Directory 来进行用户管理，请不要同时选择“启用自动登录”。
仅限分布式安装：配置为使用 SAML 的群集必须在运行应用程序服务器进程的每台
Tableau Server 上都有 SAML 证书和密钥文件。有关详细信息，请参见将服务器群集
配置为使用 SAML。
SAML
可以将 Tableau Server 配置为使用外部身份提供程序 (IdP) 通过 SAML 对 Tableau
Server 用户进行身份验证。所有用户身份验证都在 Tableau 中完成，无论您是使用
Active Directory 还是 Tableau Server 中的本地身份验证来管理 Tableau Server 上的用
户。这使您能够在组织中的所有应用程序之间提供单点登录体验。
在将 Tableau Server 配置为使用 SAML 之前，确保满足 SAML 要求 向上。
- 265 -
配 置 SAML
将 Tableau Server 配置为使用 SAML：
1. 将证书文件放在与 Tableau Server 8.2 文件夹同级的名为 SAML 的文件夹中。例
如：
C:\Program Files\Tableau\Tableau Server\SAML
此位置为运行 Tableau Server 的帐户提供这些文件的必要权限。
2. SAML 配置在“SAML”选项卡上完成，Tableau Server 安装过程中会显示该选项
卡。如果在安装后配置 SAML，请通过打开 Tableau Server 配置实用工具 开始
> 所有程序 > Tableau Server 8.2 > 配置 Tableau Server 并单击“SAML”选项卡
来访问 SAML。
3. 在“SAML”选项卡上，选择“使用 SAML 进行单点登录”并提供以下各项的位置：
Tableau Server 返回 URL － Tableau Server 用户将访问的 URL，例如
http://tableau_server。不建议使用 http://localhost，也不支持结尾有斜杠的 URL
例如，http://tableau_server/ 。
SAML 实体 ID - 实体 ID 可向 IdP 唯一地标识您的 Tableau Server 安装。如果您愿
意，可以在此处再次输入 Tableau Server URL，但它不必非得是您的 Tableau
Server URL。
SAML 证书文件 - PEM 编码的 x509 证书，文件扩展名为 .crt。此文件由 Tableau
Server 而不是 IdP 使用。
SAML 证书密钥文件 - 不受密码保护的 RSA 或 DSA 私钥文件，文件扩展名为
.key。此文件由 Tableau Server 而不是 IdP 使用。
4. 暂时将“SAML IdP 元数据文件”文本框保留为空，然后单击“导出元数据文件”。
- 266 -
5. 将会打开一个对话框，允许您将 Tableau Server 的 SAML 设置保存为 XML 文
件。此时，不包括来自 IdP 的元数据。
使用所选名称保存 XML 文件。
6. 在您的 IdP 网站上或在其应用程序中：
l
l
将 Tableau Server 作为服务提供程序添加。您需要查阅 IdP 的文档，了解
如何操作。在此过程中，您将导入在步骤 5 中保存的文件。
确认您的 IdP 使用“用户名”作为要验证的属性元素。
7. 仍然是在 IdP 中，导出您的 IdP 的元数据 XML 文件。
8. 将 IdP 的元数据 XML 文件复制到 Tableau Server 计算机上的以下文件夹：
C:\Program Files\Tableau\Tableau Server\SAML
9. 在“Tableau Server 配置”对话框的“SAML”选项卡上，在“SAML IdP 元数据文件”
文本框中输入文件位置：
10. 单击“确定”。Tableau Server 现在已配置为使用 SAML 身份验证。
将 Server 群 集 配 置 为 使 用 SAML
当您将 Tableau Server 群集配置为使用 SAML 时，您需要将 SAML 证书和密钥文件放
置在运行 Tableau 应用程序服务器进程 又称为 wgserver 的每台计算机上。将
Tableau Server 群集配置为使用 SAML：
1. 按照上面过程中所述配置主 Tableau Server。
2. 将您用于此主服务器的同一 SAML 证书和密钥文件放置在运行应用程序服务器
进程的每台 Tableau 工作计算机上。对工作计算机使用您用于主服务器的相同
- 267 -
文件夹位置。您无需对工作计算机执行任何其他配置。
例如，使用包含一台主 Tableau Server 和三台工作计算机的群集。应用程序服
务器进程运行在主服务器、工作计算机 2 和 工作计算机 3 上。在此情况下，您
将主 Tableau Server 配置为使用 SAML，然后将同一 SAML 证书和密钥文件复制
到工作计算机 2 和工作计算机 3 上。因为这些文件在主服务器上位于
C:\Program Files\Tableau\Tableau Server\SAML 文件夹中，因此它们在工作计算
机 2 和工作计算机 3 上也位于这一相同位置。
测试配置
打开一个新的 Web 浏览器实例并在 URL 窗口中键入 Tableau Server 名称，来测试您
的 SAML 配置：
您应该会注意到出现的登录提示来自 IdP 而不是 Tableau Server：
SAML 疑 难 解 答
使用以下主题排查 SAML 问题。
- 268 -
SAML 和 “启 用 自 动 登 录 ”
如果您使用 SAML 且 Tableau Server 还配置为使用 Active Directory，请不要同时选择
“启用自动登录”。 “启用自动登录”和 SAML 不能同时使用。
从命令行登录
即使 Tableau Server 配置为使用 SAML，但如果您使用命令行工具 tabcmd 在本页 289
或 Tableau 数据提取命令行实用工具 随 Tableau Desktop 提供 登录 Tableau
Server，也不会使用 SAML。
登录失败
如果收到消息“登录失败：用户 <username from IdP> 的身份提供程序身份验证成功。
未在 Tableau Server 中找到该用户”，则表示 Tableau Server 中存储的用户名与 IdP 中
存储的用户名不同。若要解决此问题，请确保它们匹配。例如，如果史珍妮的用户
名在 IdP 中存储为 jsmith，那么它在 Tableau Server 中也必须存储为 jsmith。
SAML 错 误 日 志
SAML 登录错误记录在以下位置。可使用此日志排查问题。
C:\ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\wgserver\error.log
- 269 -
用户运行身份
您可以使用专用的 Active Directory (AD) 用户帐户来运行 Tableau Server 服务，此帐户
称为“用户运行身份”帐户。某些管理员会选择当 Tableau Server 上的已发布工作簿连
接到实时数据源时执行此操作。服务器的默认网络服务帐户 (NT
AUTHORITY\NetworkService) 不具有用于连接到其他计算机上的数据源的正确权限。
而正确配置的 AD 帐户有这种权限。
对于需要 NT 身份验证的数据源，AD 帐户也可以自动处理身份验证进程，这样在工
作簿连接到实时数据源时，用户就不会收到提供凭据的提示。最后，专用于特定资
源的用户运行身份 AD 帐户同与某个人关联的 AD 帐户相比，在管理时通常更不容易
出现问题。
若要将 Tableau Server 配置为使用用户运行身份帐户，请按以下步骤操作。如果您运
行的是 Tableau Server 的分布式安装，那么这些步骤应该在工作服务器和主服务器上
执行。 另外请注意，确认运行身份帐户设置 在本页 273中的步骤可能因站点而异。
注意：
如果您使用用户运行身份帐户来安装 Tableau Server，则在安装之前，请先确认
Windows Secondary Login 服务具有正确的“登录”和“启动”值。有关详细信息，请参见
验证 Tableau Service 设置 向下。
标识帐户
第一步是标识或创建用于运行 Tableau Server 服务的 Active Directory 帐户。该帐户将
是 Tableau Server 的用户运行身份帐户，应具有以下内容：
l
l
l
通过至少读取访问连接到数据源的权限。
允许 Tableau Server 通过数据源实现 NT 身份验证过程的凭据。执行 NT 身份验
证的 Microsoft 数据源包括 Microsoft SQL Server 和 Microsoft Analytical Services
(MSAS)，但不包括 Access 或 Excel。
向 Active Directory 域控制器查询用户和组的权限。在运行 Tableau Server 的本地
计算机上创建的用户帐户可能没有这些权限。
确认域双向信任
确认在满足以下任何条件的情况下域之间存在双向信任：
l
承载 Tableau Server 和数据源的计算机位于单独的域中。
l
Tableau Server 用户位于与 Tableau Server 或数据源分离的域中。
验 证 Tableau Service 设 置
确认为 Tableau Service 分配了正确的“登录”和“启动”值： 如果您运行的是 Tableau
Server 的分布式安装，请在工作服务器及主服务器上执行这些步骤。
- 270 -
1. 以管理员身份登录到运行 Tableau Server 的计算机。
2. 在 Tableau Server 计算机上，选择“开始”>“控制面板”>“管理工具”>“计算机管
理”>“服务和应用程序”>“服务”。
3. 打开“服务和应用程序”，然后单击“服务”。确认以下服务具有正确设置：
启
动
服务名称
登录值
值
FLEXnet
本地系统
手
Licensing Service
动
Secondary Login 本地系统
自
动
Tableau Server
<domain>\<username> 这是用户运行身份 自
(tabsvc)
帐户。请参见下面。
动
Tablicsrv
本地系统
自
动
更 改 “登 录 ”值
将 Tableau Server (tabsvc) 的“登录”值更改为用户运行身份帐户：
1. 在“服务”窗口中，通过右键单击 Tableau Server (tabsvc) 并选择“停止”停止
Tableau Server 服务。
2. 选择“开始”>“所有程序”>“Tableau Server”>“配置 Tableau Server”。
3. 在“常规”选项卡上，输入 Tableau Server 用户运行身份帐户的域、用户名和密
码。
4. 单击“确定”，然后重新启动 Tableau Server (tabsvc)。
准备本地安全策略
如果用户运行身份帐户不是 Tableau Server 计算机 如果运行的是分布式安装，则为
主服务器和工作服务器 上的管理员，则必须准备该计算机的本地安全策略，以便
Tableau Server 用户运行身份帐户可作为服务登录到该计算机并进行配置更改。请执
行以下操作：
1. 选择“开始”>“控制面板”>“管理工具”>“本地安全策略”。
2. 在“本地安全设置”窗口中，打开“本地策略”，突出显示“用户权限分配”，然后右
键单击“作为服务登录”并选择“属性”。
- 271 -
3. 在“作为服务登录属性”窗口中，单击“添加用户或组”。
4. 键入 Tableau Server 用户运行身份帐户的 <domain>\<username>
MYCO\tableau_server ，然后单击“检查名称”。
例如：
5. 当帐户解析正确时，会带有下划线。单击“确定”。
6. 重复这些步骤以便将运行身份帐户添加到“本地登录”策略中。
7. 重复这些步骤以便从“拒绝登录”策略中移除运行身份帐户。
8. 单击“确定”关闭“本地安全设置”窗口。
配置数据源连接设置
若要在用户正在访问的工作簿连接到经过 NT 身份验证的实时数据源时自动对这些用
户进行身份验证，请在选中“使用 Windows NT 集成安全性”选项的情况下配置
Tableau 数据连接：
Windows NT 集成安全性
用户名和密码
使用服务器的用户运行身份帐户进行身份 每个 Tableau Server 用户都会看到要求提
验证
供数据库凭据的提示
- 272 -
Windows NT 集成安全性
用户名和密码
确认运行身份帐户设置
用户运行身份帐户需要允许其读取、执行和 有时 修改文件的权限。根据作为起
点使用的帐户，用户运行身份帐户可能已拥有正确的权限。无论何时更改服务器的
运行身份帐户，都应确认该帐户满足以下要求。如果您运行的是分布式安装，这同
时适用于主服务器和工作服务器。
授予读取和执行权限
用于运行 Tableau Server 服务的帐户需要读取和执行文件的权限。无论何时更改服务
器的用户运行身份帐户，都应确认或配置以下内容：
1. 在承载 Tableau Server 和 Tableau Worker，如果是分布式安装 的计算机上，
使用 Windows 资源管理器右键单击安装了 Tableau 的驱动器 如“本地磁盘
(C:)” ，然后选择“属性”。
2. 在“本地磁盘属性”窗口中，选择“安全”选项卡。
3. 单击“编辑”，然后单击“添加”。
4. 在“选择用户、计算机、服务帐户或组”对话框中，键入 Tableau Server 用户运行
身份帐户的 <domain>\<username>。不要使用组帐户。
5. 单击“检查名称”对该帐户进行解析，然后单击“确定”确认。
6. 当 Tableau Server 用户运行身份帐户突出显示时，确认其具有“读取和执行”权
限。选择“读取和执行”会自动选择“列出文件夹内容”和“读取”。
7. 单击“确定”退出。
授予修改权限
此帐户还需要执行类似创建日志文件这种操作的能力。确认或配置以下内容：
- 273 -
1. 导航到以下文件夹：
C:\Program Files\Tableau
C:\ProgramData\Tableau\
如果在 64 位操作系统上运行 32 位 Tableau Server，则需要转到
C:\Program Files (x86)\Tableau，而不是 C:\Program
Files\Tableau。此外，上面的驱动器和路径可能会根据 Tableau Server
的安装位置而有所不同。
2. 右键单击文件夹，选择“属性”，然后单击“安全”选项卡：
l
单击“编辑”，然后单击“添加”。
l
键入 Tableau Server 用户运行身份帐户的 <domain>\<username>。
l
单击“检查名称”对该帐户进行解析，然后单击“确定”确认。
l
当 Tableau Server 用户运行身份帐户突出显示时，确认其具有“修改”权
- 274 -
限。选择“修改”会自动授予除“完全控制”和“特殊权限”以外的所有权限：
3. 对于上面步骤 1 中的每个文件夹，在 Tableau 属性的“安全”选项卡上，单击“高
级”：
- 275 -
4. 在“Tableau 高级安全设置”窗口中，单击“更改权限”。
5. 在“Tableau 高级安全设置”对话框中，突出显示用户运行身份帐户，并选中“使
用可从此对象继承的权限替换所有子对象权限”复选框：
- 276 -
6. 单击“确定”将更改应用于所有子文件夹和文件，这可能需要几分钟。应用这些
更改时，通常会从 Windows 收到多个错误消息。不需要取消该过程；相反，请
单击“继续”。
7. 单击“确定”确认更改，然后单击“Tableau 属性”对话框中的“确定”。
修改注册表设置
以下步骤为可选步骤，大多数环境中都不用执行此步骤。如果注册表安全措施极其
严格，则向 Tableau Server 用户运行身份帐户授予对下面列出的注册表分支的读写权
限。注册表项根据您安装的是 32 位还是 64 位版本的 Tableau Server 而异，如果安装
的是 32 位 Tableau Server，还根据您是在 32 位还是 64 位操作系统上安装而异。64 位
Tableau Server 只能安装在 64 位操作系统上。
64 位 Tableau Server 安 装
l
HKEY_CURRENT_USER\Software\Tableau
l
HKEY_LOCAL_MACHINE\Software\Tableau
32 位 Tableau Server 安 装
l
HKEY_CURRENT_USER\Software\Tableau
l
32 位操作系统：HKEY_LOCAL_MACHINE\Software\Tableau
l
64 位操作系统：HKEY_LOCAL_MACHINE\Software\Wow6432Node\Tableau
和
- 277 -
SQL Server 模拟
模拟是一个用户帐户代表另一个用户帐户进行操作。您可以对 Tableau 和 Microsoft
SQL Server 进行配置以执行数据库用户模拟，这样 Tableau Server 所用的 SQL Server
数据库帐户代表同时也是 Tableau 用户的 SQL Server 数据库用户进行查询。
此功能的主要优点是，它允许管理员在一个位置，即在管理员数据库中实现和控制
其数据安全策略。当 Tableau 用户通过 SQL Server 数据库实时连接访问某一视图时，
该视图仅显示该用户的数据库权限允许其查看的内容。另外一个优点是，在访问视
图时，用户不必响应数据库登录提示。另外，工作簿发布者也不必依赖于用户特定
筛选器来限制视图中显示的内容。
有关使用此功能所需的更多信息，请参见以下主题。
模拟要求
下面是使用此功能需要满足的要求：
l
l
l
l
l
仅限于 SQL Server 实时连接： 模拟只能用于具有 SQL Server 数据库
更高版本 实时连接的视图。
2005 或
单个数据库帐户：将访问视图的每个人都必须在视图所连接的 SQL Server 数据
库中具有明确的单个帐户。不能对 Active Directory (AD) 组的成员进行模拟。例
如，如果 Jane Smith 是 AD 组“销售”的成员，并且她的数据库管理员将该“销
售”AD 组添加到 SQL Server 数据库，则不能对 Jane 进行模拟。
匹配凭据和身份验证类型： 每个 Tableau 用户帐户的凭据及其 Tableau 用户身
份验证类型都必须与其在 SQL Server 数据库中的凭据和身份验证类型匹配。换
言之，如果 Jane Smith 的 Tableau Server 用户帐户的用户名为 MyCo\jsmith 且
Tableau Server 要使用 Active Directory 进行身份验证，则她在 SQL Server 数据库
中的用户名必须也是 MyCo\jsmith，并且 SQL Server 必须使用 Windows 集成身份
验证。
SQL Server 先决条件：在 SQL Server 中，应具有一个数据安全表
施数据安全性的视图 ，并且应要求数据库用户使用该视图。
一个强制实
SQL IMPERSONATE 帐户： 您需要一个对上述数据库用户具有 IMPERSONATE
权限的 SQL Server 数据库帐户。该帐户是具有管理员角色的帐户，或者是对于
每个用户帐户都已被授予 IMPERSONATE 权限的帐户 请参见有关 EXECUTE
AS 的 MSDN 文章 。此 SQL Server 帐户必须也是 Tableau 端的两个帐户之一：
l
l
Tableau Server 用户运行身份帐户
拟 下一页 。
工作簿发布者帐户
281 。
请参见通过用户运行身份帐户进行模
请参见使用嵌入式 SQL 凭据进行模拟 在本页
模拟的工作原理
下图说明了数据库用户模拟的工作原理：
- 278 -
在上图中，Jane Smith (MyCo\jsmith) 是一名西海岸地区销售代表，Henry Wilson
(MyCo\hwilson) 是东部地区销售代表。在 SQL Server 数据库中，Jane 的帐户
MyCo\jsmith 的帐户权限仅允许她访问西海岸地区的数据。Henry 的帐户 MyCo\hwilson
只能访问东海岸地区的数据。
已创建了一个显示全国数据的视图。该视图具有 SQL Server 数据库实时连接。这两
个用户都登录到 Tableau Server 中并单击该视图。Tableau Server 使用一个对于每个用
户的数据库帐户都具有 IMPERSONATE 权限的数据库帐户连接到 SQL Server。此帐
户代表每个用户的数据库帐户进行操作。
当该视图显示时，它受每个用户的各数据库权限的限制：Jane 只能查看西海岸地区
的销售数据，Henry 只能查看东海岸地区的销售数据。
通过用户运行身份帐户进行模拟
建议通过用户运行身份帐户进行模拟。用户运行身份帐户是一个 AD 帐户，Tableau
Server 服务可使用此帐户在承载 Tableau Server 的计算机上运行 请参见用户运行身
份 在本页 270 。该帐户必须拥有 SQL Server 中数据库用户帐户的 IMPERSONATE
权限。从数据安全性角度看，通过使用 Tableau Server 运行身份帐户进行模拟，管理
员可进行最灵活的控制。
设置用户运行身份帐户模拟：
1. 在设置过程中配置 Tableau Server 时，在“服务器用户运行身份”下输入拥有用户
帐户的 IMPERSONATE 权限的用户运行身份 AD 帐户。在“用户身份验证”下，
选择“使用 Active Directory”：
- 279 -
2. 单击“确定”完成配置。
3. 在 Tableau Desktop 中创建一个工作簿。在创建数据连接时，对工作簿到 SQL
Server 数据库的实时连接选择“使用 Windows NT 集成安全性”：
4. 在 Tableau Desktop 中，将该工作簿发布到 Tableau Server
簿” 。
“服务器”>“发布工作
5. 在“发布”对话框中，单击“身份验证”，然后在“身份验证”对话框中，从下拉列表
中选择“通过服务器运行身份帐户进行模拟”：
- 280 -
6. 单击“确定”。
7. 通过以用户身份登录到 Tableau Server 来测试该连接。单击视图时，不应看到
要求输入数据库凭据的提示，只应看到该用户有权查看的数据。
使 用 嵌 入 式 SQL 凭 据 进 行 模 拟
通过让视图发布者将其 SQL Server 帐户凭据嵌入到视图中，也可以执行模拟。
Tableau Server 可在任何类型的帐户下运行，但它使用发布者提供的凭据连接到数据
库。
如果处理模拟的帐户不能是 AD 帐户，而您希望为工作簿发布者提供具有 SQL Server
上较高权限级别的帐户，这种方式可能适合您的站点。
注意：
若要使用这种方法，必须在 Tableau Server 上启用嵌入式凭据：
使用工作簿发布者的 SQL 帐户进行模拟：
- 281 -
1. 在 Tableau Desktop 中创建一个工作簿。在创建数据连接时，请为工作簿的 SQL
Server 数据库实时连接选择“使用特定用户名和密码”：
2. 将该工作簿发布到 Tableau Server
“服务器”>“发布工作簿”
。
3. 在“发布”对话框中，单击“身份验证”，然后在“身份验证”对话框中，从下拉列表
中选择“通过嵌入式密码进行模拟”：
4. 单击“确定”。
5. 通过以用户身份登录到 Tableau Server 来测试该连接。单击视图时，不应看到
- 282 -
要求输入数据库凭据的提示，只应看到该用户有权查看的数据。
- 283 -
TCP/IP 端口
下表列出了默认情况下 Tableau Server 使用的端口以及哪些端口必须可用于绑定。如
果启用 Windows 防火墙，则 Tableau Server 将打开它需要的端口，您不需要自己执行
该操作 对于具有运行 Windows 7 的工作服务器的分布式安装，请参见 Tableau 知识
库 。
安装类型
端口
由此服务器进程使用...
高
分 可
全 布 用
部 式 性 参数
80
网关。
X
gateway.public.port,
worker0.gateway.port
443
SSL。针对 SSL 配置 Tableau Server 后，应
用程序服务器会将请求重定向到此端口。
X
--
3729
Tableau Server 安装程序。
X
--
分布式和高可用环境中的 Tableau 工作服务
3730器 主 Tableau Server 不在这些端口上侦
3731
听 。
X
应用程序服务器 基本端口 8000 。使用
8000 之后的连续端口，最多可达进程数目。
8000 默认情况下，Tableau Server 安装时带有两
X
8059
个应用程序服务器进程 端口 8000 和
8001 。
X --
wgserver.port
8060
PostgreSQL 数据库。
X
pgsql.port
8061
Firebird.
X
firebird.port
8062
在为高可用性配置的分布式环境中执行发现
的进程。
8080
Solr 和 Tomcat HTTP。
X
solr.port,
tomcat.http.port1
8250
后台任务。
X
backgrounder.port
8755
Tableau 管理过程。
X
tabadminservice.port
9090
在为高可用性配置的分布式环境中执行复制
的进程。
X pgsql.initport
9100 - VizQL 服务器 基本端口 9100 。还将使用
X
9199 9100 之后的连续端口，最多可达进程数目。
1必须将这些参数设置为相同值。
- 284 -
X rsync.port
vizqlserver.port
安装类型
端口
高
分 可
全 布 用
部 式 性 参数
由此服务器进程使用...
默认情况下，Tableau Server 安装时带有两
个 VizQL Server 进程 端口 9100 和 9101 。
Data Server 基本端口 9700 。还将使用
9700 - 9700 之后的连续端口，最多可达进程数目。
X
9899 默认情况下，Tableau Server 安装时带有两
个 Data Server 进程 端口 9700 和 9701 。
dataserver.port
27000
工作服务器和主服务器在分布式和高可用环
境中交流许可信息。
27009
X
X --
会动态选择一个附加端口，供工作服务器和
主服务器在分布式和高可用环境中交流许可
信息。而您可以指定固定端口 建议使用
27010 。有关详细信息，请参见 Tableau 知
识库。主服务器位于 DMZ 中的安装 必须 遵
循这些指导。
X
X --
数据引擎。Tableau Server 安装时带有一个
数据引擎进程。每个节点最多可以有两个数
27042
据引擎进程，一个群集中最多可以有两个节
点。
27043
X
为高可用性配置的分布式环境中的数据引擎
初始化。
dataengine.port
X
修改默认端口
您可使用命令行管理工具 tabadmin 在本页 306 来修改由 Tableau Server 进程使用的默
认端口。例如，应用程序服务器进程 (wgserver) 的默认端口为 8000。可以使用
tabadmin 参数 workerX.wgserver.port 将其更改为其他端口。请按照以下步骤来
更改 Tableau Server 端口配置。如果启用服务器的 JMX 端口，请参见 启用 JMX 端口
在本页 287
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd “C:\Program Files\Tableau\Tableau Server\8.2\bin”
2. 通过键入以下内容修改端口值：
tabadmin set <workerX>.<parameter> <new port value>
- 285 -
在上面的命令中，<workerX> 是指要更改端口的计算机，<parameter> 是下
表中的一个值 服务器进程的端口，如 wgserver.port ，<new port
value> 是您想让服务器进程使用的新端口号。如果 Tableau Server 正在一台计
算机上运行，则 <workerX> 为 worker0。如果您正在运行群集，则 worker0
是主服务器，worker1 是第一个工作服务器，worker2 是第二个工作服务器，
依此类推。在后一种情况下，您需要为群集中的每台计算机运行一次该命令
从主服务器上的命令提示符 。
下面的示例针对应用程序服务器进程 (wgserver) 将主服务器或备用服务器上
的端口设置为 8020：
tabadmin set worker0.wgserver.port 8020
下面的示例针对 VizQL 服务器进程，将三计算机群集
作服务器 的端口设置为 9200。
一个主服务器和两个工
tabadmin set worker0.vizqlserver.port 9200
tabadmin set worker1.vizqlserver.port 9200
tabadmin set worker2.vizqlserver.port 9200
可以使用以下参数来修改相应端口 — 有关可以设置的 tabadmin 参数的完整列
表，请参见TCP/IP 端口 在本页 284。
要更改的端口 参数
80
gateway.public.port, worker0.gateway.port
8000
wgserver.port
8060
pgsql.port
8080
solr.port, tomcat.http.port1
9100
vizqlserver.port
9700
dataserver.port
3. 进行必要的端口配置更改后，通过键入以下内容来重新启动 Tableau Server：
tabadmin restart
在服务器重新启动时，所有用户都将无法使用服务器。请确保在执行此操作前
向用户发出中断警告，或计划在非营业时间内进行维护。
1应将这些参数设置为相同值。
- 286 -
启 用 JMX 端 口
为帮助您解决 Tableau Server 的问题，Tableau 支持人员可能会要求您启用服务器的
JMX 端口。这些端口对于通常使用像 JConsole 这样的工具进行监视和故障排除的情
况会非常有用。
若要在 Tableau Server 上启用 JMX 端口，请执行以下操作：
1. 停止服务器。
2. 输入以下命令：
tabadmin set service.jmx_enabled true
3. 输入配置命令：
tabadmin configure
4. 启动服务器。
JMX 端 口 列 表
下面是 JMX 端口的列表，默认情况下这些端口全部被禁用。启用这些端口时，它们
用于所有类型的安装：单服务器、分布式和高可用：
端口
由此服务器进程使用...
参数
8300 8359
应用程序服务器 JMX。由应用程序服务器端口
+ 300 来确定。
--
8550
后台监视器 JMX。由后台端口 8250 + 300 确
定。
--
9095
服务监视器 JMX。
svcmonitor.jmx.port
9400 9499
VizQL 服务器 JMX。由 VizQL 服务器端口 + 300
来确定。
--
10000 10299
Data Server JMX。由 Data Server 端口 + 300 来确
-定。
如 何 确 定 JMX 端 口
用于应用程序服务器 (8300 - 8359)、后台程序 (8550)、VizQL Server (9400 - 9599) 和
Data Server (10000 - 10299) 的 JMX 端口可使用公式“基本端口 + 300”来分配 有关默认
的基本端口的列表，请参见 TCP/IP 端口 在本页 284 。此外，如果一个进程具有多
个实例，则每个实例将有一个 JMX 端口。例如，如果将 Tableau Server 配置为运行应
用程序服务器进程的四个实例，则将使用端口 8000 默认的基本端口 、8001、
8002 和 8003。然后，应用程序服务器 JMX 端口 8300 基本端口 + 300 、8301、
8302 和 8303 将绑定至各自的进程实例。
- 287 -
即使 Tableau Server 不直接使用这些端口，但如果 JMX 端口由其他应用程序使用，
Tableau Server 进程也不会运行。此外，不能使用 tabadmin 直接编辑 JMX 端口。可以
更改 JMX 端口，方法是更改其进程的基本端口。换言之，如果端口 10000 不能用于
数据服务器 JMX 进程，则可使用 tabadmin 如修改默认端口 在本页 285中所述 将
数据服务器基本端口从 9700 更改为 9800。这会将数据服务器 JMX 端口移至 11000。
为了降低安全风险，最好将防火墙配置为阻止到达 JMX 端口的外部流量。
恢复端口默认值
可通过以下步骤恢复端口的默认值：
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd “C:\Program Files\Tableau\Tableau Server\8.2\bin”
2. 通过键入以下内容恢复默认端口值：
tabadmin set <workerX>.<parameter> --default
如果 Tableau Server 正在一台计算机上运行，则 <workerX> 为 worker0。如果
您正在运行群集，则 worker0 是主服务器，worker1 是第一个工作服务器，
worker2 是第二个工作服务器，依此类推。
下面是一个示例：
tabadmin set worker0.wgserver.port --default
3. 通过键入以下命令来重新启动 Tableau Server：
tabadmin restart
- 288 -
tabcmd
tabcmd 实用工具是随 Tableau Server 安装的两个命令行工具之一 另一个是 tabadmin
在本页 306 。通过 tabcmd 提供的命令可以帮助您自动执行常见任务，例如成批发
布工作簿以及管理用户和组。tabcmd 实用工具安装在 Tableau Server bin 文件夹
(C:\Program Files\Tableau Server\8.2\bin) 中，但您也可以在其他计算机上安装和运行
tabcmd。 有关详细信息，请参见以下主题：
安 装 tabcmd
默认情况下，tabcmd 命令行实用工具随 Tableau Server 一起安装到服务器的 bin 文件
夹 例如 C:\Program Files\Tableau\Tableau Server\8.2\bin 。您可以从
那里运行它。 为了管理起来更灵活，也可以将它安装在其他计算机上。
将 tabcmd 安装到其他计算机上：
1. 导航到 Tableau Server 上的 extras 文件夹：
C:\Program Files\Tableau\Tableau
Server\8.2\extras\TabcmdInstaller.exe
2. 将 TabcmdInstaller.exe 复制到要安装它的计算机。
3. 双击 TabcmdInstaller.exe 运行它。
4. 按照提示安装 tabcmd。
由于 tabcmd 是一个命令行工具，并且由于 Windows 操作系统的某些限制，
Tableau 建议您将 tabcmd 安装到 C:\ 驱动器根目录里名为 tabcmd 的文件夹中
(C:\tabcmd)。
运行 tabcmd 安装程序不会自动将 tabcmd 添加到 Windows PATH 变量中，您需要
使用它的完整路径明确调用 tabcmd，或者将其目录添加到 PATH 变量中。
如 何 使 用 tabcmd
第一步是使用 tabcmd 以管理员身份打开命令提示符。然后，您可以导航到 Tableau
Server 的 bin 文件夹 例如 C:\Program Files\Tableau\Tableau Server\8.2\bin 或者在命
令中包括该位置。
若要使用 tabcmd 在 Tableau Server 上执行任务，您必须建立经过身份验证的服务器会
话。会话会识别 Tableau Server 和运行该会话的 Tableau Server 用户。您可以先启动
会话，然后指定命令，或者在启动会话的同时执行命令。如果您要使用 tabcmd 执行
多项任务，这些任务必须逐个 按顺序 运行，而非并行运行。
下面的命令演示了如何对名为 tabserver.myco.com 的 Tableau Server 启动会话：
- 289 -
tabcmd login -s http://tabserver.myco.com -u admin -p p@ssw0rd!
在使用 tabcmd 命令时，请注意有些命令 如 login 和选项 如 -s、-u
等 不 区分大小写，但您提供的值 如 p@ssw0rd 或 User@Example.com
分大小写。
区
以下命令用于删除与 tabcmd 位于同一目录、名为 Sales_Workbook 的工作簿：
tabcmd delete "Sales_Workbook"
下面是如何用一条命令完成上述所有操作，请注意此处不需要 login：
tabcmd delete "Sales_Workbook" -s http://tabserver.myco.com -u
admin -p p@ssw0rd!
一个 Tableau Server 可以运行多个站点。当工作簿运行在多站点服务器的 Default 站点
上时，不需要指定 Default，上述命令已足够。但是，如果命令应用于 Default 之外的
站点，则需要指定该站点的站点 ID 请参见login 在本页 301 。下面是用于 West
Coast Sales 站点上的一个工作簿的命令 站点 ID wsales ：
tabcmd delete "Sales_Workbook" -s http://tabserver.myco.com -t
wsales -u admin -p p@ssw0rd!
选项 -s、-t、-u 和 -p 是 tabcmd 的全局变量，这意味着它们可以与任何命令一起使
用。
当该命令成功执行时，tabcmd 将返回零状态代码。对于非零状态代码，将向 stderr 打
印完整错误消息。此外，还可向 stdout 打印信息性消息或进度消息。名为 tabcmd.log
并包括调试、进度和错误消息的完整日志将写入：
l
l
Windows Server 2012、Windows Server 2008 R2、Windows Vista、Windows 7、
Windows 8：C:\Users\<username>\AppData\Roaming\Tableau
Windows Server 2003：C:\Documents and Settings\<username>\Application
Data\Tableau
tabcmd 全 局 选 项
下表列说明了所有命令通用的选项。若要开始一个会话，至少需要使用一次 -server、--user 和 --password 选项。将存储一个身份验证令牌，以便可以不用
包括进这些选项就能运行后续命令。此令牌在使用它的最后一个命令之后五分钟内
保持有效。
选项
短
-h
-s
选项
长
--help
--server
参数
说明
Tableau
显示命令帮助。
至少需要使用一次才能开始会话。
- 290 -
选项
短
选项
长
-u
--user
-p
-password
-t
-x
参数
Server
URL
Tableau
Server 用
户名
Tableau
Server 密
码
filename.txt
-passwordfile
--site
Tableau
Server 站
点 ID
--proxy
--noprompt
Host:Port
--noproxy
--nocertcheck
--[no-]
cookie
--timeout 秒
说明
至少需要使用一次才能开始会话。
至少需要使用一次才能开始会话。也
可以使用 -P 选项。
允许将密码存储在给定文件中而不是
命令行中以增加安全性。
指示命令将应用于由站点 ID 指定的站
点。如果不指定站点，将假定为默认
站点。仅适用于具有多个站点的服务
器。
使用指定的 HTTP 代理。
指定后，该命令将不提示输入密码。
如果未提供有效密码，则该命令将失
败。
指定后，将不使用 HTTP 代理。
指定后，SSL 证书不再进行验证。
指定后，登录时将保存会话 ID，这样
后续命令就无需登录。若要不保存会
话 ID，请使用 no- 前缀。默认情况
下，将保存会话。
等待指定秒数以使服务器完成命令处
理。默认情况下，该进程将在 30 秒后
超时。
tabcmd 命 令
下面是可用于 tabcmd 命令行工具的命令：
addusers group-name
creategroup group-name
createproject project-name
createsite site-name
createsiteusers filename.csv
export
get url
listsites
login
logout
- 291 -
publish
filename.twb(x)
/filename.tds(x)
/filename.tde
refreshextracts
workbookname/datasourcename
removeusers
group-name
runschedule
schedule-name
set setting
syncgroup groupname
version
createusers filename.csv
delete workbook-name/datasource-name
deletegroup group-name
deleteproject project-name
deletesite site-name
deleteusers filename.csv
editsite site-name
addusers group-name
将 --users 参数中列出的用户添加到具有给定组名称的组中。
示例
tabcmd addusers "Development" --users "users.csv"
选项
短
选项
长
参数
说明
filename.csv 将给定文件中的用户添加到指
定组中。该文件应是每行一个
用户名的简单列表。用户应已
在 Tableau Server 上创建。另请
参见 从 CSV 文件导入用户 在本
页 62。
--[no-]complete
当设置为 complete 时，此选项
要求所有行都必须有效，更改
才能成功。如果未指定，则使
用 --complete。
--users
creategroup group-name
使用给定组名称创建组。创建组后，可使用 addusers 对于本地组
syncgroup 对于 Active Directory 组 命令来添加用户。
示例
tabcmd creategroup "Development"
- 292 -
和
createproject project-name
使用给定项目名称创建项目。
示例
tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing
quarterly sales reports."
选项
-n
-d
短
选项 长
参数 说明
--name
名称 指定要创建的项目的名称。
--description 说明 为项目指定说明。
createsite site-name
使用给定站点名称创建站点。
示例
创建名为“West Coast Sales”的站点。系统会自动创建站点 ID WestCoastSales，该站
点没有存储配额限制，且站点管理员可以添加和移除用户：
tabcmd createsite "West Coast Sales"
使用 wsales 的站点 ID 创建名为 West Coast Sales 的站点：
tabcmd createsite "West Coast Sales" -r "wcoast"
阻止站点管理员向站点添加用户：
tabcmd createsite "West Coast Sales" --no-site-mode
设置存储配额
以 MB 为单位
：
tabcmd createsite "West Coast Sales" --storage-quota 100
选项
短
-r
选项
长
--url
--userquota
--[no-]
sitemode
-storagequota
参数
说明
站点 ID
用户数
在网址中使用以指定站点。不同于站点名称。
添加到该站点的用户的最大数量。
允许或拒绝站点管理员向站点添加用户或从中
移除用户。
MB 数
站点上可存储的工作簿、数据提取和数据源的
数量，以 MB 为单位。
- 293 -
createsiteusers filename.csv
此命令使站点管理员可以向站点添加用户。它使用给定逗号分隔值 (CSV) 文件在当
前站点中创建用户。该文件可具有按以下顺序显示的各列：
1. Username
2. Password
3. Full Name
4. License Level (interactor/viewer/unlicensed)
5. Administrator (site/none)
6. Publisher
yes/true/1 或 no/false/0
7. Email Address
文件中的列数可能会更少。例如，该文件可以是每行一个用户名的简单列表。当服
务器使用 Active Directory 身份验证时，将忽略 Password 列。如果值包含逗号，则可
以使用引号。有关其他详细信息，请参见 从 CSV 文件导入用户 在本页 62。
示例
tabcmd createsiteusers "users.csv" --license "Interactor" -publisher
选项
短
选项
长
参数
说明
--nowait
不等待异步作业完成。
--silent不显示异步作业的进度消息。
progress
--license Interactor 设置所有用户的默认许可级别。此
、Viewer 或 设置可由 CSV 文件中的值替代。
Unlicensed
--admin- Site 或
为 CSV 文件中的所有用户分配或删
type
None
除站点管理员权限。此设置可由
CSV 文件中的值替代。对于新用
户，默认值为 None；对于现有用
户，默认值不变。无法使用
createsiteusers 创建系统管理员
或将系统管理员降级 请使用
createusers 。
--[no-]
默认情况下，为 CSV 文件中的所有
publisher
用户分配或删除“发布”权限。此设置
可由 CSV 文件中的值替代。对于新
用户，默认值为 no；对于现有用
户，默认值不变。
--[no-]
要求 或者不要求 所有行都有效
- 294 -
选项
短
选项
长
参数
说明
以使更改成功。默认情况下，将使
用 --complete 选项。
complete
createusers filename.csv
创建给定逗号分隔值 (CSV) 文件中列出的用户。此命令只能由系统管理员使用。该
文件可具有按以下顺序显示的各列：
1. Username
2. Password
3. Full Name
4. License Level (interactor/viewer/unlicensed)
5. Administrator (system/site/none)
6. Publisher
yes/true/1 或 no/false/0
7. Email Address
文件中的列数可能会更少。例如，该文件可以是每行一个用户名的简单列表。当服
务器使用 Active Directory 身份验证时，Password 列应保留为空白。如果值包含逗
号，则可以使用引号。有关其他详细信息，请参见 从 CSV 文件导入用户 在本页
62。
示例
tabcmd createusers "users.csv" --license "Interactor" --publisher
选项
短
选项
长
参数
--nowait
--silentprogress
--license Interactor
、Viewer 或
Unlicensed
--admin- System、
type
Site 或
None
--[no-]
publisher
说明
不等待异步作业完成。
不显示异步作业的进度消息。
设置所有用户的默认许可级别。此
设置可由 CSV 文件中的值替代。
默认情况下，为 CSV 文件中的所有
用户分配或删除“管理”权限。此设置
可由 CSV 文件中的值替代。对于新
用户，默认值为 None；对于现有用
户，默认值不变。
默认情况下，为 CSV 文件中的所有
用户分配“发布”权限。此设置可由
CSV 文件中的值替代。对于新用
- 295 -
选项
短
选项
长
参数
说明
户，默认值为 no；对于现有用户，
默认值不变。
要求所有行都必须有效，更改才能
成功。默认情况下，将使用 -complete 选项。
--[no-]
complete
delete workbook-name/datasource-name
从服务器删除给定工作簿或数据源。此命令按原样使用服务器上的工作簿或数据源
的名称，而不是发布时的文件名。
示例
tabcmd delete "Sales_Analysis"
选项
短
-r
选项
长
参数 说明
项目 包含您要删除的工作簿或数据源的项目的
名称 名称。如果未指定，则使用“Default”项
目。
--workbook 工作 要删除的工作簿的名称。
簿名
称
-数据 要删除的数据源的名称。
datasource 源名
称
--project
deletegroup group-name
从服务器删除具有给定组名称的组。
示例
tabcmd deletegroup "Development"
deleteproject project-name
从服务器删除具有给定项目名称的项目。
示例
tabcmd deleteproject "Designs"
deletesite site-name
从服务器删除具有给定站点名称的站点。
示例
- 296 -
tabcmd deletesite "Development"
deleteusers filename.csv
删除给定逗号分隔 (CSV) 文件中列出的用户。该文件是每行一个用户名的简单列
表。
示例
tabcmd deleteusers "users.csv"
选项
短
选项
参 说明
长
数
--[no-]
当设置为 --complete 时，此选项要求所有行
complete
都必须有效，更改才能成功。如果未指定，则
使用 --complete。
editsite site-name
允许您更改站点名称或其 Web 文件夹名称。还可使用此命令允许或拒绝站点管理员
添加和移除用户的能力。如果站点管理员拥有用户管理权限，则您可指定他们可向
一个站点添加的用户数量。
示例
tabcmd editsite wc_sales --site-name "West Coast Sales"
tabcmd editsite wc_sales --site-id "wsales"
tabcmd editsite wsales --status ACTIVE
tabcmd editsite wsales --user-quota 50
选项 长
--sitename
--site-id
参数
要将站点更改
到的名称
站点变更后的
站点 ID
用户数
--userquota
--[no-]
site-mode
--status
ACTIVE 或
SUSPENDED
-MB 数
storagequota
说明
显示的站点名称。
在网址中使用以特别标识站点。
可成为该站点成员的用户的最大数量。
允许或阻止站点管理员向站点添加用户。
激活或挂起站点。
站点上可存储的工作簿、数据提取和数据
源的数量，以 MB 为单位。
- 297 -
export
从 Tableau Server 导出视图或工作簿，并将其保存到文件。使用此命令时，请注意以
下问题：
l
l
权限：若要导出，您必须拥有“导出图像”权限。默认情况下，此权限对所有角
色都为“允许”或“继承”，但可针对每个工作簿或视图设置权限。
导出的视图、工作簿或数据：可使用工作簿或视图的 URL 中显示的
"workbook/view" 字符串而不使用其“友好名称”进行指定，并且不要包含 URL
最末尾的井号 (#) 和数字。例如，要从 Finance 工作簿导出 Tableau 示例视图
Investment Growth，应该使用字符串 Finance/InvestmentGrowth，而不是
Finance/Investment Growth 或 Finance/InvestmentGrowth#1。如果服
务器运行多个站点，并且视图或工作簿不在默认站点上，请使用 -t <site_
id>。
若要导出工作簿，仍需在所使用的字符串中包括有效视图。对于上面的示例，
若要导出 Finance 工作簿，可使用字符串 Finance/InvestmentGrowth。最
后，若要导出工作簿，必须已在“Tableau Desktop 发布”对话框中选中“将工作表
显示为标签”的情况下发布该工作簿。
l
l
l
已保存文件的格式：格式选项取决于所导出的内容。只能使用 --fullpdf 参
数将工作簿导出为 PDF。可以将视图导出为 PDF (--pdf)、PNG (--png)，或者
可以将视图数据导出为 CSV 文件 (--csv)。
保存的文件的名称和位置 可选 ：如果您不提供名称，则将从视图或工作簿
名称得到名称。如果您不提供位置，则会将该文件保存到当前工作目录。否
则，您可以指定完整路径或当前工作目录的相对路径。
PDF 导出中不包含仪表板网页对象：仪表板可以包含网页对象。如果要将包含
网页对象的仪表板导出到 PDF，则 PDF 中将不包括该网页对象。
清除缓存以使用实时数据
您可以选择添加 URL 参数 ?:refresh=yes 强制刷新数据查询而不是从缓存中获取
结果。如果将 tabcmd 与您自己的脚本结合使用，并且大量使用 refresh URL 参数，
则可能会对性能造成负面影响。建议您仅当需要实时数据时才使用 refresh，例
如，在单个仪表板上而不是整个工作簿上。
示例
视图
tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report"
tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f
"C:\Tableau_Workbooks\Weekly-Reports"
tabcmd export "Finance/InvestmentGrowth" --png
tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png
工作簿
- 298 -
tabcmd export "Q1Sales/Sales_Report" --fullpdf
tabcmd export -t Sales "Sales/Sales_Analysis" --fullpdf -pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports"
选项
短
-f
选项
长
参数
说明
--filename 用于另存文件的名称
--csv
--pdf
--png
--fullpdf
-landscape, portrait
pagelayout
--pagesize unspecified, letter,
legal, note folio,
tabloid, ledger,
statement, executive,
a3, a4, a5, b4, b5,
quatro
--width
像素数
--height
像素数
使用给定文件名保
存文件。
仅视图。以 CSV
格式导出视图数
据。
仅视图。导出为
PDF。
仅视图。导出为
PNG 格式的图
像。
仅工作簿。导出为
PDF。必须已在
“将工作表显示为
标签”已启用的情
况下发布该工作
簿。
设置所导出的
PDF 的页面方
向。如果不指定，
则将使用其
Tableau Desktop 设
置。
设置所导出的
PDF 的大小。默
认值为 letter。
设置宽度。默认值
为 800 像素。
设置高度。默认值
是 600 像素。
get url
将一个 URL 字符串用作其参数之一，发出 Tableau Server 的 HTTP GET 请求。将以文
件的形式返回结果。使用此命令时，请注意以下问题：
- 299 -
l
l
权限：若要获取文件，您必须拥有“下载/另存到 Web”权限。默认情况下，此权
限对所有角色都为“允许”或“继承”，但可针对每个工作簿或视图设置权限。
文件扩展名：您要获取的文件的 URL 字符串必须包含文件扩展名，如
"/views/Finance/InvestmentGrowth.pdf"。扩展名 例如 .pdf 决定了
返回的内容。可以 PDF、PNG、CSV 仅数据 或 XML 仅信息 格式返回视
图。可以 TWB 或 TWBX 形式返回工作簿。若要确定应使用的正确扩展名，可
使用 Web 浏览器导航到 Tableau Server 中您感兴趣的项，然后向 URL 末尾添加
文件扩展名。
将 URL 用于 GET 时，不要包括 URL 最末尾的井号标记 (#) 和数字。例如，使用
"/views/Finance/InvestmentGrowth.pdf" 而非
"/views/Finance/InvestmentGrowth#3.pdf"。
l
l
保存的文件的名称和位置 可选 ：用于 --filename 的名称应包含该文件扩
展名。如果您不提供名称和文件扩展名，则这两个名称都将从 URL 字符串得
到。如果您不提供位置，则会将该文件保存到当前工作目录。否则，您可以指
定完整路径或当前工作目录的相对路径。
PNG 大小 可选 ：如果保存的文件是 PNG，您可以在 URL 中指定该大小
以像素为单位 。
清除缓存以使用实时数据
您可以选择添加 URL 参数 ?:refresh=yes 强制刷新数据查询而不是从缓存中获取
结果。如果将 tabcmd 与您自己的脚本结合使用，并且大量使用 refresh URL 参数，
则可能会对性能造成负面影响。建议您仅当需要实时数据时才使用 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.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"
tabcmd get "/workbooks/Sales.xml"
- 300 -
其他
tabcmd get "/users.xml" --filename "UserList.xml"
选项
短
-f
选项
长
-filename
参数
说明
用于另存文件的名 使用给定文件名保存文
称
件。
listsites
返回已登录用户所属站点的列表。
示例
tabcmd listsites -u corman -pw P@ssword!
login
使 Tableau Server 用户登录。可使用 --server、--site、--username、-password 全局选项来创建会话。如果要使用创建会话时使用的相同信息进行登录，
只需指定 --password 选项。将使用 cookie 中存储的服务器和用户名。
如果服务器使用 80
默认值
之外的端口，您需要指定该端口。
仅当服务器运行多个站点，并且您登录的站点不是默认站点时，才需要使用 --site
(-t) 选项。如果未提供密码，则会提示您输入密码。如果指定 --no-prompt 选项但
未提供密码，则该命令将失败。
登录后，该会话将继续进行，直到其在服务器上过期或 logout 命令运行。
示例
使您登录到本地计算机上运行的 Tableau Server：
tabcmd login -s http://localhost -u jsmith -p p@ssw0rd!
使您登录到 sales-server 上的 Sales 站点：
tabcmd login -s http://sales-server -t Sales -u administrator -p
p@ssw0rd!
tabcmd login -s http://sales-server:8000 -t Sales -u
administrator -p p@ssw0rd!
使您使用 SSL 登录到 sales-server 上的 Sales 站点：
tabcmd login -s https://sales-server -t Sales -u administrator -p
p@ssw0rd!
为 localhost 建立正向代理和端口：
tabcmd login --proxy myfwdproxyserver:8888 -s http://localhost -u
jsmith -p p@ssW0rd!
- 301 -
使您使用 SSL 登录到反向代理：
tabcmd login -s https://myreverseproxy -u jsmith -p p@ssW0rd!
选项
短
选项
长
-s
--server
参数
说明
服务器 URL
如果您从本地 Tableau Server 计算机运行该命
令，则可以使用 http://localhost。否则，请指定
计算机的 URL，例如
http://bigbox.myco.com 或
http://bigbox。
对于 Tableau Online，应指定
https://online.tableausoftware.co
m。
-t
-u
-p
-x
--site
-username
-password
-passwor
d-file
--proxy
--noprompt
--noproxy
--[no-]
cookie
-timeout
SECONDS
siteID
username
password
filename.tx
t
Host:Port
秒数
当服务器具有多个站点，并且您登录的站点
不是默认站点时，请使用此选项。
在 URL 中使用站点 ID 以唯一地标识站点。例
如，名为 West Coast Sales 的站点的 ID 可能为
west-coast-sales。
登录用户的用户名。对于 Tableau Online，用
户名是用户的电子邮件地址。
--username 所指定的用户的密码。如果未提
供密码，则会提示您输入密码。
允许将密码存储在给定文件中而不是命令行
中以增加安全性。
用于指定 tabcmd 请求的 HTTP 代理服务器和
端口。
不提示输入密码。如果未指定密码，则
login 命令将失败。
请勿使用 HTTP 代理服务器。
登录时保存会话 ID。后续命令将不需要登录
名。默认情况下启用 Cookie (--cookie)。
处理 login 命令前服务器应等待的秒数。默
认值：30 秒。
logout
退出服务器。
示例
tabcmd logout
- 302 -
publish filename.twb(x)/filename.tds(x)/filename.tde
将给定工作簿 (.twb(x))、数据源 (.tds(x)) 或数据提取 (.tde) 发布到 Tableau Server。默认
情况下，无需数据库用户名和密码即可发布工作簿中的所有工作表。
如果工作簿中包含用户筛选器，则必须指定一个缩略图选项。
示例
tabcmd publish "analysis.twbx" -n "Sales_Analysis" --db-username
"jsmith" --db-password "p@ssw0rd"
如果文件与 tabcmd 并不位于同一目录，请包含文件的完整路径。
示例
tabcmd publish "C:\Tableau Workbooks\analysis.twbx" -n "Sales_
Analysis" --db-username "jsmith" --db-password "p@ssw0rd"
选项
短
-n
选项
长
-o
--overwrite
-r
--project
--name
--dbusername
--dbpassword
--save-dbpassword
-thumbnailusername
-thumbnailgroup
参数
说明
服务
器上
工作
簿或
数据
源的
名称
如果省略，则工作簿、数据源或数
据提取将以文件名来命名。
项目
名称
如果服务器上已存在该工作簿、数
据源或数据提取，则将其覆盖。
将工作簿、数据源或数据提取发布
到指定项目。如果未指定，则发布
到“Default”项目。
使用此选项可将数据库用户名与工
作簿、数据源或数据提取一起发
布。
使用此选项可将数据库密码与工作
簿、数据源或数据提取一起发布。
将提供的数据库密码存储在服务器
上。
如果工作簿中包含用户筛选器，则
将基于指定用户可看到的内容生成
缩略图。设置 --thumbnailgroup 选项后，无法指定此选项。
如果工作簿中包含用户筛选器，则
将基于指定组可看到的内容生成缩
略图。设置 --thumbnail-
- 303 -
选项
短
选项
长
参数
说明
username 选项后，无法指定此
选项。
发布带有选项卡式视图的工作簿
时，每个工作表都成为一个选项
卡，查看者可以使用这些选项卡在
工作簿中导航。请注意，此设置将
替代任何工作表级安全设置。
将数据提取文件附加到现有的数据
源中。
使用数据提取文件替换现有的数据
源。
禁用增量文件上传器。
--tabbed
--append
--replace
--disableuploader
--disabletdecompression
--restart
停止压缩数据提取文件，直到上传
完成。
重新启动文件上传过程。
refreshextracts workbook-name/datasource-name
对属于指定工作簿或数据源的数据提取执行完全或增量刷新。此命令使用服务器上
显示的工作簿或数据源的名称，而不使用发布时的文件名。
示例
tabcmd refreshextracts --datasource sales_ds
tabcmd refreshextracts --workbook "My Workbook"
tabcmd refreshextracts --url SalesAnalysis
选项
短
选项
长
参数
-incremental
-synchronous
--workbook 工作
簿名
称
-数据
datasource 源名
称
说明
运行增量刷新操作。
立即在前台运行完全刷新操作。
包含要刷新的数据提取的工作簿的名
称。如果工作簿名称中含有空格，请将
名称放入引号内。
包含要刷新的数据提取的数据源的名
称。
- 304 -
选项
短
选项
长
参数
说明
--project
项目
名称
--url
工作
簿的
URL
名称
与 --workbook 或 --datasource 结合
使用可确定 Default 以外的项目中的工作
簿或数据源。如果未指定，则使用
Default 项目。
显示在 URL 中的工作簿的名称。发布为
“Sales Analysis”工作簿的 URL 名称为
“SalesAnalysis”。
removeusers group-name
从具有给定组名称的组删除 --users 参数中列出的用户。
示例
tabcmd removeusers "Development" --users "users.csv"
选项
短
选项
长
--users
参数
说明
filename.csv 从指定的组删除给定文件中的用户。
该文件应是每行一个用户名的简单列
表。
--[no-]
要求所有行都必须有效，更改才能成
complete
功。如果未指定，则使用 -complete。
runschedule schedule-name
运行指定的计划。此命令按原样使用服务器上的计划名称。
示例
tabcmd runschedule "5AM Sales Refresh"
set setting
在服务器上启用指定设置。服务器的“维护”页面上提供了有关各项设置的详细信息。
在设置名称前使用感叹号可禁用该设置。可启用或禁用以下设置：
l
embedded_credentials
l
remember_passwords_forever
示例
tabcmd set embedded_credentials
- 305 -
syncgroup group-name
将具有给定组名称的组与 Active Directory 同步。此命令还可用于在服务器上创建基于
现有 Active Directory 组的新组。
示例
tabcmd syncgroup "Development"
选项
短
选项
长
--license
参数
说明
viewer
interactor
unlicensed
-system
administrator site none
--[no-]
publisher
--[no-]
complete
--silentprogress
为组中的所有用户设置许可级
别。
为组中的所有用户分配或删除
“管理员”权限。管理员用户类型
可以是 system、site 或 none。默
认值为 none 新用户不会获得
管理员权限 ，现有用户保持不
变。
为组中的所有用户分配或删除
“发布”权限。如果未指定，则将
不向新用户分配此权限，且现有
用户的权限不变。
要求所有行都必须有效，更改才
能成功。如果未指定，则使用 -complete。
禁止显示进度消息。
version
显示当前安装的 tabcmd 实用工具的版本信息。
示例
tabcmd version
tabadmin
您可以使用 tabadmin 命令行工具执行某些管理任务以及更改 Tableau Server 配置设
置。默认情况下，它随 Tableau Server 一起安装，而不能安装在其他计算机上。有关
详细信息，请参见以下主题：
如 何 使 用 tabadmin
tabadmin 允许您从命令行对 Tableau Server 执行管理任务。 默认情况下，它随
Tableau Server 一起安装，而不能安装在其他计算机上。使用 tabadmin 的第一步是以
管理员身份打开命令提示符。
- 306 -
接下来，通过键入以下命令导航到 Tableau Server 的 bin 目录：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
现在即可输入 tabadmin 命令。
如果输入更改服务器配置的命令，例如 tabadmin set，则必须先停止服务器，然
后再输入该命令。进行配置更改后，运行 tabadmin config 以便将更改推送到服务
器的所有配置文件。最后，启动服务器。
显示命令行帮助
可以使用 tabadmin 内置的帮助来快速获得命令的描述。要显示所有 tabadmin 命令的
帮助，请输入以下命令：
tabadmin help commands
要查看特定命令的帮助，请键入 tabadmin help <command>。例如：
tabadmin help set
tabadmin 命 令
下面是可用于 tabadmin 命令行工具的命令：
activate 下一页
administrator 在本页 309
assetkeys 在本页 309
autostart 在本页 310
backup 在本页 311
licenses 在本页 317
passwd 在本页 318
regenerate_internal_tokens 在本页
318
restart 在本页 318
restore 在本页 319
- 307 -
cleanup 在本页 312
set 在本页 319
configure 在本页 312
sitestate 在本页 320
customize 在本页 313
start 在本页 320
dbpass 在本页 313
status 在本页 321
exportsite 在本页 314
stop 在本页 322
failoverprimary 在本页 315 validate 在本页 323
importsite 在本页 315
warmup 在本页 323
importsite_verified 在本页
ziplogs 在本页 323
317
activate
联机或脱机激活或返回 Tableau Server 许可证。
示例
脱机激活许可证：
tabadmin activate --tlf <file.tlf>
脱机返回许可证：
tabadmin activate --tlr <file.tlr>
联机激活许可证：
tabadmin activate --activate <license>
联机返回许可证：
tabadmin activate --return <license>
选项
短
选项
长
参数
说明
--tlf
FILE
--tlr
FILE
适用于脱机激活。如果在安装过程中脱机，系统
将会提示您保存一个 .tlq 文件，随后可将其提
交给 Tableau。Tableau 会向您发回一个 .tlf 文件。
可使用此 .tlf 文件激活 Tableau Server。
适用于脱机停用。用作参数的文件是 Tableau 提
供给您的 .tlr 文件。
激活指定的许可证。
返回指定的许可证。
--activate
--return
- 308 -
另请参见
脱机激活 Tableau 在本页 6
administrator
向指定用户授予或移除指定用户的系统管理员能力。此命令不适用于站点管理员。
示例
移除用户 hwilson 的系统管理员能力：
tabadmin administrator hwilson false
向用户 jsmith 授予系统管理员能力：
tabadmin administrator jsmith true
assetkeys
创建一个新密钥来加密 Tableau 存储库中存储的敏感信息 例如外部数据库的凭
据 ，Tableau 存储库是 Tableau Server 内部使用的一种 PostgreSQL 数据库。使用此
命令创建的密钥可包含您指定的密钥，也可以包含随机生成的密钥。
如果您指定密钥的密码，则最好使该密码的长度至少为八个字符。还应考虑到字符
集。强密码应至少包含以下三个字符集中的字符：
l
小写字母 a-z
l
大写字母 A-Z
l
数字 0-9
l
非字母字符
新密钥将以加密形式存储在以下密钥文件中：asset_keys.yml
(ProgramData\Tableau\Tableau Server\data\tabsvc\config)。如果密钥文件丢失或损坏，
则可以使用 assetkeys --validate 命令重新创建它。
如果您使用 assetkeys 命令并随后创建和还原备份文件 (.tsbak)，则您将需要在还原备
份文件后运行 tabadmin assetkeys --validate 命令。按照设计，备份文件不包
含自定义加密密钥 — 即使某些数据可能使用这些加密密钥进行加密也如此。这样可
保护加密的值以防备份文件落入他人之手。在备份还原之后运行 tabadmin
assetkeys --validate 时，系统会提示您输入该密钥的密码。
示例
让 Tableau Server 为您生成密钥和密码：
tabadmin assetkeys --auto_create
- 309 -
使用您指定的密码生成密钥。将会提示您输入密码，在您键入时不会显示密码：
tabadmin assetkeys --create
使用文件内容作为密码：
tabadmin assetkeys --create_from_file C:\test\key\password.txt
确认位于 ProgramData\Tableau\Tableau Server\data\tabsvc\config 中的密钥文件 asset_
keys.yml 有效并且与 Tableau 存储库中的元数据一致：
tabadmin assetkeys --validate
重新创建现在已损坏或不在 ProgramData\Tableau\Tableau Server\data\tabsvc\config 中
的密钥文件 asset_keys.yml：
tabadmin assetkeys --validate
将会提示您输入密码。
选项
短
选项
长
参数
说明
--auto_
create
[length]
--create
PASSPHRASE
--create_
from_file
--validate
FILE
生成随机密码以生成密钥。使用可选参数
指定密码的长度。应记录密码并将其保存
在安全的位置，因为如果 assetkeys.yml 丢
失或损坏，--validate 需要用到该密码。
创建您选择的、要用作密钥的密码。密码
应至少包含 10 个字符，并且不应基于字典
中可以找到的单词。
使用您提供的文件内容作为密码来生成密
钥。
确认 Tableau Server 内部使用的所有资产
密钥都是最新的。如果 asset_keys.yml 文
件丢失 例如，由于文件损坏 ，则可以
使用 --validate 选项重新创建它。要成
功地重新创建密钥文件，您必须提供用于
生成当前正在使用的任何密钥的密码。
另请参见
安全性 在本页 200
autostart
默认情况下，Tableau Server 在系统启动时启动。可以使用此命令更改该默认行为。
如果 autostart 设置为 off, 则需要使用 tabadmin start 或“开始”菜单启动 Tableau
Server。
- 310 -
示例
显示 Tableau Server 的自动启动状态：
tabadmin autostart
在操作系统启动时启动 Tableau Server：
tabadmin autostart on
在操作系统启动时不启动 Tableau Server：
tabadmin autostart off
backup
创建 Tableau Server 管理的数据的备份。此数据包括 Tableau 自己的 PostgreSQL 数据
库，其中存储工作簿和用户元数据、数据提取 (.tde) 文件以及配置数据。创建备份文
件之前，不需要停止 Tableau Server。
示例
在 Tableau Server 的 bin 目录中创建一个名为 tabserv.tsbak 的备份文件：
tabadmin backup tabserv
在 C:\backups\tableau 文件夹中创建一个名为 tabserv.tsbak 的备份文件：
tabadmin backup C:\backups\tableau\tabserv
将当前日期附加到备份文件名并将备份过程中创建的临时文件放置在
C:\mytemp\tableau 中。将在 Tableau Server bin 目录中创建备份文件 tabserv.tsbak：
tabadmin backup tabserv -d -t C:\mytemp\tableau
选项
短
-d
-u
选项
长
参数
-t
--tempdir PATH
--date
--userdir
说明
将当前日期附加到备份文件名
将备份文件放置在 ProgramData\Tableau\Tableau
Server 文件夹中。
备份过程中创建的临时文件的存放位置。
另请参见
备份 Tableau 数据 在本页 331
- 311 -
cleanup
使用此命令可减少 Tableau Server 占用的整体磁盘空间。 运行 tabadmin cleanup
可移除日志文件、临时文件和 Tableau Server 的 PostgreSQL 数据库中的所选行。
示例
删除七天之前的日志文件以及七天之前的 http_requests 条目：
tabadmin cleanup
删除所有日志文件和临时文件
原样保留 http_requests 条目
：
tabadmin cleanup --restart
选项
短
-r
选项
参 说明
长
数
-停止 Tableau Server，运行 cleanup 命令，然
restart
后重新启动服务器。
另请参见
移除不需要的文件 在本页 333
configure
通过强制更新 ProgramData\Tableau\Tableau Server\data\tabsvc\<area> 中的所有文件来
更新 Tableau Server 的配置。此更新包括刷新主服务配置文件 workgroup.yml
(ProgramData\Tableau\Tableau Server\data\tabsvc\config)。进行配置更改后，最好运行
tabadmin configure 或 tabadmin config 以确保影响服务器配置的所有文件
都已完全更新。
示例
tabadmin configure
tabadmin config
另请参见
重新配置服务器 在本页 21
set 在本页 319
tabadmin set 选项 在本页 324
- 312 -
customize
自定义 Tableau Server 使用的名称和徽标。请注意，即使使用此命令，每个服务器页
面底部的版权信息也将列出 Tableau 的版权信息。
示例
将产品名称从 Tableau Server 更改为 MyCo Server：
tabadmin customize name "MyCo Server"
将默认徽标更改为您自己的“大尺寸”徽标
素 ：
小于 160 x 160 像素且大于等于 32 x 32 像
tabadmin customize logo "C:\My Pictures\example.png"
将默认徽标更改为您自己的“小尺寸”徽标
小于等于 32 x 32 像素
：
tabadmin customize smalllogo "C:\My Pictures\example_small.png"
自定义 Tableau Server 登录页等位置中使用的默认产品名称：
tabadmin customize name -d
选项
短
-d
选项
长
--default
参 说明
数
将名称或徽标重置为其默认值。
另请参见
更改名称或徽标 在本页 139
dbpass
允许从外部访问 Tableau 的 PostgreSQL 数据库 存储库 。使用 dbpass 命令允许访
问数据库后，将可以连接到该数据库，使用 Tableau Desktop 查询它，并创建您自己
的管理视图。
示例
允许访问并将密码设置为 P@ssw0rD!：
tabadmin dbpass P@ssw0rD!
禁止外部访问：
tabadmin dbpass --disable
- 313 -
选项
长
--disable
参 说明
数
禁止从外部访问 Tableau 的 PostgreSQL 数据库。
另请参见
创建自定义管理视图 在本页 150
启用对 Tableau Server 数据库的外部访问 在本页 150
exportsite
导出 Tableau Server 站点，包括其用户、工作簿、项目、数据提取和数据连接，并将
其放在一个 .zip 文件中。然后，可以通过 importsite 下一页 和 importsite_
verified 在本页 317 命令使用导出的站点文件来调配新站点。
使用 exportsite 命令之前，不需要停止 Tableau Server。 Tableau Server 将在导出过
程中锁定正在导出的站点。
示例
tabadmin exportsite <site ID> --file <PATH>
或
tabadmin exportsite <site ID> --file <FILE>
将站点 ID 为 finance 的站点导出到名为 finance_export.zip 的文件，并将其放入
Program Files\Tableau\Tableau Server\8.2\bin 目录中：
tabadmin exportsite finance --file finance_export
导出默认站点。默认站点的站点 ID 是 ""
双引号，没有空格
。
tabadmin exportsite "" --file finance_export
如果您使用 Windows PowerShell 运行该命令，请将默认站点的双引号括在单引
号 ('""') 中。例如：tabadmin exportsite '""' --file finance_
export
将默认站点导出到名为 finance_export.zip 的文件，并将其放入 C:\temp\exported sites
而不是 Tableau Server bin 目录中。由于路径包含空格，因此要用引号引起来：
tabadmin exportsite "" --file "C:\temp\exported sites\finance_
export"
导出站点 ID 为 finance 的站点，将导出的站点文件命名为 financesite.zip，将该文件
放入 C:\sites\exported，然后将临时运行时文件写入 C:\temp_files：
tabadmin exportsite finance --file C:\sites\exported\financesite
--tempdir C:\temp_files
- 314 -
选项
短
选项
长
--file
参数
说明
FILE 或
要创建的导出站点文件的名称或名称和位置 路
径 。如果不指定路径，将使用 Tableau Server
的 bin 目录 (Program Files\Tableau\Tableau
Server\8.2\bin)。
导出过程中创建的临时文件的存放位置。如果对
Tableau Server 安装目录没有写访问权限，请使
用该选项。该选项不会确定导出站点文件的创建
位置。
PATH
--tempdir
另请参见
导入或导出站点 在本页 112
failoverprimary
将安装的另一个主 Tableau Server 标识为备份主服务器，或者如果主服务器失败，则
将备份主服务器标识为新主服务器，将之前的主服务器标识为新备份主服务器。
示例
tabadmin failoverprimary --primary <computer name(s) or IPv4
address(es)>
选项
短
选项
长
--primary
参数
说明
计算机名称或
IPv4 地址
充当群集主服务器的 Tableau Server 计算
机。
另请参见
了解高可用性 在本页 39
配置故障转移和多个网关 在本页 44
配置备份主计算机 在本页 52
importsite
importsite 命令是用于将站点导入 Tableau Server 的两个命令中的第一个。要运行
此命令，您需要以下项：
- 315 -
l
l
导出的站点文件。 Tableau Server管理员使用 exportsite 在本页 314 命令创
建该文件。如果您在 Tableau Online 上有一个站点并且想要将其导入您自己的本
地 Tableau Server 安装，请向 Tableau 客户支持索要导出的站点文件。
目标站点的站点 ID。 目标站点是要向其中导入的 Tableau Server 站点。在运行
importsite 命令时，目标站点必须已经存在，不能在运行该命令的过程中创
建它。Tableau Server 默认站点的站点 ID 是 "" 双引号，没有空格 。
您导入的站点的内容将会替换目标站点的内容。例如，如果目标站点有一个名
为 MyDashboard.twbx 的工作簿，而您导入的站点没有该工作簿，则导入过程
将会移除目标站点上的 MyDashboard.twbx。
运行 importsite 命令会创建一个包含 CSV 文件的临时目录，该文件显示在完全导
入后，导出的站点资产 用户、工作簿、项目、数据提取和数据源 将如何映射。
必须验证用户详细信息，例如身份验证。使用文本编辑器或 Microsoft Excel 打开映射
文件并进行任何更改。所有含 ??? 问号 的条目都表示无法处理的映射，必须进行
编辑。验证映射后，使用 importsite_verified 下一页 命令完成导入过程。
示例
tabadmin importsite <site ID> --file <PATH>
或
tabadmin importsite <site ID> --file <FILE>
将位于 C:\tableau\exported 中的文件 sales_site.zip 导入到站点 ID 为 wsales 的站点：
tabadmin importsite wsales --file C:\tableau\exported\sales_
site.zip
将位于 C:\Program Files\Tableau\Tableau Server\8.2\bin 中的文件 sales_site.zip 导入默
认站点。默认站点的站点 ID 是 "" 双引号，没有空格 。
tabadmin importsite "" --file sales_site.zip
要验证的映射文件位于 ProgramData\Tableau\Tableau Server\data\tabsvc\temp\import_
<site ID>_<datetime>\mappings 中。要指定不同的目录，请使用 --tempdir 选项。
将要验证的文件放在 C:\temp\site_to_import 中：
tabadmin importsite wsales --file "C:\tableau\exported\sales_
site.zip" --tempdir "C:\temp\site_to_import"
跳过验证步骤
不建议这么做
：
tabadmin importsite wsales --file "C:\tableau\exported\sales_
site.zip" -no-verify
选项
短
选项
长
--file
--no-
参数
说明
PATH 要导入的导出站点文件的名称和位置。如果不指定路
径，将使用 Tableau Server 的 bin 目录 (Program
Files\Tableau\Tableau Server\8.2\bin)。
跳过验证步骤并将导出的站点文件直接导入它在
- 316 -
选项
短
选项
长
verify
--tempdir
参数
说明
Tableau Server 安装中的新位置。也不需要使用
importsite_verified 命令。
PATH 将在其中验证站点文件具有正确的映射的目录。如果
不指定该选项，文件将被放在
ProgramData\Tableau\Tableau Server\data\tabsvc\temp
下的一个目录中。
另请参见
导入或导出站点 在本页 112
importsite_verified
用于将站点导入 Tableau Server 的第二个命令。必须先使用 importsite 在本页
315，然后才能使用 importsite_verified。
importsite_verified 命令从包含已验证的 CSV 文件的目录读取，并基于站点资
产在 CSV 文件中的映射方式将新站点导入 Tableau Server。接收导入文件的站点
目标站点 必须已经存在于 Tableau Server 上。
在导入过程中，Tableau Server 锁定接收导入的站点。
示例
tabadmin importsite_verified <target site ID> --importjobdir
<PATH>
将文件从目录 C:\temp\site_to_import 导入其站点 ID 为 esale 的站点：
tabadmin importsite_verified esales --importjobdir C:\temp\site_
to_import
选项
短
选项
长
参数
说明
--importjobdir PATH 包含您已验证其映射的 CSV 文件的目录。
另请参见
导入或导出站点 在本页 112
licenses
显示 Tableau Server 的许可证信息。
示例
- 317 -
tabadmin licenses
tabadmin licenses -p
选项
短
-p
选项
长
--processor_
cores
参 说明
数
显示当前计算机的物理内核数。
passwd
重设 Tableau Server 帐户的密码。仅当 Tableau Server 的用户身份验证设置为“本地身
份验证”时，才能使用此命令。当身份验证设置为 Active Directory 时，密码将由 Active
Directory 而不是 Tableau Server 处理
示例
tabadmin passwd <username>
重置服务器用户 jsmith 的密码：
tabadmin passwd jsmith
另请参见
常规 在本页 8
regenerate_internal_tokens
创建 Tableau Server 内部使用的安全令牌的新版本。
示例
tabadmin regenerate_internal_tokens
另请参见
安全性 在本页 200
restart
停止然后启动所有 Tableau Server 进程。
示例
- 318 -
tabadmin restart
restore
将 Tableau Server 备份文件 (.tsbak) 还原到 Tableau Server 安装。还原 .tsbak 文件时，
备份文件中的内容将覆盖 Tableau PostgreSQL 数据库、数据提取以及配置文件的内
容。使用 --no-config 选项可还原除服务器配置以外的所有内容。
示例
tabadmin restore
tabadmin restore --no-config
选项
短
选项
长
参 说明
数
--no-config
还原 Tableau Server 备份文件，包括数据但不包括服务
器配置。
另请参见
还原备份内容 在本页 332
还原备份内容中的数据提取 在本页 333
set
允许您更改 Tableau Server 配置选项的值。如果您设置的参数以连字符开头，请将参
数值用双引号和单引号引起来。
示例
tabadmin set [option-name value]
将后台程序查询限制设置为 2.5 小时
9000 秒
：
tabadmin set backgrounder.querylimit 9000
将 wgserver 虚拟内存参数设置为 -Xmx512m：
tabadmin set wgserver.vmopts "'-Xmx512m'"
将 wgserver 虚拟内存参数设置为介于 -Xmx512m 到 -Xss2048k 之间：
tabadmin set wgserver.vmopts "'-Xmx512m -Xss2048k'"
- 319 -
选项
短
-d
选项
参 说明
长
数
-将参数重置为其默认值。
default
另请参见
tabadmin set 选项 在本页 324
sitestate
用于激活由于站点导入失败而被锁定的站点，或用于暂停站点。暂停站点后，唯一
可以访问它的 Tableau Server 用户就是系统管理员。
示例
tabadmin sitestatus <site ID> --status <active|suspended>
解锁或激活其站点 ID 为 wsales 的站点：
tabadmin sitestatus wsales --status active
选项
短
选项
参数
长
active
-status
或
说明
激活或暂停由 <site ID> 指定的站点。
suspended
start
启动所有 Tableau Server 进程。使用 tabadmin start：
- 320 -
1. 以管理员身份打开命令提示符：
2. 键入以下命令：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
3. 键入以下命令启动服务器：
tabadmin start
示例
tabadmin start
tabadmin start --wait 1200
选项
短
选项
长
--wait
参 说明
数
秒 Tableau Server 准备好接受客户端请求之前等待的秒
数 数。默认值为 600 秒。
status
告诉您 Tableau Server 是否正在运行，如果使用 --verbose 选项，则向您提供有关
各个服务器进程状态的详细信息，包括进程是否正在运行以及使用的是哪个端口。
tabadmin status 命令通过连接到 Windows 服务 tabsvc.exe 获取信息，后者反过来
查询每个进程的 tabspawn 可执行文件。因此，有时它显示的服务器进程信息与维护
页上的“状态”表中的信息有所不同，因为“状态”表是直接查询进程。
示例
- 321 -
tabadmin status
tabadmin status --verbose
选项
短
-v
选项
长
--verbose
参 说明
数
返回所有 Tableau Server 进程、它们的端口号和状态的列
表。
另请参见
维护设置 在本页 127
Tableau Server 进程 在本页 336
stop
停止所有 Tableau Server 进程。使用 tabadmin stop：
1. 以管理员身份打开命令提示符：
2. 键入以下命令：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
3. 键入以下命令停止服务器：
tabadmin stop
- 322 -
validate
确认您的 Tableau Server 环境是否满足运行 64 位版本 Tableau Server 的最低要求。如
果您当前运行的是 32 位版本的 Tableau Server，在升级到 64 位版本之前运行此命令
可帮助您确认当前硬件、磁盘空间和 RAM 是否满足要求。
示例
tabadmin validate
warmup
使每个 VizQL 服务器进程加载 vizql DLL 文件，从而提高服务器用户首次加载视图时的
加载速度。管理员可以运行此命令，或者为其编写脚本使其在 Tableau Server 重新启
动后运行。
示例
tabadmin warmup
ziplogs
创建包含 Tableau Server 日志文件的存档 (.zip)，不移除日志文件本身。如果运行的是
Tableau Server 群集，工作服务器的日志文件将包含在创建的存档中。
示例
在 Tableau Server bin 目录中创建一个名为 logs.zip 的存档：
tabadmin ziplogs
在 Tableau Server bin 目录中创建一个名为 mylogs.zip 的存档：
tabadmin ziplogs mylogs.zip
在 Tableau Server bin 目录中创建一个名为 mylogs.zip 的存档，其中包含从 2014 年 1
月 31 日到现在的日志，但不包括更早的日志：
tabadmin ziplogs -d 01/31/2014 mylogs.zip
选项
短
-n
-p
选项
长
--with-netstatinfo
--withpostgresql-data
参数
说明
在 .zip 文件中包含有关服务器环境的信
息。
包含 Tableau Server 的 PostgreSQL 数据
库中的数据。
- 323 -
选项
短
-l
选项
长
-f
-d
--force
--minimumdate
-a
--all
参数
--with-latestdump
说明
将包含的日志文件限制为最新文件以帮
助减少文件大小。默认情况下，会包含
10 个最新文件。
覆盖同名的现有日志文件。
[mm/dd/yyyy] .zip 文件中将包含从此日期开始直到现
在的日志文件，但不包含更早日期的日
志。如果不指定，则最多包含七天的数
据。
在 .zip 文件中包括所有日志文件。
Tableau Server 的 PostgreSQL 数据库中
的数据仍然排除在外。
另请参见
使用日志文件 在本页 335
对日志文件进行存档 在本页 341
tabadmin set 选 项
使用下表可了解您可以使用 set 在本页 319 命令配置的 Tableau Server 选项的更多信
息。有关完整的端口列表，请参见TCP/IP 端口 在本页 284。
选项
默认值
说明
api.server.enabled
false
允许访问 REST API 在本页 397。默认情况
下，此功能被禁用。
auditing.enabled
true
允许访问 PostgreSQL Tableau Server 自己
的数据库 历史审计表。有关详细信息，
请参见创建自定义管理视图 在本页 150。
backgrounder.querylimit
7200
完成一次数据提取刷新允许的最长时间，
以秒为单位 7200 秒 = 2 小时 。
backgrounder.reset_
schedules_on_startup
true
控制何时运行已计划在服务器停止时运行
的后台任务。当设置为 true 默认值
时，任务在其下个预定时间运行。当设置
为 false 时，计划在服务器停止时运行的
所有任务会在服务器启动时同时运行，包
- 324 -
选项
默认值
说明
括还原 Tableau Server 备份文件 (.tsbak) 的
任务。
dataengine.port
27042
数据引擎在其中运行的端口。
dataserver.port
9700
数据服务器在其中运行的端口。
gateway.public.host
计算机名称
服务器的典型名称，用于对 Tableau Server
进行外部访问。如果将 Tableau Server 配置
为使用代理服务器，则该名称是代理服务
器 而不是 Tableau Server 的典型名称。
gateway.public.port
80 如果是
SSL，则为
443
仅适用于代理服务器环境。代理服务器所
侦听的外部端口。
gateway.timeout
1800
网关在请求失败前等待特定事件的最长时
间，以秒为单位 1800 秒 = 30 分钟 。
gateway.trusted
代理服务器
计算机的 IP
地址
仅适用于代理服务器环境。代理服务器的
IP 地址或主机名。
gateway.trusted_hosts
代理服务器
的备用名称
仅适用于代理服务器环境。代理服务器的
任何备用主机名。
java.heap.size
128m
Tomcat 堆 存储库和 solr 的大小。除非
Tableau 建议这么做，否则通常无需更改该
值。
pgsql.port
8060
PostgreSQL 所侦听的端口。
rsync.timeout
600
完成文件同步所允许的最长时间 以秒为
单位
600 秒 = 10 分钟 。文件同步在配
置高可用性或移动数据引擎和存储库的过
程中发生。
server.log.level
info
写入 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\vizqlserv
er\Logs\*.txt 的日志的日志记录级别。
要获取更多信息，请设置为 debug。设置
为 debug 时，日志记录设置为 pre-8.2
verbosity。Debug 级别可能会显著影响性
能，您应该仅在 Tableau 支持部门指示这么
做时才使用它。有关更多信息，请参见更
改日志记录级别 在本页 347。
service.jmx_enabled
false
设置为 true 则可将 JMX 端口用于可选的监
视和故障排除。有关详细信息，请参见启
- 325 -
选项
默认值
说明
用 JMX 端口 在本页 287。
service.max_procs
进程数
最大服务器进程数。
solr.rebuild_index_timeout 3600
当升级 Tableau Server 或还原 .tsbak 文件
时，后台任务重新生成搜索索引。 此设置
控制该任务的超时设置 3600 秒 = 60 分
钟 。
subscriptions.enabled
false
控制是否可在系统范围内配置订阅。请参
见管理订阅 在本页 95。
subscriptions.timeout
1800
一个表示秒数的值，此时间过后，处理订
阅的后台进程将会超时。
solr.port
8080
solr 所侦听的端口。此值必须与
tomcat.http.port 的值相同。
tomcat.http.port
8080
Tomcat 在其中运行的端口。
tomcat.https.port
8443
Tomcat 的 SSL 端口
tomcat.server.port
8085
tomcat 侦听关机消息的端口。
未使用
。
vizqlserver.browser.render true
低于由 vizqlserver.browser.render_
threshold 或
vizqlserver.browser.render_
threshold_mobile 设置的阈值的视图由
客户端 Web 浏览器 而非服务器 呈现。
有关详细信息，请参见关于客户端呈现 在
本页 215。
vizqlserver.browser.rende- 100
r_threshold
默认值 (100) 表示 PC 上显示的视图的高复
杂度。复杂度因素包括标记数、标题数、
参考线数和注释数。高于此复杂度的视图
由服务器呈现，而不是在 PC 的 Web 浏览
器中呈现。
vizqlserver.browser.rende- 20
r_threshold_mobile
默认值 (20) 表示平板电脑上显示的视图的
高复杂度。复杂度因素包括标记数、标题
数、参考线数和注释数。高于此复杂度的
视图由服务器呈现，而不是在平板电脑的
Web 浏览器中呈现。
vizqlserver.log.level
vizqlserver java 组件的日志记录级别。日志
写入 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\vizqlserv
er\*.log。
info
要获取更多信息，请设置为 debug。Debug
- 326 -
选项
默认值
说明
级别可能会显著影响性能，您应该仅在
Tableau 支持部门指示这么做时才使用它。
有关更多信息，请参见更改日志记录级别
在本页 347。
vizqlserver.port
9100
VizQL 服务器的基本端口。
vizqlserver.protect_
sessions
true
当设置为 true 默认值 时，可防止
VizQL 会话在原始用户退出后被重用。
vizqlserver.querylimit
1800
更新视图允许的最长时间，以秒为单位。
指定 Rserve 主机。此设置和下面三个设置
支持工作簿中的 R 功能。R 是用于统计计
算和图形的开源软件编程语言和软件环
境。在 Tableau Desktop 中，可使用四个函
数将 R 表达式传递给 Rserve 服务器并获取
结果。如果上载使用任意这些函数的工作
簿，则应通过配置此选项和下面三个选项
为 Tableau Server 配置 Rserve 连接。否则，
使用 R 功能的任何工作表都将不可用。有
关更多详细信息，请参见 Tableau Desktop
帮助中的 R 连接。
vizqlserver.rserve.host
vizqlserver.rserve.port
6311
指定 Rserve 端口。此设置支持工作簿中的
R 功能。
vizqlserver.rserve.username
指定 Rserve 用户名。此设置支持工作簿中
的 R 功能。并非所有 Rserve 主机都需要用
户名和密码。
vizqlserver.rserve.password
指定 Rserve 密码。此设置支持工作簿中的
R 功能。并非所有 Rserve 主机都需要用户
名和密码。
vizqlserver.session.expiry.- 5
minimum
当 VizQL 进程开始出现内存不足的情况时，
允许丢弃 VizQL 会话前的空闲时间分钟数。
vizqlserver.session.expiry.t- 30
imeout
丢弃 VizQL 会话前的空闲时间分钟数。
vizqlserver.showdownload true
控制视图上方“下载”按钮的显示。
vizqlserver.showshare
控制视图上方“共享”按钮的显示。
true
vizqlserver.trustedticket.lo- info
g_level
受信任的身份验证的日志记录级别，日志
写入 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\vizqlserv
er\vizql-*.log。
- 327 -
选项
默认值
说明
要获取更多信息，请设置为 debug。Debug
级别可能会显著影响性能，您应该仅在
Tableau 支持部门指示这么做时才使用它。
有关更多信息，请参见更改日志记录级别
在本页 347。
vizqlserver.trustedticket.to- 24
ken_length
确定每个受信任票证中的字符数量。默认
设置 24 个字符 提供 144 位随机性。该
值可设置为 9 和 255 包括 9 和 255 之间
的任意整数。
vizqlserver.trustedticket.us- false
e_deprecated_9digit_
token
设置为 true 时，票证的长度是 9 位数 在
版本 8.0 和更低版本中 ，并忽略
vizqlserver.trustedticket.token_
length 设置。
vizqlserver.url_scheme_
whitelist
在对视图和仪表板使用 URL 操作时将这些
协议添加到白名单中。http、https、
gopher、news、ftp 和 mailto 默认列在
白名单中。
wgserver.audit_history_
expiration_days
183
一个表示天数的值，在该天数后，历史事
件记录将从 PostgreSQL 数据库 Tableau
Server 自己的数据库 删除。有关详细信
息，请参见创建自定义管理视图 在本页
150。
wgserver.change_
owner.enabled
true
控制工作簿、数据源或项目的所有权能否
更改。其他选项包括“false”和“adminonly”。
有关详细信息，请参见管理所有权 在本页
196。
wgserver.domain.fqdn
%USERDOM- 要使用的 Active Directory 服务器的完全限定
AIN% 的值
域名。
wgserver.log.level
info
wgserver java 组件的日志记录级别。日志写
入 ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\wgserver\
*.log。
要获取更多信息，请设置为 debug。Debug
级别可能会显著影响性能，您应该仅在
Tableau 支持部门指示这么做时才使用它。
有关更多信息，请参见更改日志记录级别
在本页 347。
wgserver.password_
autocomplete.enabled
false
控制是否允许 Web 浏览器自动填充密码字
段。
- 328 -
选项
默认值
说明
wgserver.saml.idpattribute- username
.username
指定 IdP 用于 SAML 身份验证的属性。 默认
值为 username。
wgserver.saml.maxasserti- 3000
ontime
指定自创建后断言可用的最大秒数。
wgserver.saml.maxauthen- 7200
ticationage
指定用户的身份验证与 AuthNResponse 消
息处理之间允许的最大秒数。
wgserver.saml.responsesk- 180
ew
设置 Tableau Server 时间与仍允许处理消息
的断言创建时间 基于 IdP 服务器时间 相
差的最大秒数。
wgserver.session.idle_limit 240
登录 Web 应用程序发生超时前的空闲时间
分钟数。
workerX.gateway.port
80 如果是
SSL，则为
443
Apache 为 workerX 进行侦听的外部端口。
worker0.gateway.port 是 Tableau Server 的外
部端口。在分布式环境中，worker0 是主
Tableau Server。
workerX.vizqlserver.procs 进程数
VizQL 服务器数。
workerX.vizqlserver.port
9100
workerX 上用于 vizQL 服务器的基本端口。
workerX.wgserver.port
8000
workerX 上用于 Web 应用程序服务器的基本
端口。
workerX.wgserver.procs
处理器数
Web 应用程序服务器进程数。
将设置恢复为默认值
通过执行以下操作，可恢复 Tableau Server 配置设置的默认值：
1. 停止服务器。
2. 还是在 bin 目录中，通过键入以下内容恢复特定设置的默认值：
tabadmin set option-name --default
例如，若要将 tabadmin vizqlserver.session.expiry.timeout 选项设置回其默认值 30
分钟，请键入以下内容：
tabadmin set vizqlserver.session.expiry.timeout --default
或者，可以使用较短的 -d 命令。例如：
tabadmin set vizqlserver.querylimit -d
3. 然后运行 configure 命令：
- 329 -
tabadmin configure
4. 启动服务器。
- 330 -
数据库维护
Tableau Server 管理员应执行常规数据库维护，监视服务器上的磁盘使用情况并清除
不必要的文件来释放服务器空间。采取这些步骤可帮助确保 Tableau Server 以最高效
率运行。
可使用 tabadmin 命令行工具备份和还原 Tableau 数据以及清理不必要的日志和临时文
件。Tableau 数据包括 Tableau Server 自己的 PostgreSQL 数据库，其中存储工作簿和
用户元数据、数据提取 (.tde) 文件以及服务器配置数据。Tableau Server 日志文件捕获
活动并可帮助诊断问题。日志写入到服务器上的文件夹中，您可以存档并移除它们
以节省磁盘空间。可使用以下主题中介绍的命令以及内置的 Windows 任务计划程序
来自动备份数据和清理不必要的文件。
备 份 Tableau 数 据
对 Tableau 数据进行备份十分重要，这样就可以在发生系统故障时还原已发布的视图
和其他信息。Tableau Server 管理的数据包含 Tableau 自己的 PostgreSQL 数据库，其
中包含工作簿和用户元数据、数据提取 (.tde) 文件以及配置数据。创建备份时，所有
这些内容全都放置在一个扩展名为 .tsbak 的文件中。如果您运行的是 Tableau Server
的分布式安装，那么此步骤会在主服务器上执行，即使处理 .tde 文件的数据引擎位于
工作服务器上也是如此。 为了使其成为有效备份，请确保将 .tsbak 存储在 Tableau
Server 主机之外的单独计算机上。
可以使用下面的步骤创建 .tsbak 文件。Tableau 卸载，这是升级到新版本的第一个步
骤，也会自动创建 .tsbak 文件。该 .tsbak 文件可用于自动将数据迁移到较新版本。
运行 backup 命令还将移除早于七天的 Tableau Server 日志文件以及显示在特定
Tableau Server 管理视图 在本页 142 中的一些信息。
1. 以管理员身份打开命令提示符，然后键入以下内容：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
2. 通过键入 tabadmin backup <filename> 创建备份文件，其中 <filename>
是备份文件的名称或位置和名称。从版本 8.1 开始，创建备份之前不再需要停
止服务器。例如：
tabadmin backup tabserver
或
tabadmin backup C:\backups\tableau\tabserver
您还可以选择使用 -d 将当前日期追加到文件名和 -t，后跟路径，以指定备份
过程中创建的临时文件的位置。例如：
tabadmin backup tabserver -d -t C:\mytemp\tableau
- 331 -
在以上示例中，备份文件 tabserver.tsbak 将在 Tableau Server bin 目录
(C:\Program Files\Tableau\Tableau Server\8.2\bin) 而不是
C:\mytemp\tableau 中创建。
还原备份内容
进行还原时，备份文件 (.tsbak) 中的内容将覆盖 Tableau PostgreSQL 数据库、数据提
取以及配置文件的内容。如果您运行的是 Tableau Server 的分布式安装，那么此步骤
会在主 Tableau Server 上执行。
从数据库备份文件进行还原：
1. 通过键入以下命令来停止服务器：
tabadmin stop
2. 通过键入以下命令从备份文件还原数据库：
tabadmin restore <filename>
在上面的行中，将 <filename> 替换为要用来进行还原的备份文件的名称。
要仅还原数据而不还原配置设置，请键入以下命令：
tabadmin restore --no-config <filename>
3. 如果在创建现在要还原的备份文件之前的任何时间运行了 tabadmin
assetkeys 命令，请运行以下命令：
tabadmin assetkeys --validate
将提示您输入重新创建在备份文件中使用的自定义加密密钥所需的密码。
4. 通过键入以下命令来重新启动 Tableau Server 进程：
tabadmin start
在还原 .tsbak 文件时，Tableau Server 会自动创建其当前 data 文件夹的副本，将它命
名为 tabsvc.bak-*，并将它放在 ProgramData\Tableau\Tableau
Server\data 中。此文件夹是 Tableau Server 数据的应急备份，在备份还原过程中出
现问题时，Tableau 支持人员或许会用到它。
还原完成后，可以安全地从 ProgramData\Tableau\Tableau Server\data 中移
除任何 tabsvc.bak-* 文件夹来释放更多磁盘空间。在 Tableau Server 群集中，运行
Tableau Server 的每台计算机上都会创建 tabsvc.bak-* 文件夹。
不要移除 tabsvc 文件夹，它也位于 ProgramData\Tableau\Tableau
Server\data 下。它包含 Tableau Server 数据。仅移除 tabsvc.bak-* 文件
夹。
- 332 -
还原备份内容中的数据提取
创建 uninstall-<version>.tsbak 文件 例如 uninstall-8.1.tsbak 是卸载过程中的一个操
作。升级到版本 8.2之后，可使用此文件来还原数据提取，例如您在升级过程中意外
删除了 dataengine 文件夹时。若要使用 uninstall-<version>.tsbak 还原数据提取，请执
行以下操作：
1. 停止服务器。
2. 在 Tableau Server 8.2 版的 bin 目录中键入以下命令：
Windows Server 2012、Windows Server 2008、Windows Vista、Windows 7、
Windows 8：tabadmin restore \ProgramData\Tableau\Tableau
Server\uninstall-8.1.tsbak
安装在 64 位 Windows Server 2003 上的 32 位 Tableau Server：tabadmin
restore \Program Files (x86)\Tableau\Tableau
Server\uninstall-8.1.tsbak
安装在 32 位 Windows Server 2003 上的 32 位 Tableau Server：tabadmin
restore \Program Files\Tableau\Tableau Server\uninstall8.1.tsbak
移除不需要的文件
作为最佳做法，您应该监视您服务器上的空间使用率。如果您需要腾出更多空间，
可以删除日志文件、某些 PostgreSQL 数据库条目和日志文件存档。
如果您认为可能需要较旧日志条目来排查问题，则应在执行清理之前创建日志文件
存档。有关详细信息，请参见对日志文件进行存档 在本页 341。
不需要在执行清理之前停止 Tableau Server，但根据 Tableau Server 是正在运行还是已
停止，tabadmin cleanup 命令的行为会有所不同。您清理日志文件和临时文件的
目标决定您运行 tabadmin cleanup 命令的方式。
服 务 器 状 态 以 及 tabadmin cleanup
要清理所有可能的文件和数据库条目，您需要运行 tabadmin cleanup 两次：一次
在 Tableau Server 运行时，一次在其已停止时。
tabadmin cleanup 的结果取决于 Tableau Server 是否在运行。
下面汇总了您在服务器运行时和服务器已停止的情况下运行 tabadmin cleanup
时移除的内容：
当 您 在 Tableau Server 已 停 止 的 情 况 下 运 行 tabadmin cleanup 时 ：
l
将从 ProgramData\Tableau\Tableau Server\data\tabsvc\logs 中移除
所有日志文件
除
l
ProgramData\Tableau\Tableau Server\logs 中的日志文件不会被移
。
Tableau Server 临时文件夹
ProgramData\Tableau\Tableau Server\temp
- 333 -
和 ProgramData\Tableau\Tableau Server\data\tabsvc\temp
将被移除。
l
的内容
http_requests 表条目不会更改，因为 PostgreSQL 数据库不可访问。
当 您 在 Tableau Server 正 在 运 行 的 情 况 下 运 行 tabadmin cleanup 时 ：
l
将从 ProgramData\Tableau\Tableau Server\data\tabsvc\logs 中移除
七天之前的日志文件
ProgramData\Tableau\Tableau Server\logs 中的活动日志和日志文件
不会被移除 。
l
将从 Tableau Server PostgreSQL 数据库中移除七天之前的 http_requests 表条
目。
这是您在创建自定义管理视图时可以使用的其中一个表。有关详细信息，请参
见创建自定义管理视图 在本页 150。
在备份 Tableau 数据时，http_requests 表中超过七天的行也会被移除。有关
详细信息，请参见备份 Tableau 数据 在本页 331。
l
Tableau Server 临时文件夹的内容不会更改。
移除不需要的文件
删除超过七天的日志文件以及超过七天的 http_requests 条目：
l
在 Tableau Server 正在运行时，在命令提示符处键入 tabadmin cleanup。
删除所有日志文件和临时文件但保留 http_requests 条目不动：
l
在 Tableau Server 正在运行时，在命令提示符处键入 tabadmin cleanup -restart
--restart 选项会在 cleanup 命令运行之前停止 Tableau Server 并在该命令运
行之后重新启动 Tableau Server。
这相当于运行 tabadmin 三次： tabadmin start、tabadmin
cleanup，然后再运行 tabadmin start。
有关如何自动运行清理和备份命令的提示，请参见以下知识库文章：服务器备份和
维护自动化
清理日志文件存档
如果您创建了日志文件存档但现在不再需要它，可使用“维护”页面上的“删除快照”选
项将其从服务器中删除。有关详细信息，请参见在“维护”页面上对日志进行存档 快
照 在本页 338。
- 334 -
疑难解答
使用 Tableau Server遇到问题时，可以使用以下主题来解决。有关受信任的身份验证
方面的问题解答提示，请参见受信任的身份验证疑难解答 在本页 251：
使用日志文件
Tableau Server 创建日志文件作为其活动的正常一部分。在您排查 Tableau Server 问题
时或者 Tableau 支持人员需要使用日志来帮助您解决问题时，您可能需要使用服务器
日志文件。
可以在服务器上从命令行或使用“维护”页面上的“生成快照”选项来创建压缩的日志文
件存档 快照 。压缩的存档包含您可使用 Web 浏览器复制或下载并发送给 Tableau
支持人员的日志副本。在您拥有存档副本之后，可以从服务器删除存档。有关创
建、下载和删除日志文件存档的更多信息，请参见在“维护”页面上对日志进行存档
快照 在本页 338。
这组主题提供了有关如何创建日志文件存档的信息、特定日志文件的内容以及有关
您何时可能需要查看文件和如何查看的详细信息。
调 查 Tableau Server 问 题
Tableau Server 可能出现的问题的范围和复杂性不同，这意味着没有可用于调查所有
问题的简单过程，但常规方法包括以下步骤：
1. 清理现有日志文件以减小其大小。有关更多信息，请参见移除不需要的文件 在
本页 333。
2. 设置适当的日志记录级别。Tableau 支持人员将指示您执行此操作。有关更多
信息，请参见更改日志记录级别 在本页 347。
3. 重现您要解决的问题，以便日志捕获与问题相关的事件。
4. 创建日志的存档。有关更多信息，请参见对日志文件进行存档 在本页 338。
5. 查看配置文件，尤其是 \config\workgroup.yml，以基本了解服务器环境。
6. 查看 \logs\tabadmin.log 以了解在服务器上执行了什么维护。
搜索 run as: <script> 来查找特定于 tabadmin 相关活动的条目。
7. 查看 Apache 日志 \httpd\access.####_##_##_##_##_##.log 和
\httpd\error.log 中可能与您要调查的问题相关的请求。
Apache 日志将包含大量不适用于您遇到的问题的“无用数据”。
l 如果您找到似乎与您的问题相关的请求，请在 \wgserver 和
\vizqlserver 中搜索包含 Apache 日志中的唯一请求 ID 的条目。
l 查找与请求 ID 关联的响应代码和消息。
8. 如果问题与数据源相关，则 \vizqlserver\Logs 可能具有更多有用的详细信
息。
按工作簿名称和 vizql 会话 ID 进行搜索。
9. 与支持人员联系并将您的压缩的日志存档发送给他们。如果您自己无法解决问
题或者 Tableau 支持人员要求您这么做，请将压缩的存档发送给 Tableau。
- 335 -
有关更多信息，请参见以下主题：
Tableau Server 进 程
存在六个 Tableau Server 进程，可以更改其默认配置以获得不同的结果。主题提高服
务器性能 在本页 208和高可用性 在本页 39介绍了您可以采用的某些方法。每个进程
的高级别状态显示在服务器的“维护”页面，与某些进程 例如后台进程 有关的详细
信息位于 管理视图 在本页 142 主题中。
从结构上说，64 位版本的 Tableau Server 使用本机 64 位进程；32 位版本的 Tableau
Server 使用 32 位进程。但数据引擎例外。如果 32 位版本的 Tableau Server 安装在 64
位操作系统上，则会使用 64 位版本的数据引擎进程。
有关这些进程生成的日志文件的信息，请参见服务器日志文件位置 在本页 341。
进程
文件名
应用程序服 wgserver.exe
务器
是否
为多
用途
线
程？
处理 Web 应用程 是
序，支持浏览和
搜索
后台
backgrounder.exe 执行服务器任务 否
包括数据提取
刷新 、“立即
运行”任务以及
通过 tabcmd 启
动的任务
数据引擎
tdeserver64.exe 存储数据提取和 是
回答查询
tdeserver.exe
- 336 -
性能特征
在不经常使用的操作
例如，发布包含数
据提取的工作簿，或
者生成视图的静态图
像 中仅占用显而易
见的资源。可通过基
于浏览器的交互和
tabcmd 创建该进程的
负载。
可在群集内的任何或
所有计算机上运行多
个进程以扩展容量的
单线程进程。后台程
序通常不会占用很多
进程内存，但后台程
序可能会根据面向它
的工作负载的性质占
用 CPU 资源、I/O 资源
或网络资源。例如，
执行大量数据提取刷
新时，可能会使用网
络带宽来检索数据。
数据检索或复杂的
tabcmd 任务可能会占
用 CPU 资源。
数据引擎的工作负载
是来自 VizQL Server 进
进程
文件名
Data Server dataserver.exe
存储库
postgres.exe
是否
为多
线
程？
用途
性能特征
程的请求产生的。该
进程是将数据提取加
载到内存并针对数据
提取执行查询的组
件。内存占用主要基
于所加载的数据提取
的大小。在 64 位操作
系统上，默认使用 64
位二进制文件，即使
安装的是 32 位 Tableau
Server，也是如此。数
据引擎是多线程的进
程，可以一次处理多
个请求。在高负载的
情况下，该进程可能
会占用 CPU 资源、I/O
资源和网络资源，所
有这些资源都可能是
高负载的性能瓶颈。
高负载时，数据引擎
的单个实例可能会占
用所有 CPU 资源，以
便处理请求。
处理至 Tableau 是
由于该进程是一个代
Server 数据源的
理，因此它通常仅受
连接
限制于网络，但在有
很多同时存在的用户
会话时，可能会受限
制于 CPU。该进程的
负载是以下内容产生
的：基于浏览器的交
互，基于 Tableau
Desktop 的交互，以及
针对 Tableau Server 数
据源的数据提取刷新
作业。
Tableau Server 不适用 通常仅占用很少的资
数据库，用于存
源。执行诸如用户查
储工作簿和用户
看所有工作簿或更改
元数据
权限等操作时，在极
- 337 -
进程
VizQL
Server
文件名
vizqlserver.exe
是否
为多
线
程？
用途
加载和呈现视
是
图，计算和执行
查询
性能特征
少情况下，对于超大
型部署 存在数千位
用户 ，该进程可能
会成为瓶颈。
在从 Web 浏览器加载
视图和交互使用的过
程中，占用明显的资
源。可能受限制于
CPU、I/O 或网络。进
程负载只能由浏览器
的交互创建。进程内
存可能不足。
对日志文件进行存档
可以采用两种不同的方法创建日志文件的存档 快照 ：使用浏览器从“维护”页面，
或在 Tableau Server 上从命令提示符使用 tabadmin。创建日志文件存档为您提供了
日志的压缩快照，您可将其用于进行疑难解答或发送给 Tableau 支持人员来帮助解决
问题。
在“维护”页面上对日志进行存档
快照
您可以从 Web 浏览器生成并下载 Tableau Server 日志文件的快照 存档 ，而无需打
开命令提示符。这种压缩的快照包含 Tableau Server 和任何工作服务器 如果您具有
分布式环境 中的最多七天的日志文件数据的副本。快照过程不会更改或删除
Tableau Server 日志文件或使用 tabadmin 创建的日志存档。
注意：若要指定要收集的数据量或要创建的 zip 文件的名称，请使用 tabadmin
创建服务器日志的存档。有关详细信息，请参见对日志文件进行存档 在本页
341。
生成服务器日志文件的快照：
- 338 -
1. 在“管理”选项卡上，单击“维护”：
2. 在“活动”下，单击“生成并下载日志文件的快照”以打开快照选项：
3. 单击“生成快照”以创建 Tableau Server 日志的快照。仅当没有现有快照时，“生
成快照”按钮才可用。
使用 tabadmin 创建的日志存档不影响此选项的可用性。
4. 单击“下载快照”将日志快照下载到您的 Web 浏览器的默认下载位置。此选项在
您创建快照后可用。
Google Chrome 在窗口底部向您显示下载：
- 339 -
5. 单击箭头，然后单击“打开”以解压缩快照，或单击“在文件夹中显示”以查看它
的下载位置：
6.
可选 单击“删除快照”可删除日志快照。此选项在您创建快照后可用。您需
要删除现有快照，然后才能创建新快照。
例如，您可能需要删除在要调查的事件之前创建的快照。
- 340 -
对日志文件进行存档
可以使用 tabadmin ziplogs 命令对 Tableau Server 日志文件进行存档。此命令创
建一个包含所有日志文件的 zip 文件，在使用 Tableau 支持时，这十分有用。ziplogs
命令不删除日志文件，而是将这些文件复制到 zip 文件中。如果您运行的是 Tableau
Server 的分布式安装，则此步骤在主服务器上执行。zip 文件将包含所有工作服务器
日志。
注意：tabadmin ziplogs 命令可能生成类似以下内容的消息：“zip 错误: 不执
行任何操作!”这些通常与 zip 过程中的特定步骤相关，并不意味着日志文件存档
为空或整个存档过程失败。
创建日志文件存档：
1. 以管理员身份打开命令提示符，转到 Tableau Server 的 bin 目录。例如：
cd "C:\Program Files\Tableau\Tableau Server\8.2\bin"
2. 通过键入以下命令停止 Tableau Server：
tabadmin stop
3. 通过键入 tabadmin ziplogs -l -n <filename> 创建 zip 文件，其中
<filename> 是要创建的 zip 文件的名称。选择一个唯一名称 不带空格
Tableau 不会覆盖现有文件。例如：
。
tabadmin ziplogs -l -n my_logs
如果不指定文件名，则文件名为 logs.zip。也可以使用 -d mm/dd/yyyy 包括
自某个日期开始生成的日志。例如：
tabadmin ziplogs -l -n -d 02/14/2014
上述命令会创建名为 logs.zip 的 zip 文件，该文件包含从 2014 年 2 月 14 日至
今的日志 不包括更早的日志 。-n 选项用于捕获有关服务器环境的信息，包
括所使用的端口。若要查看所有 ziplogs 选项的列表，请键入 tabadmin
ziplogs -h。
4. 通过键入以下命令重新启动 Tableau Server：
tabadmin restart
在 Tableau Server 的 bin 目录中可以找到经过压缩的日志文件。
服务器日志文件位置
默认情况下，Tableau Server 日志文件存档收集在名为 logs.zip 的 zip 文件中 如
果使用 tabadmin 创建存档，则可以指定不同的名称 。您可以将存档从服务器复制
到本地计算机并在那里打开它，也可将它发送给 Tableau 支持人员。在您解压缩存档
时，会创建包含相关日志文件的一系列文件夹。下表说明了每个文件夹可能包含的
- 341 -
内容，以及文件在 Tableau Server 上的原始位置、创建日志文件的进程和有关文件的
详细信息。
如果您将 Tableau Server 安装在驱动器 C 上，则 Tableau Server 日志目录为
C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs，除非下表中另有说明。
日志存档文件位置
logs.zip 中的
文件/文件夹
buildversion.txt
详细信息
文件
生成进程
在 Tableau Server
上的位置
Tableau
Server 的内
部版本。
tabsvc.yml
\config
wgserver.checksum
与存储库加
assetkeyencrypt- 密相关的日
志。
ion
与订阅和安
排的活动
backgrounder
例如数据
提取刷新、
“立即运行”
任务和
tabcmd 任
务 相关的
日志。
config
配置文件。
在进行疑难
解答时，这
是开始收集
信息的好位
置。确认配
置设置是您
所期望的。
assetkeyencryption. tabadmin
assetkeys
log
backgrounder-#.log backgrounder.- \logs\backgrounder
exe
spawn.####.log
tomcat-#.####-####.log
connections.yml
workgroup.yml
Tableau
Server 配置
datacollector
dataengine
\logs\assetkeyencryption
\config
\logs\datacollector
每天都会有
tdeserver 日
志文件，其
中包含有关
数据提取和
tdeserver_####_
##_##_##_##_
##.log
- 342 -
tdeserver.exe
tdeserver64.e
xe
\logs\dataengine
dataserver
httpd
查询以及对
VizQL 服务
器请求的响
应的信息。
有关与
Tableau
Server 数据
源的连接的
信息。
Apache 日
志。在此处
查找身份验
证条目。
Apache 日志
中的每个请
求将具有与
之关联的请
求 ID。此请
求 ID 在所有
服务器日志
中使用，并
且您可以使
用它将日志
条目与请求
相关联。
dataserver-#.log
dataserver.ex- \logs\dataserver
e
access.####-####.##-##-##log
Apache 守护
程序
error.log
startup.log
licensing
logs
\logs\httpd
\logs\licensing
这是最感兴
趣和最有用
的日志的位
置。在查看
配置文件之
后查看这
里。
tabadmin.log
tabconfig.log
tablicsrv.log
tabsrvlic.log
wgserver.war.deplo
y.log
tabadmin.log
从不会被覆
盖或截断，
因此它包含
所有详细信
息。
notifytabadmin.log
包含来自
- 343 -
\logs
tabadmin.log
的错误 错
误还包括在
tabadmin.log
中 。
pgsql
tablicsrv.log
和
tabsrvlic.log
与许可相
关。
PostgreSQL
数据库日
志，包括与
启动服务器
进程相关的
文件。
Tableau 数据
提取存储在
PostgreSQL
数据库中。
repository
rsync
与高可用性
环境中的主
存储库和备
用存储库的
同步相关。
仅适用于高
可用性 (HA)
安装。
service
tabspawn
\logs\pgsql
postgres.exe
\logs\repository
\logs\rsync
notify-tabsvc.log
\logs\service
tabsvc.log
solr
与搜索索引
相关。
\logs\solr
svcmonitor
\logs\svcmonitor
与使用生成
tabadminservice 服务器日志
文件的快照
选项创建的
日志存档相
关。
tabadmwrk
\logs\tabadminservice
\logs\tabadmwrk
- 344 -
vizportal
vizqlserver
\logs\vizportal
与显示视图
并与之交互
相关。
vizql-0.log.####-##- vizqlserver.ex- \logs\vizqlserver
##
e
spawn.####.log
在运行
VizQL Server
的多个实例
时，将按端
口号区分这
些实例。
notifyproductio
n 日志包含
意外事件。
大多数文件
vizqlserver\logs 采用 JSON
格式。
在您打开数
据或连接到
数据时创建
tabprotosrv.tx
t。
backgrounder_
####_####_##_##_
##_##_##.txt
\vizqlserver\logs
dataserver_####_
####_##_##_##_
##_##.txt
tabadmin_####_
##_##_##_##_
##.txt
tabprotosrv.txt
vizqlserver_####_
####_##_##_##_
##_##.txt
wgserver_####_
####_##_##_##_
##_##.txt
wgserver
与管理任
务、工作簿
和权限管
理、身份验
证、登录、
初始视图请
求以及发布
tdserver_
vizqlserver_####_
####_##_##_##_
##_##.txt
db-migrate_####_
##_##_##_##_
##.log
migrate.log
notifyproduction.####_
- 345 -
wgserver.exe
\logs\wgserver
请求相关的
信息。
####_##_##_##_
##_##.log
浏览，搜
索。
production.####.log
wgserver 的
实例按
“production”
或“notifyproduction”之
后紧跟的端
口号进行区
分。
production.####_
####_##_##_##_
##_##.log
spawn.####.log
tomcat-#.####_##_
##.log
wgserver-#.log
notifyproduction 日
志包含意外
事件。
每天每个后
台运行进程
都会有单独
的
production.n_
### 文件。
notifyproduction.n_
### 与
production.n_
### 相关，
但仅包含错
误。
Tableau Server 日志文件位于服务器上的以下文件夹中：
Tableau Service 日 志
以下日志文件对与 Web 应用程序、数据库和索引有关的活动进行跟踪：
C:\ProgramData\Tableau\Tableau Server\data\tabsvc
VizQL 日 志
这些日志文件跟踪与显示视图有关的活动
如查询数据库和生成图像
：
C:\ProgramData\Tableau\Tableau Server\data\tabsvc\vizqlserver\Logs
临时文件
下面的文件夹中所有以 exe_ 开头的文件都是 Tableau Server 文件，可以删除。
C:\ProgramData\Tableau\Tableau Server\temp
- 346 -
更改日志记录级别
默认情况下，Tableau Server 记录信息级别的事件。如果您需要收集更多信息，可以
更改此级别 例如，如果您与 Tableau 支持人员合作 。作为最佳做法，除非是为了
排查问题，否则不应提高日志记录级别。
日志记录级别
以下日志记录级别是按照记录的信息量的递增顺序列出的：
l
l
l
l
l
l
l
off
fatal
error
warn
info 默认值
debug
trace
注意： 将日志级别提高到调试或跟踪会增加要记录的信息量，并且会对性能产
生显著影响。您只应在调查特定问题时将日志记录级别设置为调试。重现问
题，然后将日志记录级别重置回信息。
更改日志记录级别
可使用多个 tabadmin set 命令之一为 Tableau Server 设置日志记录级别。您使用的命
令取决于您要更改 Tableau Server 的哪个组件的日志记录级别。
命令
受影响的日志的位置
server.log.level
vizqlserver.log.level
wgserver.log.level
以 \ProgramData\Tableau\Tableau Server\data\tabsvc 开头的路
径
\vizqlserver\Logs\*.txt
\vizqlserver\*.log
\wgserver\*.log
有关更多信息，请参见 tabadmin set 选项 在本页 324。
您需要在更改日志记录级别之前停止 Tableau Server，然后在更改之后重新启动它。
如果您运行的是 Tableau Server 的分布式安装，请从主服务器设置日志记录级别。
更改日志记录级别：
1. 以管理员身份打开命令提示符，转到 Tableau Server 的 bin 目录。
如果 Tableau Server 安装在 C 驱动器上：
C:\Program Files\Tableau\Tableau Server\8.2\bin
或
- 347 -
C:\Program Files (x86)\Tableau\Tableau Server\8.2\bin
2. 通过键入以下命令停止 Tableau Server：
tabadmin stop
3. 通过键入 tabadmin set [command][option] 来设置日志记录级别
其中，[command] 是 server.log.level、vizqlserver.log.level 或
wgserver.log.level
[option] 是有效的日志记录级别。
示例：
l
tabadmin set server.log.level debug
l
tabadmin set vizqlserver.log.level warn
l
tabadmin set wgserver.log.level off
4. 通过键入以下命令重新启动 Tableau Server：
tabadmin restart
重置日志记录级别
在收集了与要调查的问题相关的信息之后，重置日志记录级别，以避免对性能产生
影响。
使用带有 -d 选项的适当命令将日志记录级别重置回其默认值 (info)。
示例：
l
tabadmin server.log.level -d
l
tabadmin vizqlserver.log.level -d
l
tabadmin wgserver.log.level -d
处理未许可的服务器
Tableau 提供了两种许可模型：基于用户和基于内核。基于用户的许可要求每个活动
用户帐户都需要有一个许可证。基于用户的许可证具有定义的容量或它所允许的用
户数目。每个用户在服务器上都分配有唯一用户名，在连接到服务器时需要进行身
份识别。软件可以安装在一台计算机上，也可以在分布式服务器环境中的任意多台
计算机上进行分布式安装。
基于内核的许可对系统中用户帐户的数目没有限制，但会限制 Tableau Server 能够使
用的处理器内核的最大数目。您可以将服务器安装在一台计算机上或安装在多台计
算机上以创建一个群集，但所有计算机上内核的总数不能超出获得许可的内核数
目，并且特定计算机上的所有内核都要拥有许可证。
- 348 -
未许可的基于用户的服务器
进行基于用户的许可的服务器未获得许可的最常见原因是产品密钥过期或维护合同
过期。通过选择“开始”>“所有程序”>“Tableau Server”>“管理产品密钥”，可以查看产
品密钥和添加新密钥。
未许可的基于内核的服务器
基于内核的服务器可出于多种原因而未获得许可。其中一个常见问题是主计算机或
工作计算机的内核数超出了许可证允许的数目。当服务器未获得许可时，您可能无
法启动或管理该服务器。不过，您可以使用 tabadmin 命令行工具来管理许可证。按
以下步骤操作可查看您的许可证列表和计算机内核数。
1. 打开命令提示符，键入以下内容：cd C:\Program
Files\Tableau\Tableau Server\8.2\bin
2. 键入以下命令：tabadmin licenses.
处 理 未 许 可 的 VizQL Server 进 程
Tableau Server“维护”页面上有若干状态指示器，有助于您了解 Tableau Server 进程的
状态。如果出现 “未许可”橙色状态框，则表示某个 VizQL 服务器进程无法检索
Tableau Server 许可证信息。
可能有若干原因造成进程无法访问此信息。例如，可能存在网络问题，使得工作计
算机上运行的 VizQL 进程无法与主计算机通信。或者，该进程收到的请求数可能超出
了其当时的接受能力，导致无法处理许可请求。这造成一些用户可以访问视图，而
另一些用户则不能访问。
若要解决该问题，请先停止然后再启动 Tableau Server。
VizQL“内 存 不 足 ”错 误
在 32 位版本的 Tableau Server 中，如果 VizQL 进程达到了并发查看会话数的限制，则
可能出现“内存不足”错误，该错误还会写入位于以下位置的 vizqlserver*.txt 日志：
C:\ProgramData\Tableau\Tableau
Server\data\tabsvc\vizqlserver\Logs
出现此错误时，VizQL 进程不会终止，但不再接受更多连接。可以通过以下方法来处
理此问题：
- 349 -
l
l
l
升级到 64 位版本的 Tableau Server：有关详细信息，请参见升级到8.2 在本页
27。
增加 VizQL 进程数：这可能意味着您需要添加一个或多个工作服务器。有关如
何完成这一操作的信息，请参见安装和配置工作服务器 在本页 36。
编辑 vizqlserver.session.expiry.timeout：使用 tabadmin 更改
vizqlserver.session.expiry.timeout 设置，将其默认值 30 分钟 改为较短的时
段，例如 10 分钟或 5 分钟。这将使得空闲会话更快到期，从而释放内存用于新
会话。
Cookie 限 制 错 误
用户登录到 Tableau Server 时，会话 Cookie 会存储到他们的本地浏览器中。Tableau
Server 利用存储的 Cookie 来保留通过身份验证且可访问服务器的已登录用户。由于
Cookie 设置的域或子域与浏览器地址栏中的域或子域相同，因此该 Cookie 被认定为
第一方 Cookie。如果用户浏览器配置为阻止第一方 Cookie，则它们将无法登录到
Tableau Server。
如果用户通过嵌入式视图或在配置了受信任的身份验证的环境中登录到 Tableau
Server，则会发生同样的情况：系统会存储此 Cookie。但在这种情况下，浏览器会将
此 Cookie 当做第三方 Cookie 来处理。这是由于 Cookie 设置的域与浏览器地址栏中显
示的域不同。如果用户 Web 浏览器设置为阻止第三方 Cookie，则此 Cookie 将无法通
过 Tableau Server 所需的身份验证。要避免出现这种情况，Web 浏览器必须配置为允
许第三方 Cookie。
数据源疑难解答
对于使用 Tableau Server 数据源的用户，最多需要满足三个条件：
l
数据源的权限：任何连接到数据源的人员必须同时具有该数据源的“连接”和“查
看”权限。这同样适用于访问与数据源相连的视图的用户。任何人要发布和修
改数据源，都必须获得“发布”许可并具有“写入/另存为”和“下载/Web 另存为”的
权限。有关更多信息，请参见使用权限 在本页 172和设置数据源的权限 在本页
175。
必须下载多维 多维数据集 数据源并在 Tableau Desktop 中使用它们，因此它
们需要“下载/另存到 Web”权限。有关 Tableau 中的多维数据集的详细信息，请
参见多维 多维数据集 数据源 在本页 132。
l
l
能够通过数据库身份验证：您可通过多种方式连接到 Tableau 中的数据并控制
谁可以访问哪些数据。基本上，无论哪个实体要连接数据库，都必须能够通过
身份验证。该实体可以是执行数据提取刷新的 Tableau Server。该实体可以是连
接到数据源随后再连接到实时数据库的 Tableau Desktop 用户。该实体还可以是
要访问连接到实时数据库的视图的 Tableau Server 用户。若要了解这些选项的
更多信息，请参见数据安全 在本页 202。
数据库驱动程序：如果在 Tableau Desktop 中创建和发布数据源的人需要安装其
他数据库驱动程序，则您可能也需要在 Tableau Server 上安装这些驱动程序。
- 350 -
如果您正在运行分布式安装的 Tableau Server，例如，数据服务器进程在工作服
务器上运行，则必须在该工作服务器上和主服务器上安装任何需要的数据库驱
动程序。其他进程也需要驱动程序。有关更多信息，请参见数据库驱动程序 在
本页 38。
数据源错误消息
下面是工作簿作者和其他用户使用数据源和视图时可能遇到的一些错误：
访问此 Tableau Server 数据源的权限被拒绝：连接到数据源需要拥有“连接”权限。有
关更多信息，请参见使用权限 在本页 172和设置数据源的权限 在本页 175的权限。
未找到数据源： 如果已从 Tableau Server 中删除数据源，或者使用视图的用户的“连
接到数据”页面需要更新，则该用户可能会看到此错误。若要更新 Tableau Desktop 中
的“连接到数据”页面，请单击“刷新”图标：
无法连接到此 Tableau Server 数据源：如果数据源的连接信息已发生改变 例如，
由于数据库服务器名称已更改 ，则可能会出现此错误。检查该数据源的“数据连接”
信息并确认其设置正确。
无法列出 Tableau Server 数据源： 如果用户尝试访问 Tableau Server 数据源且
Tableau Server 和 Tableau Desktop 之间存在连接问题，则可能发生此错误。
无法连接到多维数据集数据源：要使用已发布的多维 多维数据集 数据源，您必
须下载该数据源并在 Tableau Desktop 中使用它。验证您是否拥有该数据源的“下载/另
存到 Web”权限。有关 Tableau 中的多维数据集的详细信息，请参见多维 多维数据
集 数据源 在本页 132。
订阅疑难解答
"此 电 子 邮 件 中 的 视 图 快 照 无 法 正 确 呈 现 。 ”
如果您接收的订阅出现此错误消息，可能是由以下几种原因导致的：
l
l
缺失凭据：某些视图是与嵌入式凭据一起发布的。如果嵌入式凭据现已过时或
视图并未与嵌入式凭据一起发布，则您可能会收到以上错误消息。
数据库暂时瘫痪：如果视图具有实时数据库连接，且数据库在生成订阅时暂时
瘫痪，则您可能会收到以上错误消息。
- 351 -
l
后台进程超时：默认情况下，处理订阅的后台进程如果在 30 分钟后还未完成，
就算超时。大部分情况下，30 分钟足够了。但如果后台进程在处理极大且非常
复杂的仪表板，30 分钟可能就不够。您可以检查后台任务 在本页 147管理视
图，看看是否出现了这种情况。若要提高超时阈值，请使用 tabadmin 选项
subscriptions.timeout。
无法订阅
如果您在 Tableau Server 上可以看到视图并且该视图的右上角有一个订阅图标 (
则您可以订阅该视图。
)，
需要存在以下两项，您才能订阅视图：需要正确配置 Tableau Server 请参见管理订
阅 在本页 95 ，并且您订阅的视图必须已嵌入其数据源的凭据或者根本不需要凭
据。后一种情况的示例连接到不需要刷新的数据提取的工作簿，或其数据位于发布
时工作簿附带的文件中的工作簿。嵌入凭据的步骤在 Tableau Desktop 中执行 有关
详细信息，请参见 Tableau Desktop 帮助 。
没有订阅图标
可以在 Tableau Server 上看到视图但无法订阅它。具有实时数据库连接的视图会出现
这种情况，当您首次单击该视图时，会提示您提供数据库凭据。订阅包括视图 或
工作簿 、数据和计划。为了交付数据，Tableau Server 需要嵌入式数据库凭据或不
需要凭据的数据。至于实时数据库连接，Tableau Server 没有相关凭据，只有单个用
户拥有凭据。这就是为什么您只能订阅不需要凭据或已嵌入凭据的视图的原因所
在。
如果 Tableau Server 配置为使用受信任的身份验证，您也可能可以看到视图但无法订
阅它 没有订阅图标 。有关详细信息，请参见订阅要求。
接 收 的 订 阅 无 效 或 “破 损 ”
如果除了生产实例，您还配置了 Tableau Server 测试或开发实例上的订阅，请禁用非
生产实例上的订阅。在所有实例上将订阅保持为启用状态会导致您用户接收到看起
来有效但实际无法运作的订阅，或接收到已在视图或工作簿上取消的订阅。
订阅没有到达
“发 送 电 子 邮 件 时 出 错 。 无 法 向 SMTP 主 机 发 送 命 令 。 ”)
如果订阅显示为已发送 根据后台任务 在本页 147管理视图 但没有到达，并且您的
SMTP 服务器使用的是加密 (SSL) 会话，您可能会在 Windows 事件查看器中看到以上
错误消息。订阅只支持未加密的 SMTP 连接。解决方案是使用未加密的 SMTP 服务
器。
升 级 到 8.1 后 ， 自 定 义 脚 本 不 工 作
为了更好地管理会话，从 8.1 版开始，向视图 URL 末尾添加了一个井号 (#)。如果您
的自定义订阅脚本会以 PDF 或 PNG 形式生成视图，可能需要更新脚本以允许使用井
号。
- 352 -
例如，在 8.1 版之前，视图 URL 类似于
http://tableauserver/views/SuperStore/sheet1，您可以向 URL 末尾添加
.png 生成 PNG 形式的视图，例如
http://tableauserver/views/SuperStore/sheet1.png。 从 8.1 版开始，视图
URL 类似于：http://tableauserver/views/SuperStore/sheet1#1。若要生
成 PNG，可在井号前面添加 .png。例
如：http://tableauserver/views/SuperStore/sheet1.png#1
SAML 疑 难 解 答
使用以下主题排查 SAML 问题。
SAML 和 “启 用 自 动 登 录 ”
如果您使用 SAML 且 Tableau Server 还配置为使用 Active Directory，请不要同时选择
“启用自动登录”。 “启用自动登录”和 SAML 不能同时使用。
从命令行登录
即使 Tableau Server 配置为使用 SAML，但如果您使用命令行工具 tabcmd 在本页 289
或 Tableau 数据提取命令行实用工具 随 Tableau Desktop 提供 登录 Tableau
Server，也不会使用 SAML。
登录失败
如果收到消息“登录失败：用户 <username from IdP> 的身份提供程序身份验证成功。
未在 Tableau Server 中找到该用户”，则表示 Tableau Server 中存储的用户名与 IdP 中
存储的用户名不同。若要解决此问题，请确保它们匹配。例如，如果史珍妮的用户
名在 IdP 中存储为 jsmith，那么它在 Tableau Server 中也必须存储为 jsmith。
SAML 错 误 日 志
SAML 登录错误记录在以下位置。可使用此日志排查问题。
C:\ProgramData\Tableau\Tableau
Server\data\tabsvc\logs\wgserver\error.log
处理数据提取刷新通知
如果计划的数据提取刷新失败，Tableau 将在右上角显示“通知”菜单：
仅当数据提取刷新失败，并且您具有以下身份时，才会看到“通知”菜单：
- 353 -
l
系统管理员和站点管理员。
l
未能刷新的工作簿或数据源的作者。
l
连接到未能刷新的数据源的工作簿的作者。
打开“通知”菜单后，可以看到有关刷新失败的更多信息：
当“数据源”列示为“嵌入”时，意味着该数据源定义 包括数据源凭据或数据库名称等
内容 嵌入或驻留在原来在 Tableau Desktop 中创建的工作簿自身中。
当数据源名称或工作簿名称列示为“数据源”时 例如数据源: sales_data
该数据源是 Tableau Server 数据源。数据源定义位于 Tableau Server 上。
，意味着
在数据窗口中，您可以识别原来在 Tableau Desktop 中创建的工作簿或数据源。 数据
源名称旁边会显示一个 Tableau 图标而非数据库图标：
- 354 -
解决数据提取刷新问题
通过单击通知中的“编辑连接信息”链接，输入缺少的信息，然后单击“保存”，可以解
决一些数据提取刷新问题：
如果通过编辑数据连接无法解决问题，则需要在 Tableau Desktop 中解决它并重新发
布工作簿。
提示： 管理员可以随时在“数据连接”页面上编辑数据连接，可从“管理”选项卡访问
该页。
- 355 -
JavaScript API
使用 Tableau 的 JavaScript API，您可以将 Tableau 可视化项整合到您自己的 Web 应用
程序中。该 API 允许您密切控制用户的交互并组合通过其他方式无法组合的功能。例
如，您可以对单个控件进行编码，以筛选一组标记，选择其中的一些标记，并呈现
其数据以供下载。有关详细信息，请参见以下主题：
l
要求
l
概念
l
教程
l
API 参考
要求
Tableau 的 JavaScript API 的要求如下所示：
Tableau Server：使用 Tableau 的 JavaScript API 对 Tableau Server 进行编程。 该 API 由位于以下文件夹中的 tableau_v8.js 文件提供支持：Program
Files\Tableau\Tableau Server\8.2\wgserver\public\javascripts\api.
您的 Web 应用程序不应该与 Tableau Server 位于同一计算机上，但需要能够访问
Tableau Server。
受支持的浏览器：您的最终用户可以在大多数受支持的 Web 浏览器中使用您创建的
Web 应用程序，具体说就是：Chrome、Firefox、Safari 3.2.1 和更高版本以及 Internet
Explorer 8.0 和更高版本。如果使用的是 Internet Explorer 8.0，则必须禁用兼容性模
式。另外，您的浏览器必须配置为允许在 JavaScript 代码中使用 window.postMessage
方法。一些安全包会禁用此功能。
概念
本主题专为熟悉 JavaScript 和面向对象的编程概念的人员而设计。从用户的角度而
言，您还应该熟悉 Tableau 可视化项。如果是刚刚入门，最好先阅读教程。
编程方法
Tableau JavaScript API 使用对象模型。进入对象模型的方法是按如下所示实例化一个
新的 Viz 对象：
var viz = new tableauSoftware.Viz(/* params omitted */);
几乎每个 Tableau 对象都允许您导航回其父 Viz 对象，方法是通过对象上的“父”属
性。
访 问 API
该 API 旨在以编程方式控制发布到本地 Tableau Server 或 Tableau 托管服务器的嵌入
式视图。为了使用该 API，您需要能够访问运行 8.0 版或更高版本的服务器以及该服
- 356 -
务器上发布的工作簿。
该 API 通过文件 tableau_v8.js 缩小 或 tableau_v8.debug.js 提供。在包含用于呈现
Tableau 视图的 JavaScript 代码的网页中，您可以使用以下地址引用 API 文件：
http://<your_server_name>/javascripts/api/
例如，如果使用服务器名称 localhost，您将在页标头中添加以下代码：
<script type="text/javascript"
src="http://localhost/javascripts/api/tableau_
v8.js"></script>
这些文件在文件系统中的位置为 Program
Files\Tableau\Tableau Server\8.2\wgserver\public\javascripts\api
。
使用 Tableau 托管服务器
如果您将工作簿发布到 Tableau Online 或 Tableau Public，则可以访问与您使用的服务
器产品匹配的 API。
l
对于 Tableau Online，使用以下位置：
https://online.tableausoftware.com/javascripts/api/
l
对于 Tableau Public，使用以下位置：
https://public.tableausoftware.com/javascripts/api/
向 URL 中添加要使用的 API 的文件名 tableau_v8.js 或 tableau_v8.debug.js
面的访问 API 上一页 部分中的示例代码中所示。
，如前
重要信息：为获得最佳的代码稳定性，请使用您所用的服务器产品的 API 位
置。例如，如果您将工作簿发布到本地 Tableau Server，请使用您的服务器的本
地 JavaScript API。
自引导
该 API 只有一个入口：实例化一个新 Viz 对象，这将创建嵌入 Tableau 可视化项所必
需的 HTML 代码。若要实例化新 Viz 对象，只需通过 new 调用 Viz 构造函数，并传
递必需的 parentElement 和 URL 参数以及一组可选选项。URL 参数用于指定
Tableau 服务器的名称：
var placeholderDiv = document.getElementById("tableauViz");
var url = "http://tabserver/views/workbookname/viewname";
var options = {
hideTabs: true,
width: "800px",
height: "700px"
- 357 -
};
var viz = new tableauSoftware.Viz(placeholderDiv, url, options);
受信任的身份验证
如果 Tableau Server 使用受信任的身份验证，请在 URL 中指定票证，方法是先在服务
器名称后面添加 trusted，然后添加票证。例如：
var placeholderDiv = document.getElementById("tableauViz");
var url = "http://tabserver/trusted/Etdpsm_Ew6rJY9kRrALjauU/views/workbookname/viewname";
var options = {
hideTabs: true,
width: "800px",
height: "700px"
};
var viz = new tableauSoftware.Viz(placeholderDiv, url, options);
属 性 Getter 和 Setter
Getter 和 setter 始终是以 get 或 set 开头的函数。 它们可以多次调用，对性能几乎没
有影响 换句话说，它们只返回缓存的字段，或者只执行非常简单的计算 。属性
始终与值同步，并随值一起立即返回，而不具有回调函数。
调用行为 - 异步
默认情况下，调用异步进行，因为许多调用可能都需要往返于服务器。方法使用以
下命名惯例：
l
l
异步调用由方法名称中的 Async 后缀指示，例如
Worksheet.applyFilterAsync()。
异步调用返回 Promise 对象，允许串连。
Tableau JavaScript API 使用 CommonJS Promises/A 标准。 Tableau 的实现机制的前提
是异步方法返回具有 then 方法的对象，形式如下：
then(fulfilledHandler, errorHandler)
当满足此承诺 成功 时将调用 fulfilledHandler。 不满足承诺时调用
errorHandler。所有实参都是可选的，并将忽略非函数值。
串连前提
异步方法的承诺结果将作为参数传递给下一个 then() 方法。例如：
var activeSheet;
viz.getWorkbook().activateSheetAsync("Sheet 1")
.then(selectLemon).then(filterToLemonAndMint);
- 358 -
function selectLemon(sheet) {
activeSheet = sheet;
return sheet.selectMarksAsync("Product", "Lemon", "replace");
}
function filterToLemonAndMint() {
return activeSheet.applyFilterAsync("Product", ["Lemon",
"Mint"], "replace");
}
activateSheetAsync() 的结果是承诺最终返回已激活的 Sheet 对象，该对象将作
为第一个参数传递给 selectLemon() 方法。请注意，selectLemon() 方法返回一
个 Promise 对象 selectMarksAsync() 方法的返回值 ，而不是选择标记后的结
果。但是，由于这是一个 Promise 对象，因此除非满足该承诺，否则不会调用下一
个 then() 方法。
如果链中的某个环节是在满足承诺之后添加的，将使用之前返回的值立即调用回
调。作为编程人员，这意味着您无需确定是否已收到服务器的响应。总是会调用异
步方法，只是时间早晚的问题。
var promise = viz.getWorkbook().activateSheetAsync("Sheet 1");
// Pretend that activatSheeteAsync() has already returned from
the server.
promise.then(callback);
// callback will be called immediately using the Sheet object
// returned from activateSheetAsync()
Then() 方法的返回值
无论 then() 方法返回什么结果，该结果都会作为第一个参数传递给下一个 then()
方法。它可以是一个标量值 Number、Boolean、String 等 ，也可以是一个对象
或另一个 Promise。 基础结构会自动将非 Promise 值包装到 Promise 值，以便能
够串连起来。
viz.getWorkbook().activateSheetAsync("Sheet 1")
.then(function (sheet) {
return "First link";
})
.then(function (message) {
if (message === "First link") { alert("Expected"); }
- 359 -
// no return value here means nothing is passed to the next
link
})
.then(function () {
});
中断链
从技术上讲，没有办法中断链，因为那将无法保证链中的后续环节将会被调用。如
果链中引发异常，链的其余部分仍将运行，但将调用 errorHandler 而不是
fulfilledHandler。
如果链中的某个环节依赖于前面环节的结果，则应该编写一个 if 语句来检查条件。
下面是一个示例：
viz.getWorkbook().activateSheetAsync("Sheet 1")
.then(function (sheet) {
// I’m returning a Promise
return sheet.selectMarksAsync("Product", "NoProduct",
"replace");
})
.then(function () {
return viz.getWorkbook().getActiveSheet().getSelectedMarksAsync
();
})
.then(function (marks) {
// The getSelectedMarksAsync call succeeded, but no marks were
selected
// because there are not any marks corresponding to
"NoProduct".
if (marks.length === 0) { throw new Error("No marks selected");
}
var firstMarkValue = marks[0].getPairs().get("Product").value;
return sheet.applyFilterAsync("Product", firstMarkValue,
"replace");
})
.then(function (filterName) {
// applyFilterAsync succeeded
- 360 -
}, function(err) {
if (err.message === "No marks selected") {
alert("This was caused by the first link above");
}
})
.otherwise(function (err) {
alert("We handled the error above, so it’s not propagated to
this handler.");
});
如果不提供回调
或者回调为空或未定义
，则结果将传递给链中的下一个环节：
viz.getWorkbook().activateSheetAsync("Sheet 1")
.then()
.then(function (sheet) {
// this is called
});
这样，您就可以指定一个 otherwise 函数来处理链中的所有错误。always 函数的
工作方式相同，但无论成败，它都会被调用。then/otherwise/always 函数的工
作方式与 try/catch/finally 块类似。
viz.getWorkbook().activateSheetAsync("Sheet 1")
.then(function () {
return sheet.selectMarksAsync(...);
})
.then(function (marks) {
// Do something with the marks.
})
.otherwise(function (err) {
// I’m handling all errors in one place.
console.log(err.message);
})
.always(function () {
// Do some cleanup or logging
});
集合
许多类都有项集合，其中每个项都有一个关键值 通常是 ID 或名称 。示例包括用
名称作为关键值的工作表集合，或工作表上用名称作为关键值的参数列表。集合是
公开不可变的，只公开只读功能。每个集合数组都用其元素的标识符作为关键值。
例如，Workbook.getPublishedSheetsInfo() 的结果就是一个数组，其索引与工
作表在工作簿中的位置对应。它也用工作表名称作为关键值，因此您可以通过以下
方式访问它：
- 361 -
var sheet = workbook.getPublishedSheetsInfo()[0];
var sameSheet = workbook.getPublishedSheetsInfo().get("Sheet 1");
集合界面
名称
get(key :
string)
has(key :
string)
返回
类型
集合
项类
型
bool
说明
获取与关键值关联的集合中的元素，如果没有任何内容
与关键值关联，则表示未定义元素。
如果与关键值关联的集合中存在元素，则返回 true；否则
返回 false。
事件
Viz 类充当事件的中枢。这样，您只需转到一个位置即可查看所有事件。这还意味
着，可以对可能尚未创建的对象引发事件。例如，可以对特定工作表引发
marksselection 事件，即使 Sheet 对象尚未创建。每个事件都包含一个匿名对
象，该对象含有与该事件相关的信息，例如发生事件的工作表。
侦听事件通过调用 Viz.addEventListener(type, callback) 并传入函数回调完
成。下面是侦听事件的示例：
viz.addEventListener("marksSelection", function (marks) {
changeMySelectionUI(marks);
});
移除侦听器通过调用 Viz.removeEventListener(type, listener) 并传入回调
函数 与传入 Viz.addEventListener() 的回调函数相同 完成。 例如：
function changeMySelectionUI(marks) {
viz.removeEventListener("marksSelection",
changeMySelectionUI);
}
viz.addEventListener("marksSelection", changeMySelectionUI);
事件是多播委派，这意味着支持多个侦听器。未指定调用通知的顺序。每个事件回
调都使用一个包含指针的对象，该指针指向引发该事件的 Viz。每个事件都还会添加
更多字段，如 API 参考 在本页 368中所述。
筛选
对筛选功能进行编程时，实际上您是在模仿用户单击视图中的筛选器以缩小显示的
数据范围的行为。下面是筛选单个值的示例：
worksheet.applyFilterAsync("Container", "Jumbo Box",
tableauSoftware.FilterUpdateType.REPLACE);
- 362 -
查询现有筛选器状态与设置新或现有筛选器有所不同。查询筛选器可通过
Worksheet.getFiltersAsync() 完成，它会返回 Filter 类的集合。设置字段可
通过 Worksheet.applyFilterAsync 及其变体 变成，并且它是一个不要求您实
例化 Filter 类的函数调用。
在筛选器中指定字段时，应使用用户界面中显示的标题，而不是数据库字段名称。
例如，您应该使用 Container 标题 而不是 Product Container 实际字段名称 。
有些情况下，Tableau Desktop 会在您将字段拖到功能区后重命名字段。例如，在将
Date 字段拖到行功能区后，它可能会被重命名为 YEAR(Date)。在本例中，应使用
YEAR(Date) 作为参数。例外情况是分层筛选器，它使用完整分层名称 例如，
[Product].[All Product].[Espresso] 。标题可以在名称两侧使用可选的 []
分隔符。
下面是许多类型的筛选的示例：
var worksheet;
viz.getWorkbook().activateSheetAsync("Sheet 4").then(function
(sheet) {
worksheet = sheet;
})
// Single value
.then(function () {
return worksheet.applyFilterAsync("Product Type", "Coffee",
tableauSoftware.FilterUpdateType.REPLACE);
})
// Multiple values
.then(function () {
return worksheet.applyFilterAsync(
"Product Type", ["Coffee", "Tea"],
tableauSoftware.FilterUpdateType.REPLACE);
})
// Multiple Values - adding and removing
.then(function () {
return worksheet.applyFilterAsync("Product", ["Lemon", "Mint"],
tableauSoftware.FilterUpdateType.ADD);
})
.then(function () {
return worksheet.applyFilterAsync("Product", ["Caffe Latte",
"Green Tea"],
tableauSoftware.FilterUpdateType.REMOVE);
})
- 363 -
// All values
.then(function () {
return worksheet.applyFilterAsync("Product Type", "",
tableauSoftware.FilterUpdateType.ALL);
})
// Date Range
.then(function () {
return; worksheet.applyRangeFilterAsync("Date", {
min: new Date(Date.UTC(2010, 3, 1)),
max: new Date(Date.UTC(2010, 12, 31))
});
})
// Clearing a Filter
.then(function () {
return worksheet.clearFilterAsync("Date");
})
// Relative Date
.then(function () {
return worksheet.applyRelativeDateFilterAsync("Date", {
anchorDate: new Date(Date.UTC(2011, 5, 1)),
periodType: tableauSoftware.PeriodType.YEAR,
rangeType: tableauSoftware.DateRangeType.LASTN,
rangeN: 1
});
})
// Quantitative Filters
// SUM(Sales) > 2000 and SUM(Sales) < 4000
.then(function () {
return worksheet.applyRangeFilterAsync("SUM(Sales)", {
min: 2000,
max: 4000
});
})
// SUM(Sales) > 1000
.then(function () {
return worksheet.applyRangeFilterAsync("SUM(Sales)", {
min: 1000
});
- 364 -
})
// Hierarchical Filters - selecting all on a level
.then(function () {
return worksheet.applyHierarchicalFilterAsync("[Product].
[Product Categories]", {
levels: [0, 1]
}, tableauSoftware.FilterUpdateType.ADD);
}, function (err) { /* ignore errors */ })
// Hierarchical Filters - adding one item
.then(function () {
return worksheet.applyHierarchicalFilterAsync(
"[Product].[Product Categories].[Product Name]",
"Accessories.Bike Racks.Hitch Rack - 4-Bike",
tableauSoftware.FilterUpdateType.REPLACE);
}, function (err) { /* ignore errors */ })
// Hierarchical Filters - adding multiple items
.then(function () {
return worksheet.applyHierarchicalFilterAsync(
"[Product].[Product Categories].[Product Name]",
[
"Accessories.Bike Racks.Hitch Rack - 4-Bike",
"Accessories.Bike Stands.All-Purpose Bike Stand"
],
tableauSoftware.FilterUpdateType.REPLACE);
}, function (err) { /* ignore errors */ })
.otherwise(function (err) {
console.log(err);
});
选择标记
选择标记与筛选基本相同。对于筛选，应使用 Worksheet.applyFilterAsync()
方法之一。对于选择标记，应使用 Worksheet.selectMarksAsync()。用于标记
选择的参数与用于筛选的参数基本相同。
worksheet.selectMarksAsync("Product", "Caffe Latte",
tableauSoftware.SelectionUpdateType.REPLACE);
下面是您可以使用的其他类型的标记选择的示例：
var worksheet;
viz.getWorkbook().activateSheetAsync("Sheet 4").then(function
- 365 -
(sheet) {
worksheet = sheet;
})
// Single dimensions work just like filtering
// Single dimension - single value
.then(function () {
return worksheet.selectMarksAsync("Product", "Mint",
tableauSoftware.SelectionUpdateType.REPLACE);
})
// Single dimension - Multiple values
.then(function () {
return worksheet.selectMarksAsync(
"Product", ["Chamomile", "Mint"],
tableauSoftware.SelectionUpdateType.REPLACE);
})
// Single dimension - Multiple values (delta)
.then(function () {
return worksheet.selectMarksAsync("Product", ["Lemon", "Earl
Grey"],
tableauSoftware.SelectionUpdateType.ADD);
})
.then(function () {
return worksheet.selectMarksAsync(
"Product", ["Chamomile", "Earl Grey"],
tableauSoftware.SelectionUpdateType.REMOVE);
})
// Quantitative selection
.then(function () {
return worksheet.selectMarksAsync({
"State": ["Florida", "Missouri"],
"SUM(Sales)": { min: 3000, max: 4000 }
}, tableauSoftware.SelectionUpdateType.REPLACE);
})
// Hierarchical dimensions
.then(function () {
return worksheet.selectMarksAsync(
"[Product].[Product Categories].[Category]",
"Bikes",
- 366 -
tableauSoftware.SelectionUpdateType.REPLACE);
}, function (err) { /* ignore errors */ })
// Multiple dimensions - multiple values
// ((State = Washington OR Oregon) AND Product = Lemon)
// OR
// (State = Oregon AND Product = Chamomile)
.then(function () {
return worksheet.selectMarksAsync({
"State": ["Washington", "Oregon"],
"Product": "Lemon"
}, tableauSoftware.SelectionUpdateType.REPLACE);
})
.then(function () {
return worksheet.selectMarksAsync({
"State": "Oregon",
"Product": "Chamomile"
}, tableauSoftware.SelectionUpdateType.ADD);
})
// Round-tripping selection
.then(function () {
return worksheet.selectMarksAsync(
"Product",
"Lemon",
tableauSoftware.SelectionUpdateType.REPLACE);
})
.then(function () {
return worksheet.getSelectedMarksAsync();
}).then(function (marks) {
// filter out only the Washington and Oregon marks
var onlyWashingtonAndOregon = [];
for (var i = 0, len = marks.length; i < len; i++) {
var m = marks[i];
var pair = m.getPairs().get("State");
if (pair &&
(pair.value === "Washington" || pair.value === "Oregon")) {
onlyWashingtonAndOregon.push(m);
}
}
return worksheet.selectMarksAsync(
onlyWashingtonAndOregon,
tableauSoftware.SelectionUpdateType.REPLACE);
})
- 367 -
.otherwise(function (err) {
console.log(err);
});
API 参 考
样式和约定
Tableau 的 JavaScript API 遵循以下 JavaScript 标准：
l
l
类是 PascalCase
首字母大写，每个后续单词的首字母也大写
命名空间、方法、参数和变量是 camelCase
字母大写
首字母小写，每个后续单词的首
l
常量和枚举值是 UPPERCASE_UNDERSCORE_DELIMITED
l
受保护的变量或方法以下划线“_”字符开头，指示它不应由编程人员引用。
顶级类表
以下类表显示顶级类之间的关系，以及 Sheet、Dashboard、Story 和 Worksheet
类的继承分层结构。请注意，总是有办法使用父指针向回遍历包含分层结构，
VizManager 例外，因为它是静态类，并且始终可访问。
- 368 -
异步和错误类
Promise 类
表示以后从异步方法返回值的承诺。Tableau JavaScript API 实施 Promises/A 规范。
方法
名称
返回类 说明
型
then(callback:
Promise 在异步可调用链中创建链接。成功时调用回调
Function, errback:
函数。出现错误时调用 errback 函数。这两个
Function)
参数都是可选的。
always(callback:
Promise 注册将在解决或拒绝承诺时调用的回调。then
Function)
(callback, callback) 的快捷方式。
otherwise(errback: Promise 注册拒绝处理程序。then(null, errback) 的快捷
Function)
方式。
TableauException 类
TableauException 类不是一个真正的类，只是在 API 中引发异常时，向标准
JavaScript Error 对象添加一个 ID 字段。作为编程人员，这允许您唯一地标识错误，
而不必分析错误字符串。它还允许您添加本地化消息。
构造函数
没有公共构造函数。获取对 TableauException 的引用的唯一方法在 catch 块中进行。
字段
名称
类型
说明
tableauSoftwareErrorCode ErrorCode 表示 ErrorCode 枚举值。
message
这已在标准 Error 对象上定义，但消
息将包含 API 代码指定的异常的说
明。
string
ErrorCode 枚举
下面是 API 可引发的不同异常的列表：
名称
BROWSER_
NOT_
CAPABLE
DOWNLOAD_
WORKBOOK_
NOT_
ALLOWED
FILTER_
值
browserNotCapable
说明
浏览器无法支持 Tableau
JavaScript API。
downloadWorkbookNotAllowed
对工作簿或视图拥有的权限
不允许下载工作簿。
filterCannotBePerformed
尝试执行筛选操作时出错。
- 369 -
CANNOT_BE_
PERFORMED
INDEX_OUT_ indexOutOfRange
OF_RANGE
INTERNAL_
internalError
ERROR
INVALID_
AGGREGATION_FIELD_
NAME
INVALID_
CUSTOM_
VIEW_NAME
INVALID_
DATE_
PARAMETER
INVALID_
FILTER_
FIELDNAME
INVALID_
FILTER_
FIELDNAME_
OR_VALUE
INVALID_
FILTER_
FIELDVALUE
INVALID_
PARAMETER
invalidAggregationFieldName
INVALID_
SELECTION_
DATE
invalidSelectionDate
INVALID_
SELECTION_
FIELDNAME
invalidSelectionFieldName
尝试通过索引切换到工作簿
中不存在的工作表。
Tableau JavaScript API 中出
错。请与 Tableau 支持人员联
系。
为筛选器指定了无效聚合，
例如将范围筛选器设置为
“SUM(Sales)”而非“Sales”。
invalidCustomViewName
尝试对不存在的自定义视图
执行操作。
invalidDateParameter
在需要日期参数的方法中指
定了无效日期。
invalidFilterFieldName
尝试对数据源中不存在的字
段执行筛选操作。
invalidFilterFieldNameOrValue
尝试对数据源中不存在的字
段执行筛选操作，或筛选操
作中提供的值是错误的数据
类型或格式。
尝试使用数据类型或格式错
误的值执行筛选操作。
invalidFilterFieldValue
invalidParameter
INVALID_
invalidSelectionValue
SELECTION_
VALUE
INVALID_SIZE invalidSize
- 370 -
参数不是正确的数据类型或
格式。在 Error.message 字
段中指定了参数的名称。
在日期字段的
Sheet.selectMarksAsync
() 调用中指定了无效的日期
值。
在
Sheet.selectMarksAsync
() 调用中指定了数据源中不
存在的字段。
在
Sheet.selectMarksAsync
() 调用中指定了无效值。
在
Sheet.changeSizeAsync
() 中指定了负大小或
maxSize 值小于 minSize 值。
INVALID_
SIZE_
BEHAVIOR_
ON_
WORKSHEET
invalidSizeBehaviorOnWorkshe
et
INVALID_URL
invalidUrl
MISSING_
MAX_SIZE
missingMaxSize
MISSING_
MIN_SIZE
missingMinSize
MISSING_
missingMinMaxSize
MINMAX_SIZE
MISSING_
RANGEN_
FOR_
RELATIVE_
DATE_
FILTERS
NO_URL_
FOR_
HIDDEN_
WORKSHEET
NO_URL_OR_
PARENT_
ELEMENT_
NOT_FOUND
NOT_
ACTIVE_
SHEET
NULL_OR_
EMPTY_
PARAMETER
SERVER_
missingRangeNForRelativeDat
eFilters
当工作表是 Worksheet 实例
时，在
Sheet.changeSizeAsync
() 中指定了
SheetSizeBehavior.AUTO
MATIC 以外的行为。
在 Viz 类构造函数中指定的
URL 无效。
在指定
SheetSizeBehavior.ATMO
ST 时，
Sheet.changeSizeAsync
() 中缺少 maxSize 字段。
在指定
SheetSizeBehavior.ATLE
AST 时，
Sheet.changeSizeAsync
() 中缺少 minSize 字段。
在指定
SheetSizeBehavior.RANG
E 时，
Sheet.changeSizeAsync
() 中缺少 minSize 和/或
maxSize 字段。
类型为 LASTN 或 NEXTN 的相
对日期筛选器缺少 rangeN
字段。
noUrlForHiddenWorksheet
尝试访问隐藏工作表上的
Sheet.getUrl()。隐藏工
作表没有 URL。
noUrlOrParentElementNotFoun
d
Viz 构造函数中没有指定
parentElement 和/或 URL
参数。
notActiveSheet
尝试对不活动的或未嵌入到
活动仪表板中的工作表执行
操作。
必需参数未指定、为 null 或
空字符串/数组。
nullOrEmptyParameter
出现通用服务器错误。
serverError
- 371 -
Error 对象中包含详细信
息。
尝试对工作簿中不存在的工
作表执行操作。
ERROR
SHEET_NOT_
IN_
WORKBOOK
STALE_
DATA_
REFERENCE
UNSUPPORT
ED_EVENT_
NAME
sheetNotInWorkbook
VIZ_
ALREADY_
IN_MANAGER
vizAlreadyInManager
staleDataReference
unsupportedEventName
对不再有效的 CustomView
对象 它已删除 执行操
作。
在 Viz.addEventListener
或
Viz.removeEventListene
r 的调用中指定了未知事件
名称。
Viz 对象已创建为 Viz 构造
函数中指定的
parentElement 的子级。
Viz 类
VizManager 类
管理页面上的所有 Viz 实例，但不管理 8.0 版之前的 Viz 视图 。这是一个静态
类，意味着所有属性和方法都是静态的，并且只存在该类的单个实例。
属性
名称
getVizs()
类型
Viz[]
说明
宿主页面上的视图的集合。
Viz 类
包装显示 Tableau 工作簿中的一个或多个工作表的 <iframe>。包含视图周围的所有
GUI。
构造函数
签名
Viz
(parentElement:
domNode, url:
string, options:
VizCreateOptions)
说明
在给定 HTML 容器中新建一个 Tableau Viz，该容器通常
是 <div> 元素。每个选项以及选项参数都是可选的。如
果已经有与 parentElement 关联的 Viz，则会引发异
常。在重用 parentElement 之前，必须首先调用
dispose()。
属性
名称
类型
- 372 -
说明
指示选项卡是否显示在 UI 中。
它不会实际隐藏各个选项卡。
getIsToolbarHidden()
bool
指示是否显示工具栏。
getIsHidden()
bool
指示 viz 是否显示在宿主页面
上。
getParentElement()
domNode 返回构造函数中指定的节点。
getUrl()
string
构造函数中指定的 viz 的 URL
getWorkbook()
Workbook 每个 viz 支持一个 Workbook。
getAreAutomaticUpdatesPaused bool
指示自动更新当前是否暂停。
()
getAreTabsHidden()
bool
事件
通过以下两个调用添加或删除事件。
名称
addEventListener(
type: TableauEventName,
listener: Function)
removeEventListener(
type: TableauEventName,
listener: Function)
返回类型
无
说明
向指定的事件添加事件侦听器。
无
从指定的事件删除事件侦听器。
方法
名称
show()
hide()
dispose()
类型
无
无
说明
显示或隐藏承载 viz 的
<iframe>。
清理与 viz 关联的所有资源，从
VizManager 中删除 viz，并从
parentElement 中删除所有
DOM 元素。大体上说，它会将页
面还原为在实例化新的 Viz 对象
之前的样子。
暂停或恢复布局更新。如果您调
整 viz 的大小或执行多个可能影响
布局的调用，这会很有用。
pauseAutomaticUpdatesAsync() 无
resumeAutomaticUpdatesAsync
()
toggleAutomaticUpdatesAsync
()
revertAllAsync()
Promise 与单击“全部恢复”工具栏按钮等
效，将工作簿还原为其初始状
态。
refreshDataAsync ()
无
与单击“刷新数据”工具栏按钮等
效。
showDownloadWorkbookDialog 无
与单击“下载”工具栏按钮等效，
()
下载原始工作簿的副本。
showExportImageDialog()
无
与单击“导出图像”工具栏按钮等
效，创建当前 viz 的 PNG 文件。
- 373 -
showExportPDFDialog()
无
showExportDataDialog( worksheetInDashboard: Sheet
or SheetInfo or string)
无
showExportCrossTabDialog( worksheetInDashboard: Sheet
or SheetInfo or string)
无
showShareDialog()
无
setFrameSize(width: int, height:
int)
无
与单击“导出 PDF”工具栏按钮等
效，显示允许用户选择导出选项
的对话框。
显示“导出数据”对话框，目前它
是一个弹出窗口。
worksheetInDashboard 参数是
可选的。如果未指定，则使用当
前活动的 Worksheet。
显示“导出交叉表”对话框。
worksheetInDashboard 参数是
可选的。如果未指定，则使用当
前活动的 Worksheet。
与单击“共享”工具栏按钮等效，
显示允许用户通过电子邮件或通
过将 viz 的 HTML 嵌入在网页中来
共享 viz 的对话框。
设置 iFrame 的大小，如果 viz 的
当前工作表的大小设置为
AUTOMATIC，则这会导致 viz 展
开或折叠来适合 iFrame。
VizCreateOptions 记录
这些是在 Viz 构造函数中指定的选项。
字段
名称
hideTabs
hideToolbar
toolbarPosition
类型
bool
bool
ToolbarPosition
height
string
width
string
onFirstInteractive callback(e:
TableauEvent)
说明
指示是隐藏还是显示选项卡。
指示是隐藏还是显示工具栏。
指示如果 hideToolbar 为 false，应将工
具栏置于何处。
可以是任何有效的 CSS 大小说明符。如
果未指定，默认为 600px。
可以是任何有效的 CSS 大小说明符。如
果未指定，默认为 800px。
在 viz 首次成为交互式视图时回调。这只
调用一次，但保证会调用它。如果 viz 已
经是交互式视图，则将立即调用它，但
在单独的“线程”上调用。
ToolbarPosition Enum
枚举
名称
TOP
BOTTOM
说明
沿 viz 的顶部放置工具栏。
将工具栏置于 viz 的底部。
- 374 -
Viz Event 类
TableauEventName 枚举
这些是传递给 Viz.addEventListener/removeEventListener 的字符串。请注意，枚举值全
部是没有下划线的小写字符串。例如，CUSTOM_VIEW_LOAD 为 customviewload。
可接受完全限定枚举 (tableauSoftware.TableauEventName.FILTER_CHANGE) 或
原始字符串 (filterchange)。
名称
CUSTOM_VIEW_
LOAD
CUSTOM_VIEW_
REMOVE
CUSTOM_VIEW_
SAVE
CUSTOM_VIEW_
SET_DEFAULT
FILTER_CHANGE
MARKS_
SELECTION
PARAMETER_
VALUE_CHANGE
STORY_POINT_
SWITCH
TAB_SWITCH
回调中传递的 Event
类
CustomViewEvent
说明
CustomViewEvent
在用户删除自定义视图时引发。
CustomViewEvent
MarksEvent
在用户保存新的或现有的自定义
视图时引发。
在使自定义视图成为此 viz 的默
认视图时引发。
在任何筛选器更改状态时引发。
viz 可能还不是交互式视图。
在选择或取消选择标记时引发。
ParameterEvent
在任何参数更改状态时引发。
CustomViewEvent
FilterEvent
在自定义视图加载完毕时引发。
StoryPointSwitchEvent 在故事点变成活动状态之后引
发。
TabSwitchEvent
在切换选项卡后引发，但 viz 可
能还不是交互式视图。
TableauEvent 类
属性
名称
类型
getViz()
Viz
getEventName TableauEventName
()
说明
获取与事件关联的 Viz 对象。
获取事件的名称，它是一个字符串，但
也是 TableauEventName 枚举中的其中一
项。
CustomViewEvent 类
属性
名称
getViz()
类型
Viz
说明
获取与事件关联的 Viz 对象。
- 375 -
getEventName TableauEventName 获取事件的名称，它是一个字符串，但
()
也是 TableauEventName 枚举中的其中一
项。
方法
名称
返回类型
说明
getCustomViewAsync Promise<CustomView> 获取与事件关联的
()
CustomView 对象。
FilterEvent 类
属性
名称
getViz()
getWorksheet
()
getEventName
()
getFieldName
()
类型
Viz
Worksheet
说明
获取与事件关联的 Viz 对象。
获取与事件关联的 Worksheet 对象。
TableauEventName 获取事件的名称，它是一个字符串，但
也是 TableauEventName 枚举中的其中一
项。
string
获取字段的名称。
方法
名称
getFilterAsync()
返回类型
Promise<Filter>
说明
获取与事件关联的 Filter 对象。
MarksEvent 类
属性
名称
getViz()
getWorksheet
()
getEventName
()
类型
Viz
Worksheet
说明
获取与事件关联的 Viz 对象。
获取与事件关联的 Worksheet 对象。
TableauEventName 获取事件的名称，它是一个字符串，但
也是 TableauEventName 枚举中的其中
一项。
方法
名称
getMarksAsync
()
返回类型
Promise<Mark[]
>
说明
获取 Worksheet 上触发事件的选定标
记。
ParameterEvent 类
属性
名称
类型
说明
- 376 -
Viz
获取与事件关联的 Viz 对象。
TableauEventName 获取事件的名称，它是一个字符
串，但也是 TableauEventName 枚
举中的其中一项。
getParameterName string
获取更改的参数的名称。
()
getViz()
getEventName()
方法
名称
getParameterAsync
()
返回类型
说明
Promise<Parameter> 获取触发事件的 Parameter 对
象。
StoryPointSwitchEvent 类
在 STORY_POINT_SWITCH 事件的回调中返回。
属性
名称
getViz()
getEventName()
类型
说明
Viz
获取与事件关联的 Viz 对象。
TableauEventName 获取事件的名称，它是一个字符
串，但也是 TableauEventName 枚
举中的其中一项。在此例中为
STORY_POINT_SWITCH。
getOldStoryPointInfo StoryPointInfo
获取在故事点切换事件发生之前
()
处于活动状态的
StoryPointInfo。返回的对象
反映故事点在发生切换之前的状
态。例如，getIsActive() 将仍为
true。
getNewStoryPoint()
StoryPoint
获取当前活动的 StoryPoint。
TabSwitchEvent 类
属性
名称
getViz()
getEventName()
类型
说明
Viz
获取与事件关联的 Viz 对象。
TableauEventName 获取事件的名称，它是一个字符
串，但也是 TableauEventName 枚
举中的其中一项。
getOldSheetName string
获取在选项卡切换事件发生之前处
()
于活动状态的工作表的名称。
getNewSheetName string
获取当前活动的工作表的名称。
()
- 377 -
Workbook 类
类表
Workbook 类
工作簿是以标签形式表示的工作表的集合。它还具有关联的对象，例如
DataSources 和 CustomViews。
属性
名称
getViz()
getActiveSheet()
类型
Viz
Sheet
说明
获取包含工作簿的 Viz 对象。
获取当前活动的工作表 活动的标
签
getActiveCustomView() CustomView 获取当前活动的自定义视图，如果没
有自定义视图处于活动状态，则为
null。
getPublishedSheetsInfo SheetInfo[]
请注意，这是同步的，意味着加载时
()
需要所有工作表。
getName()
string
获取保存到服务器的工作簿的名称。
请注意，这不一定是文件名。
方法
名称
activateSheetAsync
(sheetNameOrIndex: object)
返回类型
Promise<Sheet>
revertAllAsync()
Promise
getParametersAsync()
Promise<Paramete
- 378 -
说明
通过名称或索引激活
工作表，然后返回激
活的工作表的承诺。
将工作簿恢复到上次
保存的状态。
获取此工作簿的参
changeParameterValueAsync(
name: string,
value: object)
getCustomViewsAsync()
showCustomViewAsync(
customViewName: string)
removeCustomViewAsync(
customViewName: string)
rememberCustomViewAsync(
customViewName: string)
setActiveCustomViewAsDefault
Async()
数。
更改具有给定名称的
参数的值并返回新的
Parameter。值应与
参数具有相同的数据
类型，并且在允许的
值范围内。它还需要
是别名值，而不是原
始值。有关更多信息
和示例，请参见
changeParameterValue
Async() 其他信息
Promise<CustomVi 获取与工作簿关联的
ew[]>
CustomView 对象的集
合。
Promise<CustomVi 更改 viz 来显示命名的
ew>
已保存状态。
Promise<CustomVi 删除命名的自定义视
ew>
图。
Promise<CustomVi- 通过分配自定义视图
ew>
名称来记住工作簿的
当前状态。
无
将当前自定义视图设
置为默认视图。
r[]>
Promise<Paramete
r>
changeParameterValueAsync() 其 他 信 息
值参数需要满足以下条件：
1. 数据类型应是 Parameter.getCurrentValue() 中返回的相同基础 JavaScript
类型。例如，如果 Parameter.getDataType() 为 FLOAT 或 INTEGER，则值
参数应为原生 JavaScript 数字。下表将 ParameterDataType 值映射到本机
JavaScript 类型。
ParameterDataType
FLOAT
INTEGER
STRING
BOOLEAN
DATE
DATETIME
本机 JavaScript 类型
Number
Number
String
Boolean
Date
Date
2. 如果参数局限于允许值的列表，则值应为这些值之一。查询
Parameter.getAllowableValuesType() 将指示是否通过返回
tableauSoftware.ParameterAllowableValuesType.LIST 来限制参数
值。
3. 如果参数局限于值范围，则值应在最小值和最大值之间 包括最小值和最大
值 。查询 Parameter.getAllowableValuesType() 将指示是否通过返回
- 379 -
tableauSoftware.ParameterAllowableValuesType.RANGE 来限制参数
值。通过 Parameter.getMinValue() 和 Parameter.getMaxValue() 返回
最小值和最大值。
4. 值需要是别名值，而不是原始值。要查看原始值和别名值，请转到 Tableau
Desktop 中的“编辑参数”对话框。在该对话框中，使用“显示为”列而非“值”列中
的值，如下所示。
示例
以下示例将帮助说明这些概念。
// Change a parameter called "Prouct Type" to "Coffee" when the
parameter is
// restricted to the following allowable values:
// "Coffee", "Espresso", "Tea"
workbook.changeParameterValueAsync("Product Type", "Coffee");
// Change a parameter called "Measure" to a value that is
aliased, "Sale". This
// example corresponds to the screen shot above.
workbook.changeParameterValueAsync("Measure", "Sale");
// Change a date parameter named "DateParam" to January 1, 2014
- 380 -
(UTC):
workbook.changeParameterValueAsync("DateParam", new Date
(Date.UTC(2014, 0, 1)));
DataSource 类
Workbook 包含一个或多个数据源。每个 Worksheet 将具有一个主数据源，并且可
以具有多个辅助数据源。
属性
名称
getName()
getIsPrimary()
getFields()
类型
string
bool
Field[]
说明
UI 中显示的 DataSource 的名称。
指示此 DataSource 是主数据源还是辅助数据源。
获取与 DataSource 关联的 Fields 的数组。
Field 类
字段包含有关它属于什么数据源、它的角色以及获取域值的能力的信息。
属性
名称
类型
getName()
string
getAggregation FieldAggregationType
()
getDataSource
()
getRole()
DataSource
说明
获取字段名称 即标题 。
获取聚合的类型，它是以下值之
一：SUM、AVG、MIN、MAX、
STDEV、STDEVP、VAR、VARP、
COUNT、COUNTD、MEDIAN、ATTR、
NONE、YEAR、QTR、MONTH、DAY、
HOUR、MINUTE、SECOND、WEEK、
WEEKDAY、MONTHYEAR、MDY、
END、TRUNC_YEAR、TRUNC_QTR、
TRUNC_MONTH、TRUNC_WEEK、
TRUNC_DAY、TRUNC_HOUR、TRUNC_
MINUTE、TRUNC_SECOND、
QUART1、QUART3、SKEWNESS、
KURTOSIS、INOUT、USER
获取此字段所属的数据源。
以下值之一：DIMENSION、
MEASURE、UKNOWN
FieldRoleType
CustomView 类
表示工作簿在特定时刻的命名快照。
属性
名称
getName()
类型
string
说明
自定义视图的用户友好名称
- 381 -
setName()
getAdvertised()
setAdvertised()
getDefault()
getOwnerName()
getUrl()
getWorkbook()
bool
指示自定义视图是公共的还是私有的。
bool
string
string
Workbook
获取或设置这是否是默认自定义视图。
获取创建自定义视图的用户。
用于再次加载此视图的唯一 URL。
获取此 CustomView 所属的 Workbook。
方法
名称
返回类型
说明
saveAsync Promise<CustomView> 在调用 saveAsync() 之后，getUrl 方
()
法的结果不再空白。
Sheet 类
类表
SheetInfo 类
包含有关 WORKSHEET、DASHBOARD 或 STORY 的信息，并且不包含任何方法。作为
Workbook.getPublishedSheetsInfo() 的一部分返回。
构造函数
没有公共构造函数。您只能从 Workbook.getPublishedSheetsInfo() 获取此类
的实例。
属性
名称
getName()
getIndex()
类型
string
int
getIsActive()
bool
说明
获取工作表的名称。
获取已发布标签中的工作表的索引。请注意，隐
藏的标签仍包括在排序中，只要它们处于已发布
状态。
获取一个指示工作表是否是当前活动工作表的
值。由于技术限制，如果对象是属于 Dashboard
- 382 -
的一部分的 Worksheet 实例，则这始终返回
false。
getIsHidden() bool
获取一个指示工作表是否在 UI 中隐藏的值。请注
意，如果整个标签控件已隐藏，它不会影响此标
志的状态。即使在标签控件已隐藏时，此工作表
可能仍报告它处于可见状态。
getSheetType SheetType 获取工作表的类型。SheetType 是具有以下值的
()
枚举：WORKSHEET、DASHBOARD 和 STORY。
getSize()
SheetSize 获取作者在发布工作簿时指定的大小信息。
getUrl()
string
获取此工作表的 URL。
getWorkbook Workbook 获取此 Sheet 所属的 Workbook。
()
Sheet 类
构造函数
没有公共构造函数。您只能从 Workbook.getActiveSheet() 或
Dashboard.getObjects() 获取此类的实例。
属性
名称
getName()
getIndex()
类型
string
int
说明
获取工作表的名称。
获取已发布标签中的工作表的索引。请注意，隐
藏的标签仍包括在排序中，只要它们处于已发布
状态。
getIsActive()
bool
获取一个指示工作表是否是当前活动工作表的
值。
getIsHidden() bool
获取一个指示工作表是否在 UI 中隐藏的值。请注
意，如果整个标签控件已隐藏，它不会影响此标
志的状态。即使在标签控件已隐藏时，此工作表
可能仍报告它处于可见状态。
getSheetType SheetType 获取工作表的类型。SheetType 是具有以下值的
()
枚举：WORKSHEET、DASHBOARD 和 STORY。
getSize()
SheetSize 获取作者在发布工作簿时指定的大小信息。
getUrl()
string
获取此工作表的 URL。
getWorkbook Workbook 获取此 Sheet 所属的 Workbook。
()
方法
名称
返回类型
说明
changeSizeAsync Promise<SheetSize> 设置工作表的大小信息。请注意，
(size: SheetSize)
如果工作表是 Worksheet，则只允
许
SheetSizeBehavior.AUTOMATIC
，因为您无法将 Worksheet 实际设
置为固定大小。
- 383 -
SheetSize 记录
描述调整工作表大小应采取的方式。
字段
名称
类型
说明
behavior SheetSizeBehavior 包含以下枚举值之一：AUTOMATIC、
EXACTLY、RANGE、ATLEAST 和 ATMOST。
maxSize int
仅当行为是 EXACTLY、RANGE 或 ATMOST 时，
才定义该值。
仅当行为是 EXACTLY、RANGE 或 ATLEAST 时，
minSize int
才定义该值。
Worksheet 类
表示工作簿中的工作表标签或仪表板对象。这是两个不同的概念：工作表和工作表
实例。不过，在 API 中，为简单起见，它们都合并到 Worksheet 类中。
构造函数
没有公共构造函数。您只能从 Workbook.getPublishedSheets() 或
Dashboard.getObjects() 获取此类的实例。
属性
名称
类型
说明
getParentDashboard Dashboard 返回此 Worksheet 如果它在仪表板上
()
所属的 Dashboard 对象。否则，它返回
空值。
getParentStoryPoint StoryPoint 返回此 Worksheet 如果它在故事工作表
()
上 所属的 StoryPoint 对象。否则，它
返回空值。
方法
名称
返回类型
说明
getDataSourcesAsync Promise<DataSource 获取此工作表的主数据源和所
()
[]>
有辅助数据源。请注意，按照
约定，主数据源应始终是第一
个元素。
API 参考 在本页 368中介绍了筛选方法。Worksheet 类
择方法。
选择标记
中介绍了标记选
Dashboard 类
包含 DashboardObject 实例的集合和活动对象的表示法。
构造函数
没有构造函数。您从 Workbook.getPublishedSheets() 获取此类的实例。
- 384 -
属性
名称
getObjects()
类型
DashboardO
bject[]
Worksheet[]
getWorksheets
()
getParentStory- StoryPoint
Point()
说明
获取对象的集合。
获取仪表板中包含的工作表的集合。请注
意，这是 helper 方法，并且与循环访问
getObjects() 并在
DashboardObject.getType() ===
tableauSoftware.DashboardObjectType
.WORKSHEET 时收集所有
DashboardObject.Worksheet 指针等效。
返回此 Dashboard 如果它在故事工作表
上 所属的 StoryPoint 对象。否则，它返
回空值。
DashboardObject 类
表示仪表板的一系列不同区域之一。
构造函数
没有构造函数。您从 Dashboard.getObjects() 获取此类的实例。
属性
名称
类型
说明
getObjectType DashboardObjectType 获取对象所表示的内容，它是具有以
()
下值的 enum：BLANK、WORKSHEET、
QUICK_FILTER、PARAMETER_
CONTROL、PAGE_FILTER、LEGEND、
TITLE、TEXT、IMAGE、WEB_PAGE。
getDashboard Dashboard
获取包含此对象的 Dashboard 对象。
()
getWorksheet Worksheet
如果 getType() 返回 WORKSHEET，
()
则它包含指向 Worksheet 对象的指
针。
getPosition()
Point
获取相对于对象仪表板左上角的坐
标。
getSize()
Size
获取对象的大小。
Story 类
包含 StoryPoint 实例的集合和在它们之间切换的能力。派生自 Sheet 类。
构造函数
没有构造函数。您从 Workbook.getActiveSheet() 获取此类的实例。
属性
名称
派 生 自 Sheet
类型
说明
- 385 -
获取工作表的名称。
获取已发布标签中的工作表的索引。请注意，隐
藏的标签仍包括在排序中，只要它们处于已发布
状态。
getIsActive()
bool
获取一个值，该值指示工作表当前是否是活动工
作表。
getIsHidden() bool
获取一个指示工作表是否在 UI 中隐藏的值。请注
意，如果整个标签控件已隐藏，它不会影响此标
志的状态。即使在标签控件已隐藏时，此工作表
可能仍报告它处于可见状态。
getSheetType SheetType 获取工作表的类型，它应始终为
()
tableauSoftware.SheetType.STORY。
getSize()
SheetSize 获取作者在发布工作簿时指定的大小信息。
getUrl()
string
获取此工作表的 URL。
getWorkbook Workbook 获取此 Sheet 所属的 Workbook。
()
getName()
getIndex()
string
int
属性
名称
getStoryPointsInfo
()
类型
说明
StoryPointInfo 获取 StoryPointInfo 对象的数组 非
[]
集合 。请注意，这不是集合，因为我
们没有故事点的唯一字符串键。我们只
需按顺序访问故事点 通过索引 。
getActiveStoryPoint StoryPoint
获取当前活动的故事点。
()
方法
派 生 自 Sheet
名称
changeSizeAsync(size:
SheetSize)
类型
说明
Promise<SheetSize> 设置工作表的大小信
息。
方法
名称
activateStoryPointAsync
(index: int)
类型
Promise<Story
Point>
activateNextStoryPointAs- Promise<Storyync()
Point>
activatePreviousStoryPoi- Promise<StoryntAsync()
Point>
- 386 -
说明
激活指定索引处的故事点并返
回激活的 StoryPoint 的承诺。如
果索引小于零或者大于等于数
组中的故事点数，则引发
tableauSoftware.ErrorCod
e.INDEX_OUT_OF_RANGE 错
误。
如果有下一个故事点，则激活
它。如果当前故事点是最后一
个，则它保持活动状态。
如果有上一个故事点，则激活
它。如果当前故事点是第一
个，则它保持活动状态。
revertStoryPointAsync
(index: int)
Promise<StoryPoint>
恢复位于指定索引处的故事点
并返回恢复的 StoryPoint 的承
诺。如果索引小于零或者大于
等于数组中的故事点数，则引
发
tableauSoftware.ErrorCode.INDEX_OUT_OF_RANGE 错
误。
StoryPointInfoClass
包含有关 StoryPoint 的信息，并且不包含任何方法。作为
Story.getStoryPointsInfo() 的一部分返回。
属性
名称
getIndex()
getCaption()
getIsActive()
类型
int
string
Bool
说明
获取此故事点在父故事工作表中从零开始的索引。
获取此故事点的文本说明的内容。
获取一个值，该值指示故事点当前是否是故事中的活
动点。
getIsUpdated() Bool 获取一个指示故事点是否已更新的值，这意味着自从
上次“捕获”故事点以来没有任何更改。
getParentStory Story 获取包含故事点的 Story 对象。
()
StoryPoint 类
StoryPoint 是 Story 工作表中的独特快照。
属性
名称
getIndex()
类型
int
说明
获取此故事点在父故事工作表中从零开始的索
引。
getCaption()
string 获取此故事点的文本说明的内容。
getIsActive()
Bool
获取一个值，该值指示故事点当前是否是故事中
的活动点。
getIsUpdated()
Bool
获取一个指示故事点是否已更新的值，这意味着
自从上次“捕获”故事点以来没有任何更改。
getContainedSheet Sheet 获取此故事点包含的工作表。如果故事点不包含
()
工作表，则这将为空。
getParentStory()
Story 获取包含此故事点的 Story 对象。
- 387 -
Parameter 类
Parameter 类
包含有关工作簿参数的信息。若要实际设置参数的值，请调用
workbook.changeParameterValueAsync()。
属性
名称
getName()
类型
string
getCurrentValue()
getDataType()
DataValue
ParameterDataType
getAllowableValuesT
ype()
ParameterAllowableValues
Type
getAllowableValues()
DataValue[]
getMinValue()
DataValue
getMaxValue()
DataValue
getStepSize()
Number
getDateStepPeriod()
PeriodType
- 388 -
说明
用户指定的参数的唯一标
识符。
参数的当前值。
参数的数据类型可以是以
下项之一：FLOAT、
INTEGER、STRING、
BOOLEAN、DATE、
DATETIME。
参数可以接受的允许值的
类型。它可以是以下枚举
项之一：ALL、LIST、
RANGE。
如果参数局限于允许值的
列表，则此属性包含这些
值的数组。请注意，这不
是标准集合，而是一个
JavaScript 数组。
如果
getAllowableValuesT
ype 为 RANGE，则这定义
允许的最小值 含 。否
则，它未定义/为 null。
如果
getAllowableValuesT
ype 为 RANGE，则这定义
允许的最大值 含 。否
则，它未定义/为 null。
如果
getAllowableValuesT
ype 为 RANGE，则这定义
参数 UI 控制滑块中使用
的步进大小。否则，它未
定义/为 null。
如果
getAllowableValuesT
ype 为 RANGE，并且
getDataType 为 DATE 或
DATETIME，则这定义参
数 UI 控制滑块中使用的
步进日期时段。否则，它
未定义/为 null。
筛选
查询现有筛选器状态与设置新或现有筛选器有所不同。查询筛选器可通过
Worksheet.getFiltersAsync() 完成，它会返回 Filter 类的集合。设置筛选器
可通过 Worksheet.applyFilterAsync 及其变体 完成，并且它是一个不要求您
实例化 Filter 类的函数调用。
在筛选器中指定字段时，应使用 UI 中显示的标题，而不是数据库字段名称。例如，
使用 Container 标题 而不是 Product Container 实际字段名称 。例外情况是分
层筛选器，它使用完整分层名称 例如，[Product].[All Product].
[Espresso] 。标题可以在名称两侧使用可选的 [] 分隔符。
类表
Worksheet 类
筛选
这些方法属于 Worksheet 类，但为了方便起见列在了此处。
方法
名称
getFiltersAsync()
applyFilterAsync(
返回类型
Promise<Filter[]
>
Promise<strin
- 389 -
说明
获取工作表上使用的筛选器
的集合。
应用简单的分类筛选器 非
fieldName: string,
values: object[] or object,
updateType:
FilterUpdateType,
options?: FilterOptions)
applyRangeFilterAsync(
fieldName: string,
range: RangeFilterOptions)
g>
日期 。有关这些函数的更
多详细信息，请参见筛选示
例。返回筛选的
fieldName。
Promise<strin
g>
applyRelativeDateFilterAsync(
fieldName: string,
options:
RelativeDateFilterOptions)
applyHierarchicalFilterAsync
(
fieldName: string,
values: object,
options:
HierarchicalFilterOptions)
clearFilterAsync(fieldName:
string)
Promise<string>
应用定量筛选器。如果指定
的范围在域最小/最大值之
外，不会引发任何错误，并
且允许此命令。对
getFiltersAsync[] 的后
续调用将返回这些值，即使
它们在域的边界之外也是如
此。这与 Tableau Desktop 中
的行为等效。
应用相对日期筛选器。
Promise<string>
应用分层筛选器。值参数是
单个值、值的数组或对象 { levels: ["1", "2"] }。
Promise<string>
清除筛选器，无论它是哪种
筛选器。请注意，只要没有
为字段显示任何关联的快速
筛选器，就将删除筛选器。
如果显示了快速筛选器，则
保留筛选器，但会将它重置
为“全部”状态 相当于取消筛
选器 。不过对于相对日期
筛选器，将返回错误，因为
相对日期筛选器没有“全部”状
态。若要清除显示了快速筛
选器的相对日期筛选器，您
可以改为使用对特定字段有
意义的范围调用
applyRelativeDateFilter()。
FilterOptions 记录
传递给 applyFilter 方法以控制高级筛选选项。
- 390 -
字段
名称
isExcludeMode
类型
bool
说明
确定将以排除模式还是包
含模式应用筛选器。默认
使用包含模式，这意味着
将使用字段作为筛选器的
一部分。排除模式意味着
将包含除指定字段外的所
有其他内容。
RangeFilterOptions 记录
传递给 applyRangeFilterAsync 方法以控制高级筛选选项。
字段
名称
min
类型
int
max
int
nullOption
NullOption
说明
范围的最小值 含 。可
选。如果您需要 <= 筛选
器，请保留为空。
范围的最大值 含 。可
选。如果您需要 >= 筛选
器，请保留为空。
要包括的 null 值。
RelativeDateFilterOptions 记录
传递给 applyRelativeDateFilterAsync 方法以控制高级筛选选项。
字段
名称
anchorDate
periodType
rangeType
rangeN
类型
Date
PeriodType
DateRangeType
int
说明
从中进行筛选的 UTC 日期。
年、季度、月等
LAST、LASTN、NEXT 等
rangeType 为 LASTN 或 NEXTN 时使用的数
字。
Filter 类
所有不同筛选器类型的抽象基类。
属性
名称
getWorksheet
()
getFilterType
()
getFieldName
类型
说明
Worksheet 获取父工作表
FilterType
string
获取筛选器的类型。有关枚举中的值，请参见
FilterType 枚举。
获取所筛选的字段的名称。请注意，这是 UI 中显
- 391 -
示的标题，而不是实际的数据库字段名称。
()
方法
名称
getFieldAsync()
返回类型
Promise<Field>
说明
获取当前筛选的字段。
NullOption 枚举
指示如何处理给定筛选器或标记选择调用的 null 值的枚举。
枚举
名称
NULL_VALUES
NON_NULL_VALUES
ALL_VALUES
说明
仅在筛选器中包括 null 值。
仅在筛选器中包括非 null 值。
在筛选器中包括 null 和非 null 值。
CategoricalFilter 类
属性
名称
getIsExcludeMode
()
getAppliedValues
()
类型
bool
说明
获取一个指示筛选器是排除还是包含 默认
值 的值。
DataValue 获取筛选器上当前设置的值的集合。请注
[]
意，这是本机 JavaScript 数组，不是键控集
合。
QuantitativeFilter 类
属性
名称
getDomainMin()
getDomainMax()
getMin()
getMax()
getIncludeNullValues()
类型
DataValue
DataValue
DataValue
DataValue
bool
说明
获取域中指定的最小值。
获取域中指定的最大值。
获取应用于筛选器的最小值 含
获取应用于筛选器的最大值 含
指示筛选器中是否包括 null 值。
。
。
RelativeDateFilter 类
属性
名称
类型
getPeriod() PeriodType
说明
筛选器的日期时间段。有关枚举中的值，请参
见 PeriodType 枚举。
getRange() DateRangeType 日期筛选器的范围 年、月等 。有关枚举中
的值，请参见 DateRangeType 枚举。
getRangeN int
当 getRange 返回 LASTN 或 NEXTN 时，这是 N
()
值 年数、月数等 。
- 392 -
DataValue 记录
DataValue 同时包含筛选器或参数的原始值和格式化值。日期值始终以 UTC 日期表
示。
字段
名称
value
类型 说明
object 包含原始本机值作为 JavaScript 类型，它是 String、
Number、Boolean 或 Date 之一
formattedValue string 根据应用于字段或参数的区域设置和格式设置格式
的值。
FilterType 枚举
可应用的有效筛选器类型的枚举。
枚举
名称
CATEGORICAL
QUANTITATIVE
HIERARCHICAL
RELATIVE_
DATE
说明
分类筛选器用于筛选到域中的一组值。
定量筛选器用于筛选到连续域中的值范围。
分层筛选器用于筛选到组织为域中的分层结构的一组值。
相对日期筛选器用于将日期/时间域筛选到相对于固定时间
点的一组值。
FilterUpdateType 枚举
可执行的有效筛选类型的枚举。
枚举
名称
ALL
说明
将所有值添加到筛选器中。等效于在快速筛选器中选中“(全部)”
值。
REPLACE 使用调用中指定的新值替换当前筛选器值。
ADD
将调用中指定的筛选器值添加到当前筛选器值中。等效于在快速
筛选器中选中值。
REMOVE
从当前筛选器值中删除调用中指定的筛选器值。等效于在快速筛
选器中取消选中值。
PeriodType 枚举
筛选器和参数中使用的日期时间段的枚举。
枚举
名称
YEARS
QUARTER
S
MONTHS
- 393 -
WEEKS
DAYS
HOURS
MINUTES
SECONDS
DateRangeType 枚举
相对日期筛选器的有效日期范围的枚举。
枚举
名称
LAST
LASTN
NEXT
NEXTN
CURRENT
TODATE
说明
指日期时间段的最后一天、一周、一个月等。
指日期时间段的最后 N 天、N 周、N 个月等。
指日期时间段的随后一天、随后一周、随后一个月等。
指日期时间段的随后 N 天、随后 N 周、随后 N 个月等。
指日期时间段的当天、当周、当月等。
指日期时间段截至并包括当天、当周、当月等的所有日期。
标记选择
选择标记与筛选基本相同。对于筛选，应使用 Worksheet.applyFilterAsync()
方法之一。对于选择标记，应使用 Worksheet.selectMarksAsync()。标记选择
的参数与用于筛选的参数几乎相同。这提供了非常简单易学且一致的方法来完成 API
的两个最常见用例：筛选和选择。
Worksheet 类
选择标记
这些方法属于 Worksheet 类，但为了方便起见显示在此处。
方法
名称
返回类型
clearSelectedMarksAsync() void
getSelectedMarksAsync()
selectMarksAsync(
fieldName: string,
value: object or object[],
updateType:
SelectionUpdateType)
selectMarksAsync(
fieldValuesMap: object,
updateType:
SelectionUpdateType)
说明
清除此工作表的选择。
Promise<Mark 获取当前选择的标记的集合。
[]>
void
选择标记并返回它们。
允许基于第一个参数的以下语法
进行选择：
{
"Field1": value,
"Field2"：[1, 2, 3]
}
void
- 394 -
selectMarksAsync(
marks: Mark[],
updateType:
SelectionUpdateType)
void
Mark 类
标记表示 viz 上的单个数据点。它与 viz 类型无关
条形图、折线图、饼图等
。
构造函数
签名
Mark(pairs: Pair[])
说明
使用指定的对创建新的 Mark。
属性
名称
getPairs()
类型
Pair[]
说明
获取与标记关联的字段名称/值对的集合。
Pair 类
对包含字段名称和值
原始值和格式化值
。
构造函数
签名
Pair(fieldName: string, value:
object)
说明
使用指定的字段名称/值对创建新的
Pair
字段
名称
fieldName
value
类型 说明
string 值应用于的字段名称。
object 包含字段的原始本机值作为 JavaScript 类型，它是
String、Number、Boolean 或 Date 之一。
formattedValue string 根据应用于字段的区域设置和格式设置格式的值。
SelectionUpdateType 枚举
可执行的有效标记选择类型的枚举。
枚举
名称
说明
REPLACE 使用调用中指定的新值替换当前标记值。
ADD
将调用中指定的值添加到当前选择中。等效于在桌面上按住
Control 并单击。
REMOVE
从当前选择中删除调用中指定的值。等效于在桌面上按住 Control
并单击已选择的标记。
- 395 -
其他类
Size 记录
表示宽度和高度，以像素为单位。这作为普通 JavaScript 对象实现
它不是类
字段
名称
width
height
类型
int
int
说明
以像素为单位。
以像素为单位。
Point 记录
表示 x/y 坐标，以像素为单位。这作为普通 JavaScript 对象实现
字段
名称
x
y
类型
int
int
说明
以像素为单位。
以像素为单位。
- 396 -
它不是类
。
。
REST API
With the Tableau Server REST API you can manage and change Tableau Server resources
programmatically, via HTTP. The API gives you simple access to the functionality behind the
data sources, projects, workbooks, site users, and sites on a Tableau server. You can use this
access to create your own custom applications or to script interactions with Tableau Server
resources. See the topics below for more information:
Requirements
Here are the requirements for using the Tableau Server REST API:
Tableau Server: To program with the REST API you need Tableau Server version 8.2 or
higher.
API enabled: By default, Tableau Server installs with the REST API disabled. Before you can
use the API, enable it using the procedure below.
Enabling the REST API
After you install Tableau Server, enable the REST API by doing the following:
1. On the computer running Tableau Server, open a command prompt as an administrator
and navigate to Tableau Server’s bin directory. For example:
Program Files\Tableau\Tableau Server\8.2\bin
2. Stop Tableau Server.
tabadmin stop
3. Enter the following command to enable the API:
tabadmin set api.server.enabled true
4. Propagate the change:
tabadmin configure
5. Start Tableau Server.
tabadmin start
The application code you create can be located on any computer, as long as it can make
HTTP requests against the computer that’s running Tableau Server.
Concepts
This topic is designed for people who are familiar with REST APIs and with using Tableau
Server.
- 397 -
Components of a Call
A Tableau Server REST API call consists of the following:
l
HTTP method: There are four methods: GET, POST, PUT, or DELETE.
l
Tableau Server URI: The URI is the server resource being acted upon.
l
Parameter: The URI may contain one or more parameters.
l
Message payload: POST and PUT calls usually require an XML message payload,
which contains inputs or additions to the server. GET and DELETE calls do not require a
message payload.
Using the Query Datasources call as an example (GET /api/2.0/sites/siteid/datasources), here are the components:
l
HTTP method: GET
l
Tableau Server URI: /api/2.0/sites/site-id/datasources
l
Parameter: site-id. It uniquely identifies the site to Tableau Server.
l
Message payload: None. Because you are not providing an input or adding to Tableau
Server resources, there is no message payload for this call.
In response to the above call, Tableau Server returns two things: a status code and a response
payload.
The status code, such as 200 (success), is a standard HTTP return value. For each call in the
REST API Reference, all possible error codes are listed. The response payload returns what
you requested as an XML message. For the above call, the response payload would be a list of
data sources for the site. The reference lists every call’s response payload. See XML Schema
for more details.
Signing In
The Tableau Server REST API requires an authentication token to be sent with each API call.
The token should be sent with all requests as the header X-Tableau-Auth. For example:
Content-Type: text/xml
X-Tableau-Auth: d14a028c2a3a2bc9476102bb288234c4
You can retrieve a token by completing a Sign In call and parsing the token out of the response
payload. The token should be stored in your application logic and reused until the session ends.
Sample code is provided in the file example.py. It demonstrates how to make a Sign In call and
parse the returned token.
A Sign Out call ends the session and invalidates the token.
XML Schema
Some API calls return a response payload for the requested resource, in XML. The response
payload can be parsed and used within the application logic of your code.
- 398 -
An XML schema for the entire API is in the file ts-rest-api.xsd. API calls that require an XML
response payload require that XML to be well-formed and to conform to the schema in ts-restapi.xsd.
LUIDs
LUIDs (Locally Unique Identifiers) are used throughout the REST API to identify resources on
Tableau Server. LUIDs are 32-character strings separated by dashes in the format
'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'. The IDs are returned by certain query
methods, and can be chained with additional calls to act on the resource. For example, user-id
can be retrieved by issuing a Get Users on Site call and parsing out the desired user and userid. User-id is not the user name, and site-id is not the id used in the Tableau Server user
interface.
Sample and Schema
To help you use the REST API, Tableau provides two files.
Sample code file: The code in the file example.py demonstrates how to use the REST API to
make a Sign In call and parse the returned token.
XML schema file: The XML schema for the entire REST API is in the file ts-rest-api.xsd.
API Reference
With the Tableau Server REST API you can manage and change Tableau Server resources
programmatically, via HTTP. The API gives you simple access to the functionality behind the
data sources, projects, workbooks, site users, and sites on a Tableau server. You can use this
access to create your own custom applications or to script interactions with Tableau Server
resources.
Before you can use the Tableau Server REST API, you must enable it. See Enabling the API
for steps.
Sign In
Sign In as a Tableau Server Administrator
Descripti- Signs you in as the Tableau Server system administrator. For production
on
environments, it's recommended that you sign in via HTTPS.
POST /api/2.0/auth/signin
Method
and URI
Message <tsRequest>
Payload
<credentials name="admin-username" password="adminpassword" >
<site contentUrl="target-site-content-URL" />
- 399 -
</credentials>
</tsRequest>
Response 200
Code
Response <tsResponse>
Payload
<credentials token="admin-user-authenticity-token" >
<site contentUrl="target-site-content-URL" />
</credentials>
</tsResponse>
Sign In as a Tableau Server User
Descripti- Signs you in as a Tableau Server user. For production environments, it's
on
recommended that you sign in via HTTPS.
POST /api/2.0/auth/signin
Method
and URI
Message <tsRequest>
Payload
<credentials name="admin-username" password="adminpassword" >
<site contentUrl="target-site-content-URL" />
<user id="user-to-run-as" />
</credentials>
</tsRequest>
Response 200
Code
Response <tsResponse>
Payload
<credentials token="run-as-user-token" >
<site contentUrl="target-site-content-URL" />
</credentials>
</tsResponse>
Payload Details
The <site> element is required in the request to specify the site that the user will be logged
into. When the <site> element is empty in the request, the default site will be used:
<site />
The default site can also be specified using empty quotes:
<site contentUrl="" />
The <site> element is always populated in the response.
- 400 -
Error Conditions
HTTP Response Code
401
Condition
Login error
403
Non-admin sign-in forbidden
404
User not found
405
Invalid request method
Details
The name or
password is
invalid for the
given site, or the
site content URL
is invalid.
An attempt was
made to sign in a
user (nonadministrator)
directly, using the
user’s credentials.
A Tableau Server
user can be
signed in only
indirectly via an
administrator’s
credentials.
The user ID given
in the payload for
a user sign-in
does not
correspond to an
existing user on
the site.
Request type was
something other
than a POST.
Sign Out
Description
Method and URI
Message Payload
Response Code
Response Payload
Signs you out of the current session and invalidates the token.
POST /api/2.0/auth/signout
None
204
None
- 401 -
Error Conditions
HTTP Response Code
405
Condition
Invalid request method
Details
Request type was
something other
than a POST.
Query Datasources
Description
Method and URI
Returns a list of data sources on the specified site, with optional parameters
for specifying the paging of large results.
GET /api/2.0/sites/site-id/datasources
GET /api/2.0/sites/siteid/datasources?pageSize=pagesize&pageNumber=page-number
Message
None
Payload
Response Code 200
Response
<tsResponse>
Payload
<pagination pageNumber="pageNumber"
pageSize="page-size"
totalAvailable="total-available" />
<datasources>
<datasource id="datasource1-id"
name=”datasource1-name”
type="datasource1-type" >
<project id="project-id" name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
</datasource>
<datasource id="datasource2-id"
name=”datasource2-name”
type="datasource2-type" >
<project id="project-id" name="project-name" />
<tags>
- 402 -
<tag label="tag3"/>
... more tags ...
</tags>
</datasource>
... more datasources ...
</datasources>
</tsResponse>
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users who are not administrators can access this API method, but they can
only view data sources for which they have the Connect capability allowed (either explicitly or
implicitly).
Pagination Parameter Defaults
By default the page size is 100 and page 1 is served. One or both parameters can be
overridden explicitly.
Error Conditions
HTTP Response Code
400
Condition
Invalid page size
400
Invalid page number
404
Site not found
405
Invalid request method
Details
The page size parameter is not
an integer, or is less than one.
The page number parameter is
not an integer, is less than one,
or is greater than the final page
number for data sources at the
requested page size.
The site ID given in the URI
does not correspond to an
existing site.
Request type was something
other than a GET.
Query Datasource
Description
Method and URI
Returns metadata about a specific data source.
GET /api/2.0/sites/siteid/datasources/datasource-id
- 403 -
Message Payload
Response Code
Response Payload
None
200
<tsResponse>
<datasource id="datasource-id"
name=”some-name”
type="some-type" >
<project id="project-id" name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
</datasource>
</tsResponse>
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users who are not administrators can access this API method, but they can
only view data sources for which they have the Connect capability allowed (either explicitly or
implicitly).
Error Conditions
Condition
403
HTTP Response Code
Read forbidden
404
Site not found
404
Data source not found
405
Invalid request method
- 404 -
Details
A non-administrator user
invoked the API method and
attempted to query a data
source for which he or she
did not have the Connect
capability allowed.
The site ID given in the URI
does not correspond to an
existing site.
The data source ID given in
the URI does not correspond
to an existing data source.
Request type was something
other than a GET.
Create Project
Description Creates a project on the specified site.
POST /api/2.0/sites/site-id/projects
Method and
URI
Message
<tsRequest>
Payload
<project name="project-name"
Response
Code
Response
Payload
Response
Headers
description="project-description" />
</tsRequest>
201
<tsResponse>
<project id=”new-project-id”
name=”project-name”
description="project-description" />
</tsResponse>
Location: /api/2.0/sites/site-id/projects/new-project-id
Payload Details
The project-name attribute is required for this operation; the project-description
attribute is optional.
Error Conditions
HTTP Response Code
404
Condition
Site not found
405
Invalid request method
409
Project name conflict
- 405 -
Details
The site ID given in the URI
does not correspond to an
existing site.
Request type was something
other than a POST.
The project name in the
request already belongs to
the given site in the system.
For the purpose of
uniqueness checks, project
names are case-insensitive.
Delete Project
Description
Method and URI
Message Payload
Response Code
Response Payload
Deletes the specified project on a specific site.
DELETE/api/2.0/sites/siteid/projects/project-id
None
204
None
Business Logic and Error Conditions
When a project is deleted in the system all of its assets are also deleted: associated workbooks,
datasources, project view options, and rights. Use this method with caution.
Error Conditions
HTTP Response Code
403
Condition
Deletion forbidden
404
Site not found
404
Project not found
405
Invalid request method
Details
Attempt to delete the
default project, which
cannot be deleted.
The site ID or URL
namespace given in the
URI does not correspond to
an existing site.
Either the project ID given
in the URI does not
correspond to an existing
project or the project is not
found on this site.
Request type was
something other than a
DELETE.
Update Project
Description
Method and URI
Message Payload
Updates the name or description of the specified project.
PUT /api/2.0/sites/siteid/projects/project-id
<tsRequest>
- 406 -
Response Code
Response Payload
<project name=”some-new-name”
description=”some-new-description” />
</tsRequest>
200
<tsResponse>
<project name=”some-name”
description=”some-description” />
</tsResponse>
Business Logic and Error Conditions
Payload Variations
Any combination of the attributes inside the <project> element is valid. Only those attributes
present will result in updates to their values in the project. If no attributes are present, then the
update won't have an effect.
HTTP Response Code
403
Condition
Update forbidden
404
Site not found
404
Project not found
404
Project ID mismatch
405
Invalid request method
409
Project name conflict
- 407 -
Details
Attempt to rename the
default project.
The site ID given in the URI
does not correspond to an
existing site.
The project ID given in the
URI does not correspond to
an existing project.
The payload contains a
project ID (which is
optional) and it does not
match up with the ID in the
URI.
Request type was
something other than a
PUT.
The project name in the
request already belongs to
the given site in the system.
For the purpose of
uniqueness checks, project
names are case-insensitive.
Add Tags to Workbook
Description
Method and URI
Message Payload
Response Code
Response Payload
Adds one or more tags to the specified workbook.
PUT /api/2.0/sites/siteid/workbooks/workbook-id
<tsRequest>
<workbook id="workbook-id">
<tags>
<tag label="tag1" />
<tag label="tag2" />
... more tags ...
</tags>
</workbook>
</tsRequest>
200
<tsResponse>
<workbook id="workbook-id"
name="workbook-name"
>
<project id="project-id"
name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
<views>
<view id="view1-id" />
<view id="view2-id" />
... more views ...
</views>
</workbook>
</tsResponse>
Payload Details
If the workbook is already tagged with any tags in the payload, then those tags are ignored and
the workbook retains them. If the tags element is empty, no new tags are added to the
workbook.
Business Logic and Error Conditions
Non-Administrator Access
Tableau Server users who are not administrators can use this method but they can only add a
tag to workbook for which they have the Add Tag capability allowed (either explicitly or
- 408 -
implicitly).
HTTP Response Code
403
Condition
Adding tags forbidden
404
Site not found
404
Workbook not found
404
Workbook ID mismatch
405
Invalid request method
Details
A Tableau Server user who
isn't an administrator
invoked the API method
and attempted to add a tag
to a workbook for which he
or she did not have the Add
Tag capability allowed. This
error is raised even in the
case when the tags
element is empty.
The site ID given in the URI
is not for an existing site.
The workbook ID given in
URI does not correspond to
an existing workbook.
The payload contains a
workbook ID (which is
optional) and it does not
match the ID in the URI.
Request type was
something other than a
PUT.
Delete Tag from Workbook
Description
Method and URI
Message Payload
Response Code
Response Payload
Deletes one or more tags from the specified workbook.
DELETE /api/2.0/sites/siteid/workbooks/workbook-id/tags/tag-name
None
204
None
- 409 -
Business Logic and Error Conditions
Non-Admin User Access
Tableau Server users who are not administrators can access this API method, but they can
only delete a tag from a workbook for which they have the capability implicitly allowed (in other
words, as owner of the workbook).
HTTP Response Code
403
Condition
Deleting tags forbidden
404
Site not found
404
Workbook not found
404
Tag not found
405
Invalid request method
Details
A Tableau Server user who
isn’t an administrator
invoked the API method
and attempted to delete a
tag from a workbook for
which he or she did not
have the capability implicitly
allowed.
The site ID or URL
namespace given in the
URI does not correspond to
an existing site.
The workbook ID given in
the URI does not
correspond to an existing
workbook.
The tag given in the URI
does not exist for the given
workbook.
Request type was
something other than a
DELETE.
Query Workbook
Description
Method and URI
Returns metadata about the specified workbook, optionally
including a thumbnail.
GET /api/2.0/sites/siteid/workbooks/workbook-id
GET /api/2.0/sites/site-
- 410 -
id/workbooks/workbookid?previewImage=false
Message Payload
Response Code
Response Payload
None
200
<tsResponse>
<workbook id="workbook-id"
name=”some-name”
description="some-description" >
<project id="project-id"
name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
<views>
<view id="view1-id"/>
<view id="view2-id"/>
... more views ...
</views>
</workbook>
</tsResponse>
Query Workbook with a Preview Image
Description
Method and URI
Message Payload
Response Code
Response Payload
Returns metadata about the specified workbook, including a
thumbnail.
GET /api/2.0/sites/siteid/workbooks/workbookid?previewImage=true
None 200
Same as above embedded in a MIME multipart message with
the following format:
MIME header
XML payload (in the format shown in the above table)
The binary preview image.
- 411 -
Payload Details
An example of the full response format follows. The MIME multipart message is shown split by
parts via a table, and the "interpart boundary" text is omitted as the table rows act to show
where this delimiter would occur.
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary=interpartBoundary
Content-Type: text/xml
<tsResponse>
<workbook>
<!-- see markup example from previous section -->
</workbook>
</tsResponse>
Content-Disposition: name="myPreviewImage"; filename="foo"
Content-Transfer-Encoding: binary
Content-Type: application/octet-stream
...the-tableau-workbook-preview-image-goes-here...
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users can access this API method, but they can only query workbooks for
which they have the Read capability allowed (either explicitly or implicitly).
HTTP Response Code
400
Condition
Invalid URI parameters
403
Read forbidden
404
Workbook not found
- 412 -
Details
The previewImage
parameter is specified but it
has a value other than true
or false.
A user who isn’t an
administrator invoked the
API method and attempted
to query workbooks for
which he or she does not
have the Read capability
allowed.
The workbook ID given in
the URI does not
correspond to an existing
workbook.
404
Site not found
405
Invalid request method
The site ID given in the URI
does not correspond to an
existing site.
Request type was
something other than a
GET.
Add Workbook to Favorites
Description
Method and URI
Message Payload
Response Code
Response Payload
Adds the specified workbook to a user’s favorites,
PUT /api/2.0/sites/siteid/favorites/user-id
<tsRequest>
<favorite label="favorite-label">
<workbook id="workbook-id" />
</favorite>
</tsRequest>
200
<tsResponse>
<favorites>
<favorite label="favorite-label">
<workbook id="workbook-id" />
</favorite>
<favorite label="favorite2">
<view id="view-id" />
</favorite>
... more favorites ...
</favorites>
</tsResponse>
If the user already has the workbook in his or her favorites with the same label, then the
operation will have no effect. If the label differs, then the original favorite is overwritten.
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users can access this API method, but they can only add a workbook to a
Favorites list if they have the Add Favorite capability allowed for the workbook (either
explicitly or implicitly).
- 413 -
HTTP Response Code
400
Condition
Invalid label
403
Access to Favorites forbidden
404
User not found
404
Site not found
404
Workbook not found
405
Invalid request method
409
Label conflict
Details
The favorite label is empty
or consists of only white
space characters.
A Tableau Server user
invoked the API method
and attempted to add a
workbook to their Favorites
list without the Add
Favorite capability. This
will always be the case
when the user ID in the URI
identifies a user other than
the user invoking the
method.
The user ID given in the
URI does not correspond to
an existing user.
The site ID given in the URI
does not correspond to an
existing site.
The workbook ID given in
the payload does not
correspond to an existing
workbook.
Request type was
something other than a
PUT.
There is already a favorite
with the same label for a
different workbook in the
given user's favorites.
Delete Workbook from Favorites
Description
Method and URI
Deletes a workbook from a user’s favorites.
DELETE/api/2.0/sites/siteid/favorites/user-
- 414 -
id/workbooks/workbook-id
Message Payload
Response Code
Response Payload
None
204
None
Business Logic and Error Conditions
If the workbook you specify isn't a Favorite, then this call has no effect.
Non-Administrator User Access
Tableau Server users can access this API method, but they can only delete a workbook from
their own Favorites list.
Error Conditions
HTTP Response Code
403
Condition
Access to Favorites forbidden
404
User not found
404
Site not found
404
Workbook not found
404
Workbook not a favorite
405
Invalid request method
- 415 -
Details
A Tableau Server user
invoked the API method
and attempted to delete a
workbook from a different
user's favorites..
The user ID given in the
URI does not correspond to
an existing user.
The site ID given in the URI
does not correspond to an
existing site.
The workbook ID given in
the payload does not
correspond to an existing
workbook.
The workbook ID given in
the URI exists but is not a
favorite of the given user.
Request type was
something other than
aDELETE.
Query View with a Preview Image
Description
Method and URI
Message Payload
Response Code
Response Payload
Return the thumbnail for a specific view.
GET /api/2.0/sites/siteid/workbooks/workbook-id/views/viewid/previewImage
None
200
The view's preview image in PNG format (MIME media type
image/png).
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users can can access this API method, but they can only query workbook
views for which they have the Read capability allowed (either explicitly or implicitly).
Error Conditions
HTTP Response Code
403
Condition
Read forbidden
404
View not found
404
Site not found
404
Workbook not found
405
Invalid request method
- 416 -
Details
A Tableau Server user
invoked the API method
and attempted to query a
workbook view for which he
or she did not have the
Read capability allowed.
The view ID given in the
URI does not correspond to
an existing view in the given
workbook.
The site ID given in the URI
does not correspond to an
existing site.
The workbook ID given in
the payload does not
correspond to an existing
workbook.
Request type was
something other than
aDELETE.
Query Views for Workbook
Description
Method and URI
Return all the views for the specified workbook, optionally
including usage statistics.
GET /api/2.0/sites/siteid/workbooks/workbook-id/views
GET /api/2.0/sites/siteid/workbooks/workbookid/views?includeUsageStatistics=false
Message Payload
Response Code
Response Payload
None
200
<tsResponse>
<views>
<view id="view1-id" name="view1-name" />
<view id="view2-id" name="view2-name" />
... more views ...
</views>
</tsResponse>
Query Views with Usage Statistics
Method and URI
Message Payload
Response Code
Response Payload
GET /api/2.0/sites/siteid/workbooks/workbookid/views?includeUsageStatistics=true
None
200
<tsResponse>
<views>
<view id="view1-id" name="view1-name" >
<usage totalViewCount="total-count1" />
</view>
<view id="view2-id" name="view2-name" >
<usage totalViewCount="total-count2" />
</view>
... more views ...
</views>
</tsResponse>
- 417 -
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users can access this API method, but they can only query workbook views for
which they have the Read capability allowed (either explicitly or implicitly).
Error Conditions
HTTP Response Code
400
Condition
Invalid parameter value
403
Read forbidden
404
Site not found
404
Workbook not found
405
Invalid request method
Details
The
includeUsageStatistics
was provided with a value other
than true or false
A Tableau Server user invoked
the API method and attempted
to query workbook views for
which he or she did not have
the Read capability allowed.
The site ID given in the URI
does not correspond to an
existing site.
The workbook ID given in the
payload does not correspond to
an existing workbook.
Request type was something
other than aGET.
Query Workbook Preview Image
Description
Method and URI
Message Payload
Response Code
Response Payload
Returns the thumbnail for a specified workbook. Usually the
image that's returned is for the first sheet in the workbook.
GET /api/2.0/sites/siteid/workbooks/workbook-id/previewImage
None
200
The workbook's preview image in PNG format (MIME media
type image/png).
- 418 -
Business Logic and Error Conditions
For on-premise Tableau Server deployments and for Tableau Public, the system returns the
preview image associated with the lowest index view in the workbook.
Non-Administrator User Access
Tableau Server users can use this API method, but they can only fetch preview images for
workbooks for which they have the Read capability allowed (either explicitly or implicitly).
Error Conditions
HTTP Response Code
403
Condition
Read forbidden
404
Site not found
404
Workbook not found
405
Invalid request method
Details
A Tableau Server user
invoked the API method
and attempted to query
workbook views for which
he or she did not have the
Read capability allowed.
The site ID given in the URI
does not correspond to an
existing site.
The workbook ID given in
the payload does not
correspond to an existing
workbook.
Request type was
something other than aGET.
Query Workbooks for User
Descri- Return the workbooks associated with a specific user, optionally including paging
ption parameters.
Method and
URI
GET /api/2.0/sites/site-id/users/user-id/workbooks
GET /api/2.0/sites/site-id/users/userid/workbooks?pageSize=page-size&pageNumber=page-number
Messa- None
ge
Payload
- 419 -
Respo- 200
nse
Code
Respo- <tsResponse>
nse
<pagination pageNumber="pageNumber" pageSize="page-size"
Paylo- totalAvailable="total-available" />
ad
<workbooks>
<workbook id="workbook1-id"
name=”some-name” >
<project id="project-id" name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
<views>
<view id="view1-id"/>
<view id="view2-id"/>
... more views ...
</views>
</workbook>
<workbook id="workbook2-id"
name=”some-name” >
<project id="project-id" name="project-name" />
<tags>
<tag label="tag1"/>
<tag label="tag2"/>
... more tags ...
</tags>
<views>
<view id="view1-id"/>
<view id="view2-id"/>
... more views ...
</views>
</workbook>
</workbooks>
... more workbooks ...
</tsResponse>
Business Logic and Error Conditions
Non-Administrator User Access
Tableau Server users can use this API method, but they can only query workbooks for which
they have the Read capability allowed (either explicitly or implicitly).
- 420 -
Pagination Parameter Defaults
By default the page size is 100 and page 1 is served. One or both parameters can be
overridden explicitly.
Error Conditions
HTTP Response Code
403
Condition
Read forbidden
404
Site not found
404
User not found
405
Invalid request method
Details
A Tableau Server user
invoked the API method
and attempted to query
workbook views for which
he or she did not have the
Read capability allowed.
The site ID given in the URI
does not correspond to an
existing site.
The user ID given in the
URI does not correspond to
an existing user.
Request type was
something other than aGET.
Add User to Site
Description
Method and URI
Message Payload
Response Code
Response Payload
Adds a user to the specified site.
POST /api/2.0/sites/site-id/users/
<tsRequest>
<user name="user-name"
role="some-role"
publish="true-or-false"
contentAdmin="true-or-false*"
suppressGettingStarted="true-or-false" />
</tsRequest>
201
<tsResponse>
<user id="user-id"
name="user-name"
role="some-role"
publish="true-or-false"
- 421 -
Response Headers
contentAdmin="true-or-false"
suppressGettingStarted="true-or-false" />
</tsResponse>
Location: /api/2.0/sites/site-id/users/new-user-id
Payload Details
There are three valid roles available: Interactor, Viewer, and Unlicensed.
The contentAdmin parameter can only be true if the role is Interactor. For any other role, a
value of contentAdmin in the request payload will be ignored, and the value false will be
used and subsequently returned in the response payload.
The suppressGettingStarted parameter may be omitted. If it is, the user will retain their
existing preference if he or she is already a member of another site. If the user is new to the
system, the preference will be set to the default according to user type: enabled for site
administrators, suppressed for others.
Error Conditions
HTTP Response Code
404
Condition
Site not found
404
User name not found
405
Invalid request method
409
User conflict
409
Guest user conflict
Get Users on Site
Descripti- Returns the users associated with the specified site.
on
- 422 -
Details
The site ID given in the URI
does not correspond to an
existing site.
The user name given in the
payload does not
correspond to an existing
user in the system.
Request type was
something other than a
POST or a GET.
The given user is already
registered on the site.
The Tableau Online API
disallows adding a user with
the guest role to a site.
GET /api/2.0/sites/site-id/users/
Method
and URI
Message None Payload
Respons- 200
e Code
Respons- <tsResponse>
e
<users>
Payload
<user id=”user1-id”
name=”user1-name”
role=”some-role”
publish=”true-or-false”
contentAdmin=”true-or-false”
lastLogin=”YYYY-MM-DDTHH:MM:SSZ”
externalAuthUserId=”authentication-id-from-externalprovider”/>
<user id=”user2-id”
name=”user2-name”
role=”some-role”
publish=”true-or-false”
contentAdmin=”true-or-false”
lastLogin=”YYYY-MM-DDTHH:MM:SSZ”
externalAuthUserId=”authentication-id-from-externalprovider” />
...
</users>
</tsResponse>
Error Conditions
HTTP Response Code
404
Condition
Site not found
405
Invalid request method
- 423 -
Details
The site ID given in the URI
does not correspond to an
existing site.
Request type was
something other than a
POST or a GET.
Remove User from Site
Description
Method and URI
Message Payload
Response Code
Response Payload
Removes a user from the specified site.
DELETE /api/2.0/sites/siteid/users/user-id
None
204
None
Business Logic and Error Conditions
If a user still owns content on Tableau Server, the user cannot be deleted. The ownership of
the user’s content will need to move to a different user first.
Error Conditions
HTTP Response Code
400
Condition
Deletion failed
404
Site not found
404
User not found
405
Invalid request method
409
User asset conflict
Details
Some other problem arose
that prevented the user
from being removed from
the site.
The site ID given in the URI
does not correspond to an
existing site.
The user ID given in the
URI does not correspond to
an existing user.
Request type was
something other than a
DELETE, a POST, or a GET.
The given user still owns
content on Tableau Server.
Create Site
Description
Method and URI
Message Payload
Creates a site on Tableau Server with the given metadata.
POST /api/2.0/sites/
<tsRequest>
- 424 -
Response Code
Response Payload
Response Headers
<site name="site-name"
contentUrl="some-content-url"
adminMode="some-admin-mode"
userQuota="num-users"
storageQuota="limit-in-megabytes"
disableSubscriptions="false" />
</tsRequest>
201
<tsResponse>
<site id=”new-site-id”
name=”site-name”
contentUrl=”the-content-url”
adminMode=”the-admin-mode”
userQuota=”num-users”
storageQuota=”limit-in-megabytes”
disableSubscriptions="false" />
</tsResponse>
Location: /api/2.0/sites/new-site-id
Payload Details
At the time this section was edited, there were two valid admin modes available:
ContentOnly, and ContentAndUsers. Note that adminMode is not a required
parameter.
Error Conditions
HTTP Response Code
405
Condition
Invalid request method
409
Site name conflict
409
Site URL conflict
- 425 -
Details
Request type was
something other than a
POST or a GET.
The site name in the
request already belongs to
an existing site in the
system.
The content URL in the
request already belongs to
an existing site in the
system.
Update Site
Description
Method and URI
Message Payload
Response Code
Response Payload
Modifies the metadata of the specified site.
PUT /api/2.0/sites/site-id
<tsResponse>
<site name=”some-name”
contentUrl=”some-content-url”
adminMode="some-admin-mode"
userQuota=”num-users"
state=”active-or-suspended”
statusReason=”reason-for-state”
storageQuota=”limit-in-megabytes”
disableSubscriptions="true-or-false" />
</tsResponse>
200
<tsResponse>
<site name=”some-name”
contentUrl=”some-content-url”
adminMode="some-admin-mode"
userQuota=”num-users"
state=”active-or-suspended”
statusReason=”reason-for-state”
storageQuota=”limit-in-megabytes”
disableSubscriptions="true-or-false" />
</tsResponse>
Payload Details
At the time this section was edited, there were two valid admin modes available:
ContentOnly, and ContentAndUsers.
Business Logic and Error Conditions
Payload Variations
Any combination of the attributes inside the <site> element is valid. Only those attributes
present will result in updates to their values in the site. If no attributes are present, then the
update will not take effect.
Error Conditions
HTTP Response Code
400
Condition
Invalid admin mode
400
Invalid state
- 426 -
Details
An admin mode parameter
was provided in the request
with an invalid value.
A state parameter was
provided in the request with
404
Site not found
404
User name not found
405
Invalid request method
409
Site name conflict
409
Site URL conflict
an invalid value
The site ID given in the URI
does not correspond to an
existing site.
The user name given in the
payload does not
correspond to an existing
user in the system.
Request type was
something other than a
PUT, a DELETE, or a GET.
The new site name in the
request already belongs to
an existing site in the
system.
The new content URL in the
request already belongs to
an existing site in the
system.
Query Site
Descr- Returns metadata on the specified site, which can be queried by name, site-id, or the
iption site URL.
Metho- Query by Site ID
d and
URI
GET/api/2.0/sites/site-id
Query by Site Name
GET/api/2.0/sites/sitename?key=name
Query by URL Namespace
GET/api/2.0/sites/site-urlnamespace?key=contentUrl
Mess- None
age
Payload
- 427 -
Resp- 200
onse
Code
Resp- <tsResponse>
onse
<site id="site-id"
Payloname=”some-name”
ad
contentUrl=”some-content-url”
adminMode="some-admin-mode"
userQuota=”num-users"
storageQuota=”limit-in-megabytes”
state=”active-or-suspended”
statusReason=”reason-for-state” />
</tsResponse>
Site Information Including Storage Usage
MethQuery by Site ID
od
and
URI
GET/api/2.0/sites/siteid?includeUsage=true
Query by Name
GET/api/2.0/sites/sitename?key=name&includeUsage=true
Query by URL Namespace
GET/api/2.0/sites/site-urlnamespace
?key=contentUrl&includeUsage=true
Mess- None
age
Payload
Resp- 200
onse
Code
Resp- <tsResponse>
onse
<site id="site-id"
Payloname="some-name"
ad
contentUrl="some-content-url"
adminMode="some-admin-mode"
userQuota="num-users"
storageQuota="limit-in-megabytes"
state="active-or-suspended"
statusReason="reason-for-state" >
<usage numUsers="the-number-of-users"
- 428 -
storage="the-storage-in-megabytes"
</usage>
</site>
</tsResponse>
Error Conditions
HTTP Response Code
404
Condition
Site not found
405
Invalid request method
Details
The site ID or URL
namespace given in the
URI does not correspond to
an existing site.
Request type was
something other than a
GET, DELETE, or PUT.
Delete Site
Descr- Deletes the specified site.
iption
Metho- Delete by Site ID
d and
URI
DELETE/api/2.0/sites/site-id
Delete by Site Name
DELETE/api/2.0/sites/sitename?key=name
Delete by URL Namespace
DELETE/api/2.0/sites/site-urlnamespace?key=contentUrl
Mess- None
age
Payload
Resp- 204
onse
Code
Resp- None
onse
Payload
- 429 -
Error Conditions
HTTP Response Code
403
Condition
Deletion forbidden
404
Site not found
405
Invalid request method
- 430 -
Details
Attempt to delete the
default Tableau Server site.
The site ID or URL
namespace given in the
URI does not correspond to
an existing site.
Request type was
something other than a
GET, DELETE, or PUT.
联系方式
有关销售咨询，请联系 sales@tableausoftware.com。
有关客户支持，请联系 support@tableausoftware.com。
有关其他咨询，请联系 info@tableausoftware.com。
电话：(206) 633-3400
- 431 -
版权所有
©2014 Tableau Software, Inc. 及其许可方。保留所有权利。
专利 www.tableausoftware.com/ip。
代码部分版权所有 ©2002 The Board of Trustees of the Leland Stanford Junior University.
保留所有权利。
Tableau 的安装包括 Firebird 数据库的未修改可执行版本。http://www.firebirdsql.org 提
供了该数据库的源代码
有关第三方版权声明的列表，请参见随 Tableau Server 安装的以下文件：
C:\Program Files\Tableau\Tableau Server\8.2\COPYRIGHTS.rtf
注意：如果在 64 位操作系统上安装了 32 位 Tableau Server，它将位于
C:\Program Files (x86)\Tableau\Tableau
Server\8.2\COPYRIGHTS.rtf
本产品包含由 Andy Clark 开发的软件。
本产品包含由 Apache Software Foundation 开发的软件 (http://www.apache.org/)。
本产品是 Tableau Software 的《最终用户软件许可协议》中定义的客户端软件。
- 432 -