ページの先頭行へ戻る
Interstage Interaction Manager V10 ポータル 運用ガイド
Interstage
付録A コマンド > A.2 CSVファイルの種別と書式
前次

A.2 CSVファイルの種別と書式

ここでは、利用者情報管理コマンドで利用するCSVファイルの種別と書式について説明します。

CSVファイルの種別

利用者情報の各情報に対して、それぞれ1つのCSVファイルが対応します。以下に、利用者情報に対応するCSVファイルを示します。

利用者情報

CSVファイル

ユーザー

User.csv

グループ

Group.csv

ロール

Role.csv

グループの所属ユーザー

Group-User.csv

ロールの所属メンバー

Role-Member.csv

CSVファイルの書式

CSVファイルの1行目はヘッダー行で、カラム名(フィールド属性名)を示します。CSVファイルの種別によって、有効なカラムが異なります。有効なカラム名については、exportの出力結果で確認することもできます。

注意

  • CSVファイルは、文字コードUTF-8で保存してください。

  • カラムに指定する値は、そのまま記述するか、ダブルクォーテーション(")で囲んで記述してください。
    ただし、カンマを含む値の場合は、値全体をダブルクォーテーション(")で囲んで記述する必要があります。
    例えば、User.csvのpurviewカラムに、systemとgroupをカンマ区切りで指定する場合は、以下のように記述します。

    "system,group"

  • 空文字列を指定する場合は、以下のどちらかの方法で記述してください。

    • カンマの間に値を1文字も記述しない
      以下にidカラムに空文字を指定する例を示します。

      "id","groupName","description","parentGroup.id"
,"group1","グループ1","34"

    • ダブルクォーテーション(")を2つ記述する
      以下にidカラムに空文字を指定する例を示します。

      "id","groupName","description","parentGroup.id"
"","group1","グループ1","34"

  • シャープ(#)から始まる行はコメントとみなされ、その1行は無視されます。
    以下に例を示します。

    #"12","group1","グループ1","34"

以下に、各CSVファイルのカラムを示します。カラムの順番は任意です。

User.csv

カラム名

説明

指定可能な値

必須
(注1)

id

オブジェクトを特定するオブジェクトID
User.csv内で一意です。
importで指定した場合は、対象のオブジェクトが更新されます。importで本カラムの値に空文字列を指定した場合は、新規登録となります。
本IDは、グループの所属ユーザーを示すのにも利用されます。
-byuseridオプション指定時は、本カラムは指定できません。

数値

○

userId

ユーザーID
システムで一意です。

<>"&*/:|?\,と半角空白とタブコードを除く半角英数字(ASCII文字)
64文字以下

○

password

パスワード
exportでは出力されません。

認証種別がInteraction Manager認証の場合に、本カラムを指定せずにユーザーを作成した場合、そのユーザーでポータルにログインできません。ログインするためには、パスワードの設定が必要となります。
認証種別がLDAPまたはActive Directoryの場合に、本カラムを指定しても値は利用されません。

",と半角空白とタブコードを除く半角英数字(ASCII文字)
64文字以下

－

userName

ユーザー名

<>"&を除くすべての文字列(全角文字と半角文字は混在可能)
64文字以下
空白(半角空白、全角空白、タブコード)だけの文字列は指定できません。

○

userLevel

利用者の区別
一般利用者か管理者かを区別します。

以下のどちらかの値
・ user：一般利用者
・ admin：管理者

○

purview

管理者の権限
システム管理者、グループ管理者、ロール管理者の権限を区別します。

以下の値(単数または複数指定可能)

userLevelがuserの場合：
・ user：一般利用者

userLevelがadminの場合：
・ system：システム管理者
・ group：グループ管理者
・ role：ロール管理者
複数指定する場合はカンマ(,)で区切ります。

○

account_state

アカウントのロック状態

以下のどれかの値
・ normal：ロックされていない状態
・ locked：ロックされている状態
・ lockednow：一時ロックされている状態

○

ui_language

ユーザーの言語種別
新規登録時に本カラムを指定しない場合、デフォルトで、管理コンソールの[レイアウトと基本情報]の[言語の設定]で定義されている言語が設定されます。

以下のどちらかの値
・ JAPANESE：日本語
・ ENGLISH：英語

－

拡張項目名
(注2)

拡張項目の値
ユーザー情報としてDBに持つ固有の拡張項目(カスタムフィールド)です。

拡張項目の定義属性に従った値 (注3)

○
(注4)

○：必須、－：省略可能

注1) 新規登録時の必須カラムを示します。更新時は、idカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、idカラムだけが必須で、それ以外に指定されたカラムは無視されます。なお、-byuseridオプションの指定時は、idカラムの代わりに、userIdカラムが必須カラムとなります。
注2) 管理コンソールで、ポリシーのユーザー情報として定義されている拡張項目の項目名です。利用者情報管理コマンドを利用して、新規に拡張項目を追加することはできません。
注3) 値の文字種と文字数については、「2.4.2 ポリシー」を参照してください。
注4) 拡張項目の定義が必須となっている場合は、カラムの指定も必須です。

記述例)

"id","userId","password","userName","userLevel","purview","account_state","ui_language","email","phone"...
"57","user1","password1","user001","admin","system,group","normal","JAPANESE","email01@example.com","0123456789"...
"132","user2","password2","user002","user","user","locked","ENGLISH","email02@example.com","1234567890"...

注意

管理コンソールで拡張項目の項目名として、User.csvのカラム名と同じ文字列を設定した場合、利用者情報管理コマンドでは以下のように処理されます。

  • exportの場合

    利用者情報管理コマンドでは、上記の表の順番でカラムが出力されます。
    以下に、「userLevel」という項目名の拡張項目が設定されている場合の出力例を示します。

    "id","userId","password","userName","userLevel","purview","account_state","ui_language","userLevel"

    この例では、1つ目のuserLevelカラムが「利用者の区別」のカラムで、2つ目のuserLevelカラムが拡張項目に対応します。

  • importの場合
    importで指定するUser.csvに同名のカラムが存在するかどうかで、以下のように処理が異なります。

    • 同名のカラムが存在するとき
      同名の2つのカラムのうち、1つ目のカラムがユーザーの基本的な項目とみなされ、2つ目のカラムが拡張項目とみなされます。

    • 同名のカラムが存在しないとき
      idやuserLevelなどのカラムは、同名の拡張項目が設定されていても、拡張項目のカラムとはみなされずに、ユーザーの基本的な項目のカラムとみなされます。

Group.csv

カラム名

説明

指定可能な値

必須
(注)

id

オブジェクトを特定するオブジェクトID
Group.csv内で一意です。
importで指定した場合は、対象のオブジェクトが更新されます。importで本カラムの値に空文字列を指定した場合は、新規登録となります。
本IDは、親グループ、ユーザーが所属するグループ、ロールに所属するグループを示すのにも利用されます。

数値

○

groupName

グループ名

<>"&を除くすべての文字列(全角文字と半角文字は混在可能)
64文字以下
空白(半角空白、全角空白、タブコード)だけの文字列は指定できません。

○

description

グループの説明

<>"&を除くすべての文字列(全角文字と半角文字は混在可能)
128文字以下
空白(半角空白、全角空白、タブコード、改行コード)だけの文字列は指定できません。

－

parentGroup.id

親グループのオブジェクトID
親グループをなしにする場合は、空文字列を指定します。
新規登録時に本カラムを指定しない場合、デフォルトで親グループなしとなります。

数値

－

○：必須、－：省略可能

注) 新規登録時の必須カラムを示します。更新時は、idカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、idカラムだけが必須で、それ以外に指定されたカラムは無視されます。

記述例)

"id","groupName","description","parentGroup.id"
"12","group1","グループ1","34"
"46","group2","グループ2","57"
Role.csv

カラム名

説明

指定可能な値

必須
(注)

id

オブジェクトを特定するオブジェクトID
Role.csv内で一意です。
importで指定した場合は、対象のオブジェクトが更新されます。importで本カラムの値に空文字列を指定した場合は、新規登録となります。
本IDは、グループが所属するロールを示すのにも利用されます。

数値

○

role_name

ロール名

<>"&を除くすべての文字列(全角文字と半角文字は混在可能)
64文字以下
空白(半角空白、全角空白、タブコード)だけの文字列は指定できません。

○

role_description

ロールの説明

<>"&を除くすべての文字列(全角文字と半角文字は混在可能)
128文字以下
空白(半角空白、全角空白、タブコード、改行コード)だけの文字列は指定できません。

－

role_priority

ロールの優先度
ロール優先度をクリアする場合は、空文字列を指定します。
新規登録時に本カラムを指定しない場合、デフォルトで指定なしとなります。

数値(0～9999)

－

publishRole

ロールの公開
一般利用者に公開するかどうかを区別します。
新規登録時に本カラムを指定しない場合、デフォルトで非公開となります。

以下のどちらかの値
・ true：公開
・ false：非公開

－

○：必須、－：省略可能

注) 新規登録時の必須カラムを示します。更新時は、idカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、idカラムだけが必須で、それ以外に指定されたカラムは無視されます。

記述例)

"id","role_name","role_description","role_priority","publishRole"
"34","role1","description1","12","false"
"45","role2","description2","23","true"
"78","role3","description3","34","false"
Group-User.csv

カラム名

説明

指定可能な値

必須

Group.id

関連付けるグループのオブジェクトID

数値

○

User.id

グループに所属するユーザーのオブジェクトID
グループに所属するすべてのユーザーをグループから削除する場合、deleteで本カラムの値に空文字列を指定します。
-byuseridオプション指定時は、本カラムは指定できません。

数値

○
(注)

userId

グループに所属するユーザーのユーザーID
グループに所属するすべてのユーザーをグループから削除する場合、deleteで本カラムの値に空文字列を指定します。
本カラムは、-byuseridオプション指定時に指定します。

<>"&*/:|?\,と半角空白とタブコードを除く半角英数字(ASCII文字)
64文字以下

○
(注)

○：必須

注) User.idカラムとuserIdカラムは、-byuseridオプションの指定に従って、どちらかを指定します。

記述例)

"Group.id","User.id"
"12","57"
"12","132"
"46","132"

ポイント

  • グループの所属ユーザーを追加する場合は、追加する情報をGroup-User.csvファイルに記述し、importで指定します。

  • グループの所属ユーザーをグループから削除する場合は、削除する情報をGroup-User.csvファイルに記述し、deleteで指定します。

Role-Member.csv

カラム名

説明

指定可能な値

必須

Role.id

関連付けるロールのオブジェクトID

数値

○

Member.type

ロールに所属するメンバーの種別

「Group」固定

○

Member.id

ロールに所属するグループのオブジェクトID
ロールに所属するすべてのグループを解除する場合、deleteで本カラムの値に空文字列を指定します。

数値

○

○：必須

記述例)

"Role.id","Member.type","Member.id"
"34","Group","12"
"34","Group","46"
"45","Group","132"

ポイント

  • ロールの所属グループを追加する場合は、追加する情報をRole-Member.csvファイルに記述し、importで指定します。

  • ロールの所属グループを解除する場合は、解除する情報をRole-Member.csvファイルに記述し、deleteで指定します。

前次
Copyright 2013 FUJITSU LIMITED