---
schema_version: "1"
id: 5b373e76eac1a4d0fae0674fc1b05837ca4b9d27f41ac40aa8d019e81a370f37
title: CSV 导入文件准则
collection: tableau
version: next
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/next/zh-cn/server-linux/csvguidelines.md
canonical_url: https://help.tableau.com/v0.0/server-linux/zh-cn/csvguidelines.htm
source_site: help.tableau.com
content_type: documentation
content_hash: e18c89997e8d2f648166e1b99740c640693cc31677b1042bce2923b80f124dd0
description: CSV file format guidelines for bulk importing users into Tableau Cloud and Tableau Cloud Manager, with required columns.
---
[跳转到主要内容](#main-content)

# CSV 导入文件准则

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

本主题介绍 CSV 文件本身的详细信息。若要使用 CSV 导入用户，您可以：

- 使用服务器或站点管理页面。有关信息，请参见[导入用户](https://help.tableau.com/v0.0/server-linux/zh-cn/users_import.htm)。
- 使用 `tabcmd` 实用工具。有关信息，请参见 [createsiteusers filename.csv](https://help.tableau.com/v0.0/server-linux/zh-cn/tabcmd_cmd.htm#idd1b7729f-dd20-475a-96f6-17fcd2577894)。

您可以在站点或服务器级别导入用户。如果将用户导入到服务器（而不是导入特定站点），则不会将用户分配到站点，并且会以 Unlicensed 方式导入用户。

**注意：**除非另有说明，否则本主题中指定的准则适用于配置或未配置[身份池](https://help.tableau.com/v0.0/server-linux/zh-cn/identity_pools.htm)的 Tableau Server。

## CSV 文件格式要求

用于导入用户的 CSV 文件具有以下格式要求：

- 没有列标题。Tableau Server假定文件中的每一行代表一个用户。
- 只有在导入到站点时才支持带字节顺序标记 (BOM) 的 UTF-8 格式。如果要导入到 Tableau Cloud Manager，请使用 UTF-8 格式并从文件中移除任何 BOM。
    - 诸如 BIG-5 等字符编码必须转换为 UTF-8。可通过在文本编辑器中打开文件并使用“另存为”命令来达到此目的。
    - 如果 `@` 字符出现在除域分隔符以外的任何**用户名**字段中，则它必须为十六进制格式：`\0x40`。例如，`user@fremont@mycompany.com` 应该为 `user\0x40fremont@mycompany.com`。

## CSV 文件中所需的列结构

文件不应包含标题行。并非所有列都需要填写，但必须通过包括所有预期的逗号分隔符来保留所需的列结构。

列结构因产品和导入工具而异。确保使用适合您的环境的结构：

- **Tableau Cloud：**username、password、display name、license level、administrator level、publishing capability、email address
- **带有 Tableau Cloud Manager (TCM) 的 Tableau Cloud：**tenant or site URI、username, password、display name、license level、administrator level、publishing capability、email address、authentication type
- **Tableau Server：**username、password、display name、license level、admin level、publishing capability、email address
- **使用身份池的 Tableau Server：**username、password、display name、license level、admin level、publishing capability、email address、identity pool name、identifier

有关每列的可能值的详细信息，请参见下面的列详细信息部分。

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

## Tableau Server 的列详细信息

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

CSV 文件的列结构： `username, password, display name, license level, admin level, publishing capability, email address`

### 列详细信息 

**Username：**_必填_。用户的名称。

- 如果服务器配置为使用 Active Directory，则此值必须与 Active Directory 中定义的用户匹配。如果用户名在域之间不唯一，请包括域作为用户名的一部分（例如，`example\Adam` 或 `adam@example`）。
- 如果将用户添加到[身份池](https://help.tableau.com/v0.0/server-linux/zh-cn/identity_pools.htm)，请确保以下内容：

- 如果将用户添加到使用 AD 作为其身份存储的身份池，请确保使用 AD sAMAccountName 值作为用户名。
- 如果将用户添加到使用 LDAP 作为其身份存储的身份池，请确保使用 LDAP 用户名值作为用户名。

**Password：**用户的密码。此列是否为必需取决于服务器的配置：

- Local authentication：_必填_。从 Tableau Server 2024.2 开始强制要求 password 字段。有关详细信息，请参见[尝试通过 Tableau Server 2024.2 中的 tabcmd 添加用户时，出现意外的“errorCode=134”](https://help.salesforce.com/s/articleView?id=002277940&type=1)知识文章。
- Active Directory：_忽略_。作为最佳做法，请将此列留空。

**Display name：**显示名称是用于在服务器上标识用户的信息的一部分。是否使用此列取决于服务器的配置：

- Local authentication：如果用户的显示名称已在使用，Tableau Server 将使用 CSV 文件中的设置更新现有用户信息。
- Active Directory：_忽略_。作为最佳做法，请将此列留空。

**License level：**可以是**“Creator”**、**“Explorer”**、**“Viewer（查看者）”**或**“Unlicensed”**。

- 如果 license level 为 Creator，则 publishing capability 必须为 Yes/True/1
- 如果有基于用户的服务器安装，并且添加用户会超出许可证允许的用户数，则会以未许可用户形式添加用户。
- 如果使用 `tabcmd` 并指定许可证，但导入用户会超出许可证限制，则会以“未许可”用户方式导入用户。

**Administrator level：**可以是**“System”**、 **“Site”**或**“None”**，并确定是否以管理员形式导入用户。

- System = 服务器管理员，Site = 站点管理员，None = 非管理员。
- 如果未登录到特定站点，并且在服务器级别导入用户，则只能分配“服务器管理员”和 Unlicensed。
- 如果使用 Web UI 导入用户，则只有在服务器（所有站点）级别导入文件时，您才能将管理员站点角色设置为“System”。如果登录到特定站点，并且 CSV 文件中用户的管理员列设置为“System”，则 Tableau Server 将以站点管理员形式导入用户。

**Publishing capability：**可以是**“Yes/True/1”**或**“No/False/0”**。如果使用 Web UI，则只有在登录到特定站点的同时进行导入才会使用 publishing capability。

- 如果 license level 为 Creator，则 publishing capability 必须为 Yes/True/1
- 如果 license level 为 Explorer，则 publishing capability 值就是区分“Explorer（可发布）”和“Explorer”的站点角色的值
- 如果 license level 为 Viewer 或 Unlicensed，则无论此列的值如何，用户都将无法进行发布

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

任何留空的列仍必须用逗号分隔，以保留列结构。

### 身份池

如果将用户添加到身份池，除了标准列之外，还需要以下列：

CSV 文件的列结构： `username, password, display name, license level, admin level, publishing capability, email address, identity pool name, identifier`

其他列详细信息：

**Identity pool name：**您要将用户添加到其中的身份池的名称。如果您要将用户添加到身份池并且未指定身份池名称，则会将用户添加到初始池（TSM 配置），这是 Tableau Server 设置期间在 TSM 中预置的用户集。

**Identifier：**您要添加的用户的标识符。标识符仅用于身份匹配目的。有关详细信息，请参见[Tableau 中的用户名和标识符](https://help.tableau.com/v0.0/server-linux/zh-cn/identity_pools.htm#usernames_identifiers)。

- Local authentication：_可选_
- Active Directory or LDAP：_必填_

#### 使用身份池批量添加用户

您可以使用 CSV 导入过程来：

- 将用户批量添加到其他身份池。**注意：**您无法使用 CSV 导入过程将用户已所属的身份池替换为另一个身份池。如果您添加具有不同身份池值的现有用户，他们将被添加到该附加身份池中。
- 为还没有标识符的用户批量添加标识符。**注意：**如果您为同一池中的用户添加不同的标识符，它不会替换该用户的现有标识符。相反，将为该用户创建一个新的标识符记录。

### Tableau Server 的 CSV 导入示例

> [!TIP]
> 
> **提示**：请记住，结构为：`username, password, display name, license level, admin level, publishing capability, email address`。

以下示例显示了一个包含若干用户的信息的 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”站点角色。其中三个用户允许进行发布。
- 如果在管理服务器的同时导入此文件，则会向服务器中添加四个用户，但不会将它们添加到任何站点。只会导入一个用户作为服务器管理员；其余用户设置为 Unlicensed。

#### 身份池示例

> [!TIP]
> 
> **提示**：请记住，结构为：`username, password, display name, license level, admin level, publishing capability, email address, identity pool name, identifier`。

以下示例显示了一个 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

### 提高通过 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 createsiteusers`、`deletesiteusers`、`addusers` 和 `removeusers` 命令。

有关这些设置的说明，请参见[tsm configuration set 选项](https://help.tableau.com/v0.0/server-linux/zh-cn/cli_configuration-set_tsm.htm)。

## CSV 设置和站点角色

用户的许可证级别、管理员和发布设置确定如何在导入过程中设置用户的站点角色。下面介绍了应如何在 CSV 中捕获站点角色。

<table class="table--plain" style="width: 100%;"><colgroup><col style="width: 30%;"><col style="width: 30%;"><col style="width: 20%;"><col></colgroup><tbody><tr><td style="font-weight: bold;">站点角色</td><td style="font-weight: bold;">License level</td><td style="font-weight: bold;">Administrator level</td><td style="font-weight: bold;">Publishing capability</td></tr><tr><td><p><b>服务器管理员 </b></p><p><i>仅当您在管理服务器（即未登录到特定站点）的情况下导入用户时，此角色才有效。 </i></p></td><td>任何，但“服务器管理员”站点角色始终获得“Creator”许可证（如果有）。如果没有“Creator”许可证，请参见<a href="https://help.tableau.com/v0.0/server-linux/zh-cn/unlicensed.htm" class="xref">许可疑难解答</a>了解 Tableau Server 如何处理此情况。</td><td>System</td><td>True</td></tr><tr><td><p><b>站点管理员 Creator</b> 或<b>站点管理员 Explorer</b></p><p><i>仅当您在登录到特定站点的情况下导入用户时，这些角色才有效。</i></p></td><td>Creator 或 Explorer</td><td>Site</td><td>True</td></tr><tr><td><b>Creator</b></td><td>Creator</td><td>None</td><td>True</td></tr><tr><td><b>Explorer（可发布）</b></td><td>Explorer</td><td>None</td><td>True</td></tr><tr><td><b>Explorer</b></td><td>Explorer</td><td>None</td><td>False</td></tr><tr><td><b>Viewer（查看者）</b></td><td>Viewer（查看者）</td><td>None</td><td>False</td></tr><tr><td><b>Unlicensed</b></td><td>Unlicensed</td><td>None</td><td>False</td></tr></tbody></table>