set_member(ユーザの一括登録・変更)
機能
ユーザを一括して登録または変更します。
システム管理者および非ディレクトリユーザの登録・変更ができます。変更のあったユーザがコミュニティに属している場合は,メンバ情報も更新されます。
最初のシステム管理者は,このコマンドで登録します。
形式
set_member [-o 出力ファイル名] [-q] [-e ログファイル名] [-u 登録・変更ユーザ一覧ファイル名] [-s]
オプション
- -o 出力ファイル名
- 指定したファイルに標準出力データを出力します。ただし,出力メッセージのうち,KDCM00071-E~KDCM00076-Eは出力しません。
- 出力ファイル名の指定方法の詳細は,「5.2(3)-oオプションに指定する出力ファイル」を参照してください。
- -q
- 標準出力および標準エラー出力への出力を抑制します。
- -e ログファイル名
- 指定したログファイルに,次の情報を出力します。
- SQLクエリ発行直前および発行直後のSQLクエリ文字列
- SQLクエリ発行時のエラーメッセージ
- ログファイル名の指定方法の詳細は,「5.2(4)-eオプションに指定するログファイル」を参照してください。
- -u 登録・変更ユーザ一覧ファイル名
- 登録・変更ユーザ一覧ファイル(set_member.cfg)に定義されている内容をデータベースのユーザ情報テーブル(TBL_USER)に設定します。
- 登録・変更ユーザ一覧ファイルで指定されたすべてのユーザについて,各ユーザのユーザデータを登録または変更します。
- なお,-uオプションでユーザを登録または変更した場合,メンバ登録・変更通知などを通知するインタフェースをコールしません。
- ファイル名の指定方法
- 登録・変更ユーザ一覧ファイルのファイル名は,絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
- ファイルの記述形式
- 登録・変更ユーザ一覧ファイルの記述形式については,「7.2.6 登録・変更ユーザ一覧ファイル(set_member.cfg)」を参照してください。
- サンプルファイルの利用
- 登録・変更ユーザ一覧ファイルに,サンプルファイル(set_member.cfg.sam)を使用する場合,サンプルファイルの内容を使用する環境に合わせて変更し,ファイル名「set_member.cfg」で保存してください。
- -s
- set_member.cfgファイルに指定したuseridが兼任ユーザのIDかどうかをチェックします。兼任ユーザとは,本来所属している組織以外の組織に所属するユーザのことです。詳細は,マニュアル「Collaboration 導入ガイド」を参照してください。
- チェックの結果,兼任ユーザのIDである場合は,KDCM00078-Eのエラーメッセージが出力されます。ファイルに複数のユーザを指定している場合,エラーになる前までのユーザが登録されます。
- このオプションを指定した場合は,次のクラスパスを設定してください。
SET CLASSPATH=%COSMINEXUS_COLLABORATION_HOME%¥clb_home¥conf;%CLASSPATH%
SET CLASSPATH=%COSMINEXUS_COLLABORATION_HOME%¥clb_home¥lib¥hptl_clb_cum.jar;%CLASSPATH%
SET CLASSPATH=%COSMINEXUS_COLLABORATION_HOME%¥clb_home¥lib¥hptl_clb_ccu.jar;%CLASSPATH%
- このオプションは,Collaboration - Directory Accessで兼任機能を使用するよう設定されている場合に有効となります。また,指定したユーザがディレクトリサーバに登録されていない場合は,エラーにならないで処理が続行されます。Collaboration - Directory Accessの設定については,「Collaboration - Directory Access システム管理者ガイド」を参照してください。
戻り値
set_memberコマンドの戻り値を次に示します。
表5-7 set_memberコマンドの戻り値
戻り値 | 意味 |
---|
0 | 正常終了しました。 |
1 | ユーザによる強制終了が発生したか,またはコマンド用jarが見つかりません。 |
2 | 指定した登録・変更ユーザ一覧ファイル,またはhptl_clb_ccm_cmd.propertiesが見つかりません。 出力ファイル,またはログファイルを生成できません。 |
3 | 必要なオプションが指定されていません。 |
12 | 出力ファイル名,ログファイル名,または登録・変更ユーザ一覧ファイル名が長過ぎます。 |
13 | 登録・変更ユーザ一覧ファイルの書式にエラーがあります。 |
14 | 登録・変更ユーザ一覧ファイルまたはhptl_clb_ccm_cmd.propertiesの属性値が適切な範囲にありません。 |
21 | データベースからの応答がありません。 |
22 | データベースへの接続に失敗しました。 |
23 | SQLクエリの実行に失敗しました。 |
24 | JDBCドライバがインストールされていません。または,パスが通っていません。 |
31 | 入出力処理中にエラーが発生しました。 |
32 | トレース処理中にエラーが発生しました。 |
33 | コマンドの書式が違います。 |
34 | システム情報の取得に失敗しました。 |
35 | nullが指定されました。 |
36 | 内部矛盾が発生しました。 |
39 | 次の意味が考えられます。
- コマンドが実行できる状態ではありません。
- 環境変数が設定されていません。
- システムコールでエラーが発生しました。
|
41 | 指定したユーザのIDが兼任ユーザのIDです。 |
42 | Collaboration - Directory Accessでエラーが発生しました。 |
43 | 必要なjarファイルが見つかりません。 |
実行結果
データベースのメンバ情報テーブル(TBL_MEMBER),およびユーザ情報テーブル(TBL_USER)の内容が変更されます。
使用例
set_memberコマンドの使用例を紹介します。ここでは,次のような環境を想定しています。
- ソフトウェア環境
set_memberコマンドを実行できる環境
- コマンドプロンプトのカレントディレクトリ
<Collaboration - Serverインストールディレクトリ>¥community¥command¥bin
- 登録・変更ユーザ一覧ファイル
C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥set_member.cfg
- 登録・変更ユーザ一覧ファイルの内容を基に登録・変更する場合
- 登録・変更ユーザ一覧ファイルの内容を基にユーザを登録または変更する場合,set_memberコマンドを次のように実行します。
set_member -e "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥log¥set_member.log" -u "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥set_member.cfg" |
- この実行例では,set_memberコマンドを実行すると,エラーログがある場合は-eオプションで指定したログファイル(set_member.log)に出力されます。
- 実行例は改行されているように表示されていますが,実際に実行するときは,1行で記述する必要があります。
- 標準出力に何も出力しない場合
- ログをデフォルトのログファイルに出力する場合,set_memberコマンドを次のように実行します。
set_member -q -u C:¥set_member.cfg |
- この実行例は,あらかじめコマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーの設定値に,ログファイルとしてC:¥Program Files¥Hitachi¥Collaboration¥community¥log¥error_set_member.logを指定していることを想定しています。
注意事項
- set_memberコマンドの実行中にエラーが発生した場合,必ず,set_memberコマンドを再実行して,ユーザが登録または変更されていることを[コミュニティ管理]ポートレットで確認してください。
- set_memberコマンドは,登録・変更ユーザ一覧ファイルに不正な属性記述子が記述されている場合,メッセージ(KDCM00002-W)を出力して正常終了します。メッセージに表示された属性記述子を含むレコードはデータベースに登録されていないため,メッセージが出力されなくなるまで再実行してください。
- 誤って兼任ユーザのIDをset_memberに指定し,チェックをしないで登録してしまった場合は,del_memberコマンドを実行してユーザを削除してください。