CSV インポート ファイルのガイドライン
ユーザー情報を格納したコンマ区切りの値 (CSV) ファイルを作成し、それをインポートすることによって、ユーザーを一括で追加できます。CSV ファイルには、ライセンス レベルやパブリッシュ アクセスなど、インポートと同時にユーザーに適用する属性を含めることができます。
このトピックでは、CSV ファイル自体の詳細について説明します。CSV を使用してユーザーをインポートするには、次の方法があります。
- サーバーまたはサイトの管理ページを使用します。詳細については、「ユーザーのインポート」を参照してください。
tabcmd
ユーティリティを使用します。詳細については、「createsiteusers filename.csv」を参照してください。
ユーザーはサイトまたはサーバーのレベルでインポートできます。ユーザーをサーバーに (特定サイトにではない) インポートする場合、ユーザーはサイトに割り当てされず、ライセンスなしとしてインポートされます。
注: 特に明記されていない限り、このトピックで指定されているガイドラインは、アイデンティティ プール(新しいウィンドウでリンクが開く)を構成時に使用したかどうかにかかわらず、Tableau Server に適用されます。
CSV ファイル形式の要件
ユーザーをインポートするための CSV ファイルには、次の書式要件があります。
- 列の見出しはありません。Tableau Serverファイル内の各行を 1 人のユーザーと見なします。
- バイト オーダー マーク (BOM) 付きの UTF-8 形式。
- BIG-5 などの文字エンコーディングは UTF-8 に変換する必要があります。この操作を行うには、テキスト エディターでファイルを開き、[名前を付けて保存] コマンドを使用します。
@
文字がドメイン セパレーター以外のユーザー名フィールドに存在する場合は、16 進形式 (\0x40
) にする必要があります。たとえば、user@fremont@mycompany.com
はuser\0x40fremont@mycompany.com
にする必要があります。
ファイルにはヘッダー行を含めないでください。すべての列に入力する必要はありませんが、すべてのコンマ区切り記号をそのまま含めることによって、必須の列構造を保持する必要があります。
列構造は、製品やインポート ツールによって異なります。環境に適した構造を使用していることを確認します。
- Tableau Cloud: ユーザー名 (メール)、パスワード、表示名、ライセンス レベル、管理者レベル、パブリッシュ機能
- Tableau Cloud Manager を使用する Tableau Cloud: ユーザー名 (メール)、パスワード、サイト URI、表示名、ライセンス レベル、管理者レベル、パブリッシュ機能、 認証タイプ
- Tableau Server: ユーザー名、パスワード、表示名、ライセンス レベル、管理者レベル、パブリッシュ権限、メール アドレス
- アイデンティティ プールを使用する Tableau Server: ユーザー名、パスワード、表示名、ライセンス レベル、管理者レベル、パブリッシュ機能、メール アドレス、アイデンティティ プール名、識別子
各列に指定できる値の詳細については、以下の「列の詳細」セクションを参照してください。
重要: 列の順序には重要な意味があります。列のコンテンツに関係なく、最初の列はユーザー名、2 番目の列はパスワード、3 番目の列は表示名などと表示されます。フィールドの値を省略する場合でも、フィールドのコンマ区切り記号は含める必要があります。
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 より、必須パスワード フィールドの適用が開始されました。詳細については、「Tableau Server 2024.2 で tabcmd 経由でユーザーを追加しようとすると、予期しない「errorCode=134」が発生する」のナレッジ記事を参照してください。
- Active Directory: 無視されます。ベスト プラクティスとして、この列は空白のままにします。
表示名: 表示名は、サーバー上のユーザーを識別するのに使用される情報の一部です。この列が使用されるかどうかは、サーバーの構成によって異なります。
- ローカル認証:ユーザーの表示名がすでに使用されている場合、Tableau Server は、CSV ファイル内の設定で既存のユーザー情報を更新します。
- Active Directory: 無視されます。ベスト プラクティスとして、この列は空白のままにします。
ライセンス レベル: Creator、Explorer、Viewer、またはライセンスなしのいずれかです。
- ライセンス レベルが Creator の場合、パブリッシュ機能は Yes/True/1 である必要があります。
- ユーザーベースのサーバーがインストールされていて、ユーザーを追加するとライセンスで許可されるユーザー数を超える場合は、ユーザーはライセンスなしのユーザーとして追加されます。
tabcmd
を使用し、ライセンスを指定しているものの、インポートするユーザーがライセンスの制限を超過する場合は、ユーザーはライセンスなしのユーザーとしてインポートされます。
管理者レベル: システム、サイト、または なしのいずれかであり、ユーザーが管理者としてインポートされるかどうかを決定します。
- システム = サーバー管理者、サイト = サイト管理者、なし = 管理者ではない、を示します。
- 特定のサイトにサインインしておらず、ユーザーをサーバー レベルでインポートしている場合は、サーバー管理者とライセンスなしのみを割り当てることができます。
- Web UI を使用してユーザーをインポートする場合、サーバー (全サイト) レベルでファイルのインポートを実行する場合にのみ、管理者サイト ロールをシステムに設定できます。特定のサイトにサインインしている場合、および CSV ファイル内のユーザーの管理者列がシステムに設定されている場合は、Tableau Server はユーザーをサイト管理者としてインポートします。
パブリッシュ機能: Yes/True/1 または No/False/0 のいずれかです。Web UI を使用している場合、特定のサイトにサインイン中にインポートする場合にのみパブリッシュ機能が使用されます。
- ライセンス レベルが Creator の場合、パブリッシュ機能は Yes/True/1 である必要があります。
- ライセンス レベルが Explorer の場合、パブリッシュ機能の値によって Explorer (パブリッシュ可能) と Explorer のサイト ロールが区別されます。
- ライセンス レベルが Viewer またはライセンスなしの場合、この列の値に関係なく、ユーザーはパブリッシュすることはできません。
メール アドレス: メール アドレスは、サーバー上のユーザーを識別するのに使用される情報の一部です。電子メール アドレスがすでに使用されている場合、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
- サイトを管理中にこのファイルをインポート場合、そのサイトに 4 人のユーザーが追加されます。ユーザー Michelle の
Administrator
設定はSystem
です。ただし、サイトにユーザーをインポートしているため、Tableau Server は Michelle をサイト管理者 Creator サイト ロールに設定します。ユーザーのうち 3 人はパブリッシュが許可されています。 - サーバーを管理中にこのファイルをインポート場合、そのサーバーに 4 人のユーザーが追加されますが、それらのユーザーはサイトには追加されません。1 ユーザーだけがサーバー管理者としてインポートされ、残りはライセンスなしに設定されます。
アイデンティティ プールの例
ヒント: 構造は username, password, display name, license level, admin level, publishing capability, email address, identity pool name, identifier
であることを忘れないでください。
次の例は、アイデンティティ プールに追加された 2 人のユーザーの情報を含む 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
次の例は、追加のアイデンティティ プールに追加された 2 人のユーザーの情報を含む 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
次の例は、既存の識別子を持たない 2 人のユーザーの情報を含む 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
基本的に、これらのオプションを 1 つずつサーバーのデータベースに追加していくのではなく、CSV ファイルを 1 つ処理した後にインデックスを作成します。これにより、データベースを呼び出す回数も、ファイルの処理に必要となるメモリも減ります。これらの 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 |