4.2.10 ユーザ定義ユティリティ
(1) Groupmax Workflow Serverの場合
ユーザ定義ユティリティは,Groupmax Address Serverと連携して,ワークフローデータベースの情報を更新するユティリティです。
ユーザ定義ユティリティを使用した運用については,「2.4.5 ユーザの設定」を参照してください。
コマンドの形式,終了コード及び注意事項を次に示します。
(a) WFregusrコマンド
コマンドの形式を次に示します。
WFregusr
[-y]
[-v]
[-k|-s[-k]|-c|-f ユーザID一覧ファイル名]
レポート形式例について,図中の番号ごとに説明します。
- ヘッダレコード第1行
実行バージョン及び実行ホスト名が表示されます。
- ヘッダレコード第2行
実行日付及び実行時間が表示されます。
- 区切りレコード
- 更新予告レコード
Groupmax Address ServerからWorkflowに通知された変更情報に基づいて,これ以降の行に更新予告が出力されます。
同一ユーザIDに対する複数の変更情報が存在する場合,変更の効果は累積されないで,それぞれ独立した更新情報として扱われます。
- USER句
USER句の次に,更新するユーザ情報が表示されます。
- ユーザ更新情報レコード
レコードフォーマットを次に示します。
ユーザID[Tab]更新内容
更新内容の部分には,ユーザ情報の更新内容が表示されます。
- Add
- ユーザが自ホストに追加されることを示します。
- Move Toホスト名
- 表示されたホストに,ユーザが移動することを示します。
- Change Toユーザ名
- 表示された名称に,ユーザ名が変更されることを示します。
- Update
- ユーザ名以外の情報が変更されることを示します。
- Delete
- ユーザが削除されることを示します。
- Delete(Only Relation Maintenance)
- 他ホストのユーザの削除に伴って,リレーションがメンテナンスされることを示します。
- LinkedBpNode句
削除又は移動対象のユーザが直接リンクされている,旧バージョンの作業机の情報を出力します。この情報が出力されているときは,該当するユーザを削除又は移動できません。レコードフォーマットを次に示します。
LinkedBpNode BPName:ビジネスプロセス定義名[Tab]Ver:ビジネスプロセス定義バージョン[Tab]NodeName:作業机名
- CASE句
削除又は移動対象のユーザのユーザトレーにある案件の情報を出力します。レコードフォーマットを次に示します。
CASE BPName:ビジネスプロセス定義名[Tab]Ver:ビジネスプロセス定義バージョン[Tab]WorkID:ワークID[Tab]Reason:移動不可要因
- 移動不可要因を次に示します。空白の場合は,移動先のユーザトレーに自動的に転送されることを示します。
- Deleted
- ユーザが削除されたことを示します。
- V1BP
- 旧バージョンのビジネスプロセス定義の案件であることを示します。
- NotDistributed
- ユーザの移動先となるサーバに,ビジネスプロセス定義が配布されていないことを示します。
- 更新予告レコード
Groupmax Address Server登録情報とワークフローデータベースとの相違に基づいて,これ以降の行に更新予告が出力されます。
- -f ユーザID一覧ファイル名
Groupmax Address Serverとの間で,特定のユーザ情報について同期処理をします。-sオプションがすべてのユーザ情報を更新するのに対して,-fオプションは,設定されたファイル内に記述された,ユーザIDに対応するユーザ情報だけを対象に更新します。-fオプションは,ユーザ数が多いときなどに効果的です。特定のユーザ情報について同期処理をすることで,最小限の時間で同期処理を実行できます。
1バイトから250バイトまでの文字列で設定します。
ユーザID一覧ファイルの記述規則を次に示します。
- 頭文字が「#(半角)」の行はコメントとして認識されます。
- 空白でもタブでもない最初の文字から,次の空白,タブ,改行又はEOFまでがユーザIDとして認識されます。
- ユーザIDとして認識された文字列がユーザIDの記述規則に反している場合,記述規則に反しているユーザIDのある行は無視されます。
- 同一のユーザIDがファイル内で複数回設定された場合,2回目以降のユーザIDは無視されます。
ユーザID一覧ファイルの記述例を次に示します。
#ユーザID一覧開始
user01
user02
user03
#ユーザID一覧終了
ユーザID一覧ファイルの記述規則の詳細については,マニュアル「Groupmax Address/Mail Version 6 システム管理者ガイド 基本操作編」(Windows用)又は,マニュアル「Groupmax Address/Mail Version 7 システム管理者ガイド 基本操作編」(Windows用)を参照してください。
(b) ユーザ定義ユティリティの終了コード
コマンド終了時に返される終了コードを次に示します。
- -yオプション指定なしの場合
- 0
- 正常終了
- -1
- 異常終了
- ユティリティの処理を継続できないエラーの発生によって,ユティリティの実行が中断されたことを示します。エラーの詳細は,該当するユティリティ実行中のイベントログを参照してください。
- -2
- 異常終了(継続できるエラー)
- 現在実行中のユーザの処理を中止し,次ユーザ以降の処理を継続できるレベルのエラーが1回以上発生したことを示します。エラーの詳細は,該当するユティリティ実行中のイベントログを参照してください。
- -yオプション指定ありの場合
- 0
- 正常終了
- 255
- 異常終了
- ユティリティの処理を継続できないエラーの発生によって,ユティリティの実行が中断されたことを示します。エラーの詳細は,該当するユティリティ実行中のイベントログを参照してください。
- 8
- 異常終了(継続できるエラー)
- 現在実行中のユーザの処理を中止し,次ユーザ以降の処理を継続できるレベルのエラーが1回以上発生したことを示します。エラーの詳細は,該当するユティリティ実行中のイベントログを参照してください。
(c) 注意事項
コマンドの実行時の注意事項を次に示します。
- このコマンドを実行できるのは,Administratorsグループ(ローカルログオン時)又はDomain Adminsグループ(ドメインログオン時)のユーザだけです。
- このコマンドは,Groupmax Object Server及びGroupmax Address Serverが起動している状態で実行してください。
- このコマンドは,ユーザ定義更新ユティリティ(WFdefusrコマンド)や,ユーザ定義情報出力ユティリティ(WFexpusrコマンド)と同時に実行できません。
- このコマンドは,Groupmax Workflow Definer,Groupmax Workflow - Specialist Tools for WWW,Groupmax Workflow Server - Library Extensionなどでの,ビジネスプロセス管理者の更新・業務ロールのユーザ更新などと同時に実行できません。
- このコマンドは,ワークフローディレクトリサービスが起動している状態で実行することをお勧めします。起動していない場合,ワークフローデータベースの情報は更新できますが,イベントログにKDWM6240-Eメッセージが出力されます。
- Groupmax Address Serverのユーザ情報を変更した直後は,変更通知データが出力されていない場合があります。Groupmax Address Serverに設定した変更通知データの出力間隔以上の時間が経過した後に,ユーザ定義ユティリティを実行してください。また,Groupmax Address Serverのユーザ情報を変更してから,ユーザ定義ユティリティを実行するまでの間は,Groupmax Address Serverで変更したユーザに対して,Workflow Server上でユーザ定義情報やロール定義情報の変更はしないでください。変更通知データが出力されていない状態でユーザ定義ユティリティを実行してしまうと,その後に変更したユーザ定義情報やロール定義情報が,変更通知データが遅れて反映されたときに削除されることがあります。
- ユーザ定義ユティリティの実行スケジュールは,Groupmax Address Serverのマスタ管理サーバ上での一括登録実行ユティリティ(gmaxset)の実行スケジュール,及び各ファイルサーバへのレプリケーション間隔を考慮して決定してください。
ユーザ定義ユティリティの実行スケジュールと,一括登録実行ユティリティの実行スケジュールの間隔が短すぎると,変更通知データが到着していない状態でユーザ定義ユティリティが実行され,次回の実行まで変更通知データが反映されないことがあります。
- Groupmax Address Serverでは,追加,変更のどちらの場合でも,設定できるのは,ユーザID及びユーザ名だけです。他の属性をデフォルト値以外の値に変更する場合は,Groupmax Workflow Definer及びGroupmax Workflow Monitor,又はユーザ定義更新ユティリティ(WFdefusrコマンド)を使用して変更してください。
- このコマンドでユーザを他サーバに移動する場合,移動先のサーバにビジネスプロセス定義が配布されていない案件は転送できないので,移動元サーバ内でビジネスプロセス定義に従って配布するトレーを再度決定し直します。この場合,ビジネスプロセスの定義内容によってはエラートレーに移動することもあります。サーバ移動後に対象ユーザが引き続き処理を行う必要がある案件が存在する場合は,該当するビジネスプロセス定義及びロールを移動先サーバに配布していることをユーザ移動実施前に確認してください。また,案件がエラートレーに移動したり,不特定のトレーに移動したりすることを避ける必要がある場合には,案件を特定のユーザ又はロールのトレーに振り替えてからユーザ移動を実施してください。
(2) Groupmax Workflow Server for Active Directoryの場合
ユーザ定義ユティリティは,Active Directory上のワークフローユーザの情報を基に,ワークフローキャッシュを構築し,Active Directoryとワークフローデータベースとの間のユーザ情報の整合性を確保するユティリティです。Active Directoryとワークフローデータベースとの間でユーザ情報にずれがある場合は,ワークフローデータベースのユーザ情報を更新することで整合性を確保します。ただし,Active Directoryのユーザ情報がワークフローユーザ登録の規則に違反している場合は,ワークフローデータベースへは反映しません。
なお,次の条件を満たしたものがActive Directory上のワークフローユーザとみなされます。
- 対象ドメイン定義ファイルで指定したドメインに所属するユーザである
- ワークフローユーザID(hitachiWFUserID)属性が設定されている
- Workflowサーバ名(hitachiWFServerNameList)属性に自サーバが含まれる
- ユーザプリンシパル名(userPrincipalName)属性が設定されている
整合性の確保によってユーザトレーが新規に作成される場合,属性のデフォルトは表4-6のようになります。
表4-6 ユーザトレーの属性のデフォルト
属性 | 値 |
---|
ユーザ権限 | 一般ユーザ |
案件受付状態 | 受付可能 |
ユーザヒストリ取得数 | 50※1 |
コメント | NULL |
ユーザ属性1 | NULL |
ユーザ属性2 | NULL |
GUID | Active Directory上のGUID※2 |
- 注※1
- 環境設定ユティリティによって,0~1023までの範囲で変更できます。
- 注※2
- GUID:Global Unique ID
(a) WFregusrコマンド
コマンドの形式を次に示します。
WFregusr
[-v]
[ { -s|-u ユーザID|-c } ]
レポート形式例について,図中の番号ごとに説明します。
- ヘッダレコード第1行
実行バージョン及び実行ホスト名が表示されます。
- ヘッダレコード第2行
実行日付及び実行時間が表示されます。
- 区切りレコード
- USER句
USER句の次に,更新するユーザ情報が表示されます。
- ユーザ更新情報レコード
レコードフォーマットを次に示します。
ユーザID[Tab]更新内容
更新内容の部分には,ユーザ情報の更新内容が表示されます。
- Add
- ユーザがワークフローデータベースに追加されることを示します。
- Delete
- ユーザがワークフローデータベースから削除されることを示します。
- Case句
削除又は移動対象のユーザのユーザトレーにあって再配布の対象となる案件の情報を出力します。レコードフォーマットを次に示します。
Case BPName:ビジネスプロセス定義名[Tab]Ver:'ビジネスプロセス定義バージョン'[Tab]WorkID:'ワークID'[Tab]reason:案件再配布要因
- 案件再配布要因を次に示します。
- Deleted
- ユーザが削除されたことを示します。
(b) ユーザ定義ユティリティの終了コード
コマンド終了時に返される終了コードを次に示します。
- 0
- 正常終了
- 255
- 異常終了
(c) 注意事項
コマンドの実行時の注意事項を次に示します。
- このコマンドを実行できるのは,Administratorsグループ(ローカルログオン時)又はDomain Adminsグループ(ドメインログオン時)のユーザだけです。
- このコマンドは,グローバルカタログサーバ及び対象ドメイン定義ファイルに指定したすべてのドメインのドメインコントローラを起動している状態で実行してください。
- このコマンドは,Groupmax Object Server及びワークフローディレクトリサービスが起動している状態で実行してください。ただし,-cオプションによる実行の場合は,ワークフローディレクトリサービスを起動しておく必要はありません。
- -uオプションを指定したユーザの削除は,整合性検証のため,ユーザの追加に比べて数倍以上の時間が掛かることがありますので注意してください。
- このコマンドでは,ユーザ属性のデフォルト値以外の変更はできません。ユーザ属性をデフォルト値以外に変更する場合は,ユーザ定義更新コマンド,Groupmax Workflow Definer又はGroupmax Workflow Monitorを使用してください。