4.2.11 ユーザ定義更新ユティリティ
ユーザ定義更新ユティリティは,ユーザに関する情報をファイルから一括で更新します。
このユティリティで更新できるユーザ情報は大きく分けて次の六つです。
- 案件受付状態
- ユーザヒストリの取得最大値
- ユーザに関するコメント
- ユーザ属性1
- ユーザ属性2
- 他の定義(権限管理,組織,業務ロール,ビジネスプロセス管理者,ロール定義管理者,代行配布ユーザ及び代行者)への関連
ユーザ定義更新ユティリティは,Windows NTのコマンドプロンプトでWFdefusrコマンドを使用して実行します。WFdefusrコマンドにあらかじめ更新情報を設定したファイルを指定して実行すると,ファイルに設定した情報のとおりにユーザ情報が更新されます。
更新情報のファイルは,ユーザ定義情報出力ユティリティで出力されたユーザ定義情報ファイルを利用して作成することもできます。ユーザ定義情報出力ユティリティの詳細は,「4.2.12 ユーザ定義情報出力ユティリティ」を参照してください。
コマンドの形式,終了コード,情報更新失敗と更新処理スキップの要因,及びコマンド実行時の注意事項を次に示します。
- <この項の構成>
- (1) WFdefusrコマンド
- (2) ユーザ定義更新ユティリティの終了コード
- (3) 情報更新失敗と更新処理スキップの要因
- (4) 注意事項
(1) WFdefusrコマンド
コマンドの形式を次に示します。
WFdefusr
-f ユーザ定義更新情報入力ファイル名
[-v]
[-l ユーザ定義更新ログ取得ファイル名]
[-e エラーメッセージ出力ファイル名]
- -f ユーザ定義更新情報入力ファイル名
更新するユーザ定義情報を設定・入力するファイルです。このオプションを省略することはできません。
ファイル名は完全パス名で,ドライブ名を含めて4バイトから250バイトまでの文字列で設定します。
ユーザ定義更新情報入力ファイルは,更新する情報が1レコードごとに次に示す形式で設定されている必要があります。
処理コード,ユーザID,更新対象コード,更新値1[,更新値2][,更新値3][,更新値4]
[,更新値5]
レコード指定時の注意事項を次に示します。
- 一つのレコードは,改行を含めて1,024バイト以下で設定します。
- 項目と項目は「,」(半角コンマ)で区切ります。ただし,項目の値中に「,」が入っている場合は項目を「"」(ダブルクォーテーション)で囲んでください。
- 「"」で囲まれていない項目の,値の前後の空白文字は無視されます。
次に,レコードの各項目について説明します。
- 処理コード
- 更新する情報の処理コードを半角の英大文字で設定します。処理コードには次の三つが設定できます。また,そのレコードがコメントである場合は,ここに「#(半角)」を設定します。
- C
- 属性情報を変更します。Cを設定すると,この後の「更新対象コード」に,STAT,HMAX,CMNT,ATR1,ATR2及びALLAが設定できます。
- A
- 他の定義との関連を設定します。Aを設定すると,後に設定する「更新対象コード」として,AUTH,ORG,CMP,ROLE,KEYV,BPAG,AGNT,BADM,BDST,RDEF及びRDSTが設定できます。BDST及びRDSTはGroupmax Address Serverを使用している場合に設定できます。
- D
- 他の定義との関連を削除します。Dを設定すると,AUTH,ORG,CMP,ROLE,KEYV,BPAG,AGNT,BADM,BDST,RDEF及びRDSTが設定できます。BDST及びRDSTはGroupmax Address Serverを使用している場合に設定できます。
- ユーザID
- 情報を更新するユーザのユーザIDを設定します。
- 更新対象コード
- 更新対象とする情報のコードを半角の英数字で設定します。設定できる更新対象コードと,それに対応する値(更新値1~5に設定する)については,表4-7を参照してください。
- 更新値1~更新値5
- 更新する値を設定します。値を更新値1~5のどこへ設定するかは更新対象コードによって異なります。どの更新値にどのような値を設定するかは,表4-7を参照してください。
表4-7 更新対象コードと更新値
更新対象コード | コードの意味 | 更新値に設定できる値 |
---|
STAT※4 | 案件受付状態の変更 | act,dea,inac※1の一つ(更新値1に設定)
- 注
- それぞれact(受付可能),dea(代行者配布),inac(受付禁止)を表す。
|
HMAX※4 | ユーザヒストリ最大数の 変更 | 範囲0~1023の値(更新値1に設定) |
CMNT※4 | コメントの変更 | コメント情報※2(更新値1に設定) |
ATR1※4 | ユーザ属性1の変更 | ユーザ属性1※2(更新値1に設定) |
ATR2※4 | ユーザ属性2の変更 | ユーザ属性2※2(更新値1に設定) |
ALLA※4 | 全属性の一括変更 | 案件受付状態(更新値1に設定) ユーザヒストリ最大数(更新値2に指定) コメント(更新値3に指定)※2 ユーザ属性1(更新値4に指定)※2 ユーザ属性2(更新値5に指定)※2 |
AUTH※5 | ユーザ権限の変更/削除 | domi,admi,wfm※1の一つ(更新値1に 設定)
- 注
- 処理コードにDを設定した場合は更新値には何も設定しない。
- それぞれdomi(ドメイン管理者),admi(ワークフロー運用管理者),wfm(ビジネスプロセス管理者)を表す。
|
ORG※5 | 組織へのアクセス権の追加/削除 | 組織ID(更新値1に設定) |
CMP※5 | 最上位組織へのアクセス権の追加/削除 | 最上位組織ID(更新値1に設定) |
ROLE※5 | 業務ロールへのユーザの追加/削除 | ロール名(更新値1に設定)※3 |
KEYV | 自動配布キーへの自動配布キー値の追加/削除 | ロール名(更新値1に設定)※3 自動配布キー名(更新値2に設定) 自動配布キー値(更新値3に設定)※6 |
BPAG※4 | 代行配布ユーザの変更/削除 | ビジネスプロセス定義名 (更新値1に設定)※3 代行配布ユーザID(更新値2に設定) |
AGNT※4 | 代行者の追加/削除 | 代行者ユーザID(更新値1に設定) |
BADM※5※7 | ビジネスプロセス管理者の追加※10/削除 | ビジネスプロセス定義名(更新値1に設定)※3 ビジネスプロセス定義バージョン又はALL(更新値2に設定)※9
- 注
- ビジネスプロセス定義バージョンにALLを設定した場合は,更新値1に指定したビジネスプロセス定義のすべてのバージョンを表す。
|
BDST※5※8 (Groupmax Address Serverの場合だけ) | ビジネスプロセス配布管理者の追加※10/削除 | ビジネスプロセス定義名(更新値1に設定)※3 ビジネスプロセス定義バージョン又はALL(更新値2に設定)※9
- 注
- ビジネスプロセス定義バージョンにALLを設定した場合は,更新値1に指定したビジネスプロセス定義のすべてのバージョンを表す。
|
RDEF※5※7 | ロール定義者の追加※10/削除 | ロール名(更新値1に設定)※3 |
RDST※5※8 (Groupmax Address Serverの場合だけ) | ロール配布管理者の追加※10/削除 | ロール名(更新値1に設定)※3 |
- 注※1
- 半角英小文字で設定します。
- 注※2
- 更新値を省略できます。省略した場合,その定義情報はクリアされます。また,設定する値に,タブ,「"」及び「^」は半角文字も全角文字も使用できません。
- 注※3
- 02-10以降のバージョンのGroupmax Workflow Definerから登録したビジネスプロセス,ロール,又はロール定義更新ユティリティから登録したロールだけが更新対象となります。
- 注※4
- この更新対象コードは,更新対象ユーザのユーザトレーが存在するサーバ(Workflowホームサーバ)で有効となります。
- 注※5
- この更新対象コードは,Workflow管理サーバで有効となります。
- 注※6
- 設定する値に,タブ,「"」及び「^」は半角文字も全角文字も使用できません。
- 注※7
- 指定するユーザIDはビジネスプロセス管理者(wfm)以上の権限が必要です。
- 注※8
- 指定するユーザIDはワークフロー運用管理者(admi)以上の権限が必要です。
- 注※9
- 指定するビジネスプロセス定義バージョンの前に0を指定した場合,その0は無視されます。
- 注※10
- 設定できるのは200人までです。
- -v
ユーザ定義更新ユティリティの実行の経過をメッセージとして,標準出力に出力します。
- -l ユーザ定義更新ログ取得ファイル名
ユーザ定義更新ユティリティの実行による更新の履歴を,指定したファイルに出力します。ファイル名は完全パス名で,ドライブ名を含めて4バイトから250バイトまでの文字列で設定します。次の文字は使用できません。
¥,/,:,,,;,*,?,",<,>,|
もし,ユーザ定義更新ユティリティの実行後にエラーとなった場合は,このユーザ定義更新ログ取得ファイルの内容を参照すればエラーの内容が分かります。また,このファイルは内容を加工することによって,ユーザ定義更新情報入力ファイルとして使うことができるので便利です。
更新ログの出力例を図4-4に示します。
図4-4 ユーザ定義更新ログ取得ファイルの出力例
![[図データ]](figure/zu04030c.gif)
出力例について図中の番号ごとに説明します。
- ヘッダレコード第1行
実行バージョン及び実行ホスト名が表示されます。
- ヘッダレコード第2行
実行日付及び実行時間が表示されます。
- ヘッダレコード第3行
ユーザ定義更新情報入力ファイル名が表示されます。
- 区切りレコード
- ユーザ情報更新履歴レコード
ユーザ定義情報の更新が成功したかどうか,及び更新内容が表示されます。
○印は「更新成功」,×印は「更新失敗」,無印は「更新処理スキップ」を示します。
レコード先頭の数字は,ユーザ定義更新情報入力ファイルの何番目のレコードかを示します。また,「更新失敗」の場合,エラーを検知した列番号が続けて表示されます。
「更新失敗」及び「更新処理スキップ」となる場合の要因については,「4.2.11(3) 情報更新失敗と更新処理スキップの要因」を参照してください。
- -e エラーメッセージ出力ファイル名
レコードフォーマットエラーなど,ユティリティの実行を継続できるエラーに対するメッセージを,指定したファイルに出力します。ファイル名は完全パス名で,ドライブ名を含めて4バイトから250バイトまでの文字列で設定します。次の文字は使用できません。
¥,/,:,,,;,*,?,",<,>,|
このオプションを省略した場合は,%WFdir%¥tmpにファイル名「_WFDEFU.NG」で出力します。「%WFdir%」はWorkflowインストール先ディレクトリを示します。
ここで設定したエラーメッセージ出力ファイルと同一名のファイルが既に存在する場合は,上書きして出力されます。前回実行時のエラーメッセージファイルを残したい場合は,次に示すような方法から適切な方法を選択してください。
- ユーザ定義更新ユティリティを実行するごとにエラーメッセージファイル名を変更する。
- 前回実行時のエラーメッセージファイルを他のディレクトリに移動する。
- 前回実行時のエラーメッセージファイルの名称を変更する。
(2) ユーザ定義更新ユティリティの終了コード
コマンド終了時に返される終了コードを次に示します。
- 0
- 正常終了
- 4
- 異常終了(継続できるエラー)
- 現在実行中のユーザの処理を中止し,次ユーザ以降の処理を継続できるレベルのエラーが1回以上発生したことを示します。エラーの詳細は,このユティリティのWFdefusrコマンドの-eオプションで指定するエラーメッセージ出力ファイルを参照してください。
- 255
- 異常終了
- ユティリティの処理を継続できないエラーの発生によって,ユティリティの実行が中断されたことを示します。エラーの詳細は,該当するユティリティ実行中のイベントログを参照してください。
(3) 情報更新失敗と更新処理スキップの要因
コマンドを実行した結果,ユーザ情報更新履歴レコードで「更新失敗」及び「更新処理スキップ」と表示された場合の要因を次に示します。これに従ってユーザ定義更新情報入力ファイルを修正し,再度実行してください。
(a) 更新失敗(×印)の要因
更新失敗の要因として考えられるエラーの内容を,レコードの列ごとに示します。ここでの「列」とは,ユーザ定義更新ログ取得ファイルの,レコード番号(図4-4での「1」及び「2-4」)の右の列を「1列目」として数えます。
- 1列目(処理コード指定欄)のエラー
- 2列目(ユーザID指定欄)のエラー
- 指定したユーザがGroupmax Address Server又はActive Directoryに登録されていない。
- 指定したユーザはGroupmax Address Server又はActive Directoryに登録されているが,Workflowサーバに設定されていない。
- 指定したユーザのユーザIDが「system」である。
- 3列目(更新対象コード指定欄)のエラー
- 処理コードが「C」であるのに,更新対象コードが「STAT」,「HMAX」,「CMNT」,「ATR1」,「ATR2」及び「ALLA」以外である。
- 処理コードが「A」又は「D」であるのに,更新対象コードが「AUTH」,「ORG」,「CMP」,「ROLE」,「KEYV」,「BPAG」,「AGNT」,「BADM」,「BDST」,「RDEF」又は「RDST」以外である。
- 更新対象コードが「BDST」又は「RDST」であるのに,指定されたユーザにはワークフロー運用管理者以上の権限がない。
- 更新対象コードが「BADM」又は「RDEF」であるのに,指定されたユーザにはビジネスプロセス管理者以上の権限がない。
- 4列目(更新値指定欄)のエラー
- 更新対象コードが「STAT」であるのに,更新値が「act」,「dea」及び「inac」以外である。
- 更新対象コードが「HMAX」であるのに,更新値が次のどれかである。
0~1023の半角数字でない。
指定文字数が10文字以内でない。
- 更新対象コードが「CMNT」であるのに,更新値が次のどれかである。
文字列長が127バイト以内でない。
文字列中に1バイトコード(半角)のタブ,「"」又は「^」が指定されている。
文字列中に2バイトコード(全角)の「"」又は「^」が指定されている。
- 更新対象コードが「ATR1」又は「ATR2」であるのに,更新値が次のどれかである。
文字列長が31バイト以内でない。
文字列中に1バイトコード(半角)のタブ,「"」又は「^」が指定されている。
文字列中に2バイトコード(全角)の「"」又は「^」が指定されている。
- 更新対象コードが「AUTH」であるのに,更新値が次のどれかである。
処理コードが「A」の場合
「domi」,「admi」及び「wfm」以外である。
「domi」又は「admi」から「wfm」への変更要求であるが,指定したユーザがビジネスプロセス配布管理者又はロール定義配布管理者である。
処理コードが「D」の場合
指定したユーザがビジネスプロセス管理者,ビジネスプロセス配布管理者,ロール定義者又はロール定義配布管理者である。
- 更新対象コードが「ORG」であるのに,更新値が次のどれかである。
指定した組織IDがGroupmax Address Server又はActive Directoryに登録されていない。
指定した組織IDの最上位組織IDが「GMAXSYS」である。
- 更新対象コードが「CMP」であるのに,更新値が次のどれかである。
指定した最上位組織IDがGroupmax Address Server又はActive Directoryに登録されていない。
指定した最上位組織IDが「GMAXSYS」である。
- 更新対象コードが「ROLE」であるのに,更新値が次のどれかである。
指定した業務ロールがワークフローデータベースにない。
指定した業務ロールは,02-10以降のバージョンのGroupmax Workflow Definer又はロール定義更新ユティリティから登録した業務ロールでない。
- 更新対象コードが「KEYV」であるのに,更新値が次のどれかである。
指定した業務ロールがワークフローデータベースにない。
指定した業務ロールは,02-10以降のバージョンのGroupmax Workflow Definer又はロール定義更新ユティリティから登録した業務ロールでない。
指定した自動配布キー名が指定した業務ロールにない。
指定した自動配布キー値の文字列の長さが31バイト以内でない。
指定した自動配布キー値の文字列の中に,1バイトコード(半角)のタブ,「"」又は「^」が指定されている。
指定した自動配布キー値の文字列の中に,2バイトコード(全角)の「"」又は「^」が指定されている。
- 更新対象コードが「BPAG」であるのに,更新値が次のどれかである。
指定したビジネスプロセス定義がワークフローデータベースにない。
指定したビジネスプロセス定義は,02-10以降のバージョンのGroupmax Workflow Definerから登録したビジネスプロセス定義でない。
指定した代行配布ユーザがGroupmax Address Server又はActive Directoryに登録されていない。
指定した代行配布ユーザはGroupmax Address Server又はActive Directoryに登録されているが,Workflowサーバに設定されていない。
指定した代行配布ユーザのユーザIDが「system」である。
- 更新対象コードが「AGNT」であるのに,更新値が次のどれかである。
指定した代行者がGroupmax Address Server又はActive Directoryに登録されていない。
指定した代行者はGroupmax Address Server又はActive Directoryに登録されているが,Workflowサーバに設定されていない。
指定した代行者のユーザIDが「system」である。
- 更新対象コードが「BADM」又は「BDST」であるのに,更新値が次のどれかである。
指定したビジネスプロセス定義がワークフローデータベースにない。
指定したビジネスプロセス定義は,02-10以降のバージョンのGroupmax Workflow Definerから登録したビジネスプロセス定義でない。
指定したビジネスプロセス定義バージョンのビジネスプロセス定義がワークフローデータベースにない。
指定したビジネスプロセス定義バージョンが,1以上の半角数字又は半角英文字の「ALL」以外である。
指定したビジネスプロセス定義バージョンが10文字以内でない。
設定するユーザが200人を超えている。
- 更新対象コードが「RDEF」又は「RDST」であるのに,更新値が次のどれかである。
指定したロールがワークフローデータベースにない。
指定したロールは,02-10以降のバージョンのGroupmax Workflow Definer又はロール定義更新ユティリティで登録したロールでない。
設定するユーザが200人を超えている。
- エラーが発生した列が特定できないエラー
- 処理コード,ユーザID,更新対象コード又は更新値が設定されていない。
- 指定文字列の定義フォーマットエラー。
- レコード長が1,024バイトを超えている。
- 更新処理中に資源の競合が発生した。
(b) 更新処理スキップ(無印)の要因
更新処理スキップの要因として考えられるエラーの内容を,次に示します。
- 更新対象コードが「STAT」,「HMAX」,「CMNT」,「ATR1」,「ATR2」,「ALLA」,「BPAG」又は「AGNT」であるのに,指定したユーザのユーザトレーがWFdefusrコマンドを実行したサーバにない
この場合,原因として以下の理由が考えられる。
- 指定したユーザのユーザトレーがWFdefusrコマンドを実行したサーバ以外のサーバに存在する。
- 指定したユーザを,WFdefusrコマンドを実行したサーバに登録及び移動したが,ユーザ定義ユティリティ(WFregusrコマンド)をまだ実行していない。
- 更新対象コードが「AUTH」,「ORG」,「CMP」,「ROLE」,「KEYV」,「BADM」,「BDST」,「RDEF」又は「RDST」であるのに,WFdefusrコマンドを実行したサーバがWorkflow管理サーバでない
(4) 注意事項
コマンド実行時の注意事項を次に示します。
- このコマンドを実行できるのは,Administratorsグループ(ローカルログオン時)又はDomain Adminsグループ(ドメインログオン時)のユーザだけです。
- このコマンドは,Groupmax Object Server及びGroupmax Address Serverを起動している状態で実行してください。Groupmax Workflow Server for Active Directoryの場合は,Groupmax Object Server及びワークフローディレクトリサービスを起動している状態で実行してください。
- このコマンドはユーザ定義ユティリティコマンド(WFregusr),ユーザ定義情報出力ユティリティコマンド(WFexpusr),ロール定義更新ユティリティコマンド(WFdefrl),及びロール定義情報出力ユティリティコマンド(WFexprl)と同時に実行できません。
- -fオプションで指定したファイルが存在しない場合,又はファイルにアクセス権がない場合,コマンドの実行を中止します。
- -lオプションで指定したファイルが既に存在する場合,コマンドの実行を中止します。
- -l及び-eオプションで指定したディレクトリが存在しない場合,又はディレクトリにアクセス権がない場合,コマンドの実行を中止します。
- このユティリティを,Groupmax Address Server又はActive Directoryのユーザ登録情報とWorkflowのユーザ登録情報(ワークフローデータベース)とに差異がある状態で実行すると,期待した更新結果が得られない場合があります。 Groupmax Address Server又はActive Directoryのユーザ登録情報を更新した場合は,必ずWorkflowのユーザ定義ユティリティ(WFregusrコマンド)を各サーバで実行してから,このユティリティを実行してください。
- ビジネスプロセス管理者又はビジネスプロセス配布管理者の追加/削除処理で,ビジネスプロセス定義バージョンに「ALL」を指定した場合,どれか一つのバージョンの更新処理に失敗すると,全バージョンの更新処理が無効となります。その場合,エラー情報が出力され,当該レコードの処理はスキップされます。