CSV 导入文件准则

通过创建含有用户信息的逗号分隔值 (CSV) 文件,然后导入该文件,即可自动添加用户。您可以在 CSV 文件中包括属性(例如许可级别和发布访问权限),以便在导入这些属性的同时将它们应用于用户。

若要导入用户,您可以使用服务器或站点管理页面或 tabcmd 实用工具。使用 tabcmd 提供用于为 CSV 文件中的所有用户分配站点角色的选项。有关信息,请参见导入用户createsiteusers filename.csv

您可以在站点或服务器级别导入用户。如果将用户导入到服务器(而不是导入特定站点),则不会将用户分配到站点,并且会以“未许可”方式导入用户。

注意:除非另有说明,否则本主题中指定的准则适用于配置或未配置身份池(链接在新窗口中打开)的 Tableau Server。

CSV 文件格式要求

在创建用于导入用户的 CSV 文件时,请确保文件满足以下格式要求:

  • 文件不包括列标题。Tableau Server假定文件中的每一行代表一个用户。

  • 文件为 UTF-8 格式,并包括字节顺序标记 (BOM)。

  • 诸如 BIG-5 等字符编码已转换为 UTF-8。可通过在文本编辑器中打开文件并使用“另存为”命令来达到此目的。

  • 如果用户名包括的“@”字符不是表示域分隔符,则您需要使用十六进制格式引用该符号:\0x40

    例如,user@fremont@mycompany.com 应该为 user\0x40fremont@mycompany.com

CSV 文件中所需的列

需要为每个用户提供以下值:

  • User name

  • Password:如果将 Tableau Server 配置为使用 Active Directory 身份验证,则必须具有一个 Password 列,但该列本身应该是空的。如果服务器使用本地身份验证,则必须为新用户提供密码。

其他导入文件选项

CSV 文件可按以下顺序包含以下字段:

  • User name。用户名。如果服务器配置为使用 Active Directory,则此值必须与 Active Directory 中定义的用户匹配。如果用户名在域之间不唯一,则必须包括域作为用户名的一部分(例如,example\Adamadam@example)。这是唯一需要的字段

    如果将用户添加到身份池(链接在新窗口中打开),请确保以下内容:

    • 如果将用户添加到使用 AD 作为其身份存储的身份池,请确保使用 AD sAMAccountName 值作为用户名。
    • 如果将用户添加到使用 LDAP 作为其身份存储的身份池,请确保使用 LDAP 用户名值作为用户名。
  • Password。用户的密码。如果服务器配置为使用 Active Directory,则不使用此值。

  • Display name。显示名称是用于在服务器上标识用户的信息的一部分。如果用户的显示名称已在使用,Tableau Server 将使用 CSV 文件中的设置更新现有用户信息。如果服务器配置为使用 Active Directory,则不使用此值。

  • License level。可以是“Creator”“Explorer”“Viewer(查看者)”“Unlicensed”。如果您为特定用户帐户指定“Creator” ,则还必须将发布能力设置为 True

  • 管理员级别(SystemSiteNone)。此设置确定是否以管理员形式导入用户。

    如果使用 Web UI 导入用户,则只有在服务器(所有站点)级别导入文件时,您才能将管理员站点角色设置为“System”。如果登录到特定站点,并且 CSV 文件中用户的管理员列设置为“System”,则 Tableau Server 将以站点管理员形式导入用户。

  • 发布能力(yes/true/1no/false/0)。如果使用 Web UI,则只有在登录到特定站点的同时进行导入才会使用发布者设置。

  • 电子邮件地址。电子邮件地址是用于在服务器上识别用户的信息的一部分。如果电子邮件地址已在使用,Tableau Server 将使用 CSV 文件中的设置更新现有用户信息。

如果将用户添加到身份池,除了上述值之外,还需要以下值:

  • 身份池名称。您要将用户添加到其中的身份池的名称。

  • 标识符。您要添加的用户的标识符。标识符仅用于身份匹配目的。有关详细信息,请参见Tableau 中的用户名和标识符注意:如果将用户添加到使用 Active Directory(或 LDAP)身份存储的身份池,则需要该标识符。如果将用户添加到使用本地身份存储的身份池,则标识符是可选的。

    注意:

    • 如果您要将用户添加到身份池并且未指定身份池名称,则会将用户添加到初始池(TSM 配置),这是 Tableau Server 设置期间在 TSM 中预置的用户集。
    • 对于用户名值,请确保以下内容:

      • 如果将用户添加到使用 AD 作为其身份存储的身份池,请确保使用 AD sAMAccountName 值作为用户名。
      • 如果将用户添加到使用 LDAP 作为其身份存储的身份池,请确保使用 LDAP 用户名值作为用户名。
    • 您可以使用 CSV 导入过程来:

      • 将用户批量添加到其他身份池。注意:您无法使用 CSV 导入过程将用户已所属的身份池替换为另一个身份池。如果您添加具有不同身份池值的现有用户,他们将被添加到该附加身份池中。

      • 为还没有标识符的用户批量添加标识符。注意:如果您为同一池中的用户添加不同的标识符,它不会替换该用户的现有标识符。相反,将为该用户创建一个新的标识符记录。

重要信息:列的顺序非常重要。将第一列视为用户名,将第二列视为密码,将第三列视为显示名称等等,而不考虑列中的内容。如果忽略字段的值,您必须仍然包括字段的逗号分隔符。

提高通过 tabcmd 传递的大型 CSV 文件的性能

注意:这些设置适用于 Tableau Server 版本 2022.1 及更低版本。从版本 2022.3 开始,它们影响的搜索和索引服务已弃用,并在 2023.3 中被停用(完全移除)。

服务器管理员可以启用服务器设置,帮助提高通过 tabcmd 命令导入大型 CSV 文件的性能。您可以使用以下选项运行 tsm configuration set 命令来完成此操作:

  • vizportal.csv_user_mgmt.index_site_users

  • vizportal.csv_user_mgmt.bulk_index_users

  • searchserver.index.bulk_query_user_groups

本质上,这些选项会在处理 CSV 文件后建立这些用户的索引,而不是在将用户添加到服务器的数据库后逐个建立用户索引。这将减少数据库调用次数和处理文件所需的内存。这些 tsm configuration set 选项适用于 tabcmd createsiteusersdeletesiteusersaddusersremoveusers 命令。

有关这些设置的说明,请参见tsm configuration set 选项

说明

  • 如果未登录到特定站点,并且在服务器级别导入用户,则只能分配“服务器管理员”和“未许可”站点角色。

  • 如果有基于用户的服务器安装,并且添加用户会超出许可证允许的用户数,则会以未许可用户形式添加用户。

  • 如果使用 tabcmd 并指定许可证,但导入用户会超出许可证限制,则会以“未许可”方式导入用户。

CSV 设置和站点角色

用户的许可证级别、管理员和发布设置确定如何在导入过程中设置用户的站点角色。下表显示这些设置如何转换为站点角色。

CSV 设置站点角色

许可级别 =(任意)

Administrator=System

Publisher=true

服务器管理员。此设置仅适用于 Tableau Server only,并且只有在管理服务器(也就是说,未登录到特定站点)的同时导入用户才有效。

“服务器管理员”站点角色始终获得“Creator”许可证(如果有)。如果没有“Creator”许可证,请参见许可疑难解答了解 Tableau Server 如何处理此情况。

License level=Creator 或 Explorer

Administrator=Site

Publisher=true

站点管理员 Creator 或站点管理员 Explorer。只有在登录到特定站点的同时导入用户,此设置才有效。

License level=Creator

Administrator=None

Publisher=true

Creator

License level=Explorer

Administrator=None

Publisher=true

Explorer(可发布)

License level=Explorer

Administrator=None

Publisher=false

Explorer

License level=Viewer

Administrator=None

Publisher=false

Viewer(查看者)

License level=Unlicensed

Administrator=None

Publisher=false

未许可

Tableau Server 的 CSV 导入示例

以下示例显示了一个包含若干用户的信息的 CSV 文件。

henryw,henrypassword,Henry Wilson,Creator,None,yes,henryw@example.com
freds,fredpassword,Fred Suzuki,Viewer,None,no,freds@example.com
alanw,alanpassword,Alan Wang,Explorer,Site,yes,alanw@example.com
michellek,michellepassword,Michelle Kim,Creator,System,yes,michellek@example.com

如果在管理站点的同时导入此文件,则会向该站点中添加四个用户。用户 Michelle 的 Administrator 设置为 System。但是,由于您在将用户导入站点,Tableau Server 会为 Michelle 授予“站点管理员 Creator”站点角色。其中三个用户允许进行发布。

如果在管理服务器的同时导入此文件,则会向服务器中添加四个用户,但不会将它们添加到任何站点。只会导入一个用户作为服务器管理员;其余用户设置为“未许可”。

身份池示例

以下示例显示了一个 CSV 文件,其中包含添加到身份池的两个用户的信息。

henryw,henrypassword,Henry Wilson,Viewer,None,yes,hwilson@myco.com,General Contractors,hwilson
freds,fredpassword,Fred Suzuki,Creator,None,no,fsuzuki@myco.com,General Contractors,fsuzuki

以下示例显示了一个 CSV 文件,其中包含添加到附加身份池的两个用户的信息。

henryw,henrypassword,Henry Wilson,Viewer,None,yes,hwilson@myco.com,General Contractors 2,hwilson
freds,fredpassword,Fred Suzuki,Creator,None,no,fsuzuki@myco.com,General Contractors 2,fsuzuki

以下示例显示了一个 CSV 文件,其中包含添加到没有现有标识符的两个用户的信息。

janes,janepassword,Jane Smith,Viewer,None,yes,jsmith@myco.com,General Contractors,jwang
laurar,laurapassword,Laura Rodriguez,Creator,None,no,lrodriguez@myco.com,General Contractors,jrodriguez
感谢您的反馈!您的反馈已成功提交。谢谢!