CSV 匯入檔案指導方針
透過建立含有使用者資訊的逗號分隔值 (CSV) 檔案,然後匯入該檔案,即可大量新增使用者。您可以在 CSV 檔案中包括屬性(例如授權層級和發佈存取權限),以便在匯入這些屬性的同時將它們應用於使用者。
此主題涵蓋 CSV 檔案本身詳情。要使用 CSV 匯入使用者,您可以:
- 使用伺服器或站台管理頁面。詳情請參閱匯入使用者。
- 使用
tabcmd
公用程式。有關資訊,請參閱 createsiteusers filename.csv。
您可以在網站或伺服器層級匯入使用者。如果將使用者匯入到伺服器(而不是匯入特定網站),則不會將使用者指派到網站,並且會以「未授權」方式匯入使用者。
附註:除非另有說明,否則本主題中指定的指導方針對已設定或未設定身分集區(連結在新視窗開啟)的 Tableau Server 均適用。
CSV 檔案格式要求
用於匯入使用者的 CSV 檔案有以下格式要求:
- 無欄標題。Tableau Server假定檔案中的每一行代表一個使用者。
- 含位元組順序標記 (BOM) 的 UTF-8 格式。
- 諸如 BIG-5 等字元編碼必須轉換為 UTF-8。可透過在文字編輯器中開啟檔並使用「另存新檔」命令來達到此目的。
- 如果
@
出現在 username 欄位,但不是網域分隔符,則必須使用十六進位格式:\0x40
。例如,user@fremont@mycompany.com
應為user\0x40fremont@mycompany.com
。
該檔案不應包含標題列。不需要填寫所有欄,但必須保留必填欄結構,即包含所有預期的逗號分隔符。
不同產品以及匯入工具的欄結構各異。請確保為您的環境使用適當的結構:
- Tableau Cloud:username email, password, display name, license level, administrator level, publishing capability
- 配備 ableau Cloud Manager 的 Tableau Cloud:username email, password, display name, license level, administrator level, publishing capability, 驗證類型
- 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
請參閱以下欄詳情部分了解每個欄可能值的更多資訊。
重要提示:欄的順序至關重要。將第一列視為使用者名,將第二列視為密碼,將第三列視為顯示名稱等等,而不考慮列中的內容。如果忽略欄位的值,您必須仍然包括欄位的逗號分隔符號。
Tableau Server 欄詳情
附註:如果未登入到具體站台,並且在伺服器層級匯入使用者,則只能指派「伺服器管理員」和「未授權」站台角色。
CSV 檔案中的欄結構:username, password, display name, license level, admin level, publishing capability, email address
:
欄詳情:
使用者名稱:必填項。該使用者的名稱。
- 如果伺服器設定為使用 Active Directory,則此值必須與 Active Directory 中定義的使用者相符。如果該使用者名稱在網域間不唯一,則必須使用者名稱中必須包含網域(例如,
example\Adam
或adam@example
)。 - 若要將使用者新增到身分集區(連結在新視窗開啟),請確保以下內容:
- 如果將使用者新增至使用 AD 作為其識別身分存放區的身分識別集區中,請確保使用 AD sAMAccountName 值作為使用者名稱。
- 如果將使用者新增至使用 LDAP 作為其識別身分存放區的身分識別集區中,請確保使用 LDAP 使用者名稱值作為使用者名稱。
密碼:使用者的密碼。此欄是否為必填項取決於伺服器設定:
- 本機驗證:必填項。從 Tableau Server 2024.2 開始強制執行必填密碼欄位。有關詳細資訊,請參閱 Knowledge 文章在 Tableau Server 2024.2 中嘗試透過 tabcmd 新增使用者時出現意外的「errorCode=134」。
- Active Directory:已忽略。最佳實作是將此欄留為空白。
顯示名稱:顯示名稱是伺服器上用於識別使用者的資訊的一部分。此欄是否為必填項取決於伺服器設定:
- 本機驗證:如果使用者的顯示名稱已在使用,Tableau Server 將使用 CSV 檔案中的設定更新現有使用者資訊。
- Active Directory:已忽略。最佳實作是將此欄留為空白。
授權層級:此欄可以是「Creator」、「Explorer」、「Viewer」或「未授權」。
- 如果授權層級為 Creator,則發佈能力必須為 Yes/True/1
- 如果有基於使用者的伺服器安裝,並且新增使用者會超出授權允許的使用者數,則會以未授權使用者形式新增使用者。
- 如果使用
tabcmd
並指定授權,但匯入使用者會超出授權限制,則會作為未授權使用者匯入使用者。
管理員層級:該欄可以是「System」、「Site」或者「None」,並確定是否作為管理員匯入該使用者。
- System = 伺服器管理員,Site = 站台管理員,None = 非管理員。
- 如果未登入具體站台,並且在伺服器層級匯入使用者,則只能指派「Server Administrator」和「Unlicensed」。
- 如果使用 Web UI 匯入使用者,則只有在伺服器(所有網站)層級匯入檔時,您才能將管理員網站角色設定為「System」。如果登入具體站台,並且 CSV 檔案中使用者的管理員列設定為「System」,則 Tableau Server 將以站台管理員形式匯入使用者。
發佈功能:此欄可以是「Yes/True/1」或者「No/False/0」。如果使用 Web UI,則只有在登入到具體站台的同時進行匯入才會使用發佈功能。
- 如果授權層級為 Creator,則發佈能力必須為 Yes/True/1
- 如果授權層級為 Explorer,則發佈功能值可以區分 Explorer (可發佈) 與 Explorer 的站台角色值。
- 如果授權層級為 Viewer 或者 Unlicensed,則使用者將無法發佈,無論此欄的值是什麼。
電子郵件地址:電子郵件地址是伺服器上用於識別使用者的資訊的一部分。如果電子郵件地址已在使用,Tableau Server 將使用 CSV 檔案中的設定更新現有使用者資訊。
任何留為空白的欄仍必須使用逗號分隔以保留該欄結構。
身分集區
要在身分集區中新增使用者,除上述標準欄外,還需要以下欄:
CSV 檔案中的欄結構:username, password, display name, license level, admin level, publishing capability, email address, identity pool name, identifier
:
附加欄詳情:
身分集區名稱。要新增使用者的身分集區的名稱。若要將使用者新增到身分集區並且未指定身分集區名稱,則使用者會新增到初始集區(已設定 TSM),這是在 Tableau Server 設定期間在 TSM 中佈建的使用者集。
識別碼。要新增使用者的識別碼。識別碼僅用於身分比對目的。有關詳情,請參閱Tableau 中的使用者名稱和識別碼。
- 本機驗證:選用
- Active Directory 或 LDAP:必填項
使用身分集區中大量新增使用者
您可以使用 CSV 匯入過程:
- 在其他身分集區中大量新增使用者。附註:不能使用 CSV 匯入過程使用另一個身分集區取代使用者所屬的身分集區。如果新增具有不同身分集區值的現有使用者,則會將其新增至該附加身分集區。
- 為尚未沒有識別碼的使用者大量新增識別碼。附註:如果為同一集區中的使用者新增不同的識別碼,則不會取代該使用者的現有識別碼。相反,將為該使用者建立新的識別碼記錄。
用於 Tableau Server 的 CSV 匯入範例
提示:請記住,該結構為: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」站台角色。其中三個使用者允許進行發佈。 - 如果在管理伺服器的同時匯入此檔案,則會向伺服器中新增四個使用者,但不會將它們新增到任何網站。只會匯入一個使用者作為伺服器管理員;其餘使用者設定為「未授權」。
身分集區範例
提示:請記住,該結構為: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
附註:這些設定適用於 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 選項。
CSV 設定和網站角色
使用者的授權層級、管理員和發佈設定確定如何在匯入過程中設定使用者的網站角色。以下演示了如何在 CSV 中擷取站台角色。
站台角色 | 授權層級。 | 管理員層級。 | 發佈功能。 |
伺服器管理員 只有在管理伺服器(即未登入具體站台)時匯入使用者的情況下,此角色才有效。 | 「伺服器管理員」站台角色始終獲得「Creator」授權(如果有)。如果沒有「Creator」授權,請參閱授權疑難排解瞭解 Tableau Server 如何處理此情況。 | 系統 | True |
站台管理員 Creator 或 站台管理員 Explorer 只有在登入到具體站台的同時匯入使用者,這些角色才有效。 | Creator 或者 Explorer | 站台 | True |
Creator | Creator | 無 | True |
Explorer (可發佈) | Explorer | 無 | True |
Explorer | Explorer | 無 | False |
Viewer | Viewer | 無 | False |
未授權 | 未授權 | 無 | False |