付録A.6 運用コマンドのパラメタファイル
(1) パラメタファイルの記述形式
パラメタファイルは,各オペランド名と,その指定値から構成されます。パラメタの形式を次に示します。括弧内は,ユーザがオペランドを省略した場合にシステムが取る標準値です。
オペランド名=指定値(省略値)
パラメタファイルを記述する場合の規則を次に示します。
- 頭文字が「#(半角)」の行は注釈行となり空行と認識されます。
- 一つのオペランドの記述が複数行にわたる場合は,継続させる行の行末に「¥(半角)」を記述してください。
- 一つのオペランドの長さは,以下のとおりです。
- WFanalyst_logコマンド
空白を含めて,17バイトから1,023バイトまでです。
- WFanalyst_resultコマンド
空白を含めて,2バイトから1,023バイトまでです。
- オペランド名が間違っている場合,指定値が記述されていない場合,及び同一オペランドを複数記述した場合は,コマンドは実行されません。
(2) WFanalyst_logコマンドのパラメタファイル
(a) 形 式
edit_log_type=メッセージ種別
(b) オペランド
- edit_log_type=メッセージ種別(ALL)
ワークフローログの編集対象となる処理の種別を指定します。指定値はすべて大文字で記述してください。指定値が複数の場合,コンマ(,)で区切って記述してください。ALLを指定すると,他の指定値は無視されます。
メッセージ種別の指定値及び意味を,表A-1に示します。
表A-1 メッセージ種別
メッセージ種別 | 意味 |
---|
ALL | すべての処理 |
BEGIN_WORK | ワークの生成 |
MOVE_ROOT_CASE | 案件の送付(ノード間の遷移) |
SEND_CONSULT_CASE | 相談する案件の相談ユーザへの送信 |
GO_ROOT_CASE | 案件遷移要求 |
SUSPEND_ROOT_CASE | 案件遷移の一時停止 |
SUSPEND_WORK | ワーク単位での案件遷移の一時停止 |
READY_ROOT_CASE | 案件遷移の再開始 |
READY_WORK | ワーク単位での案件遷移の再開始 |
PUT_ROOT_CASE | 案件の投入 |
CANCEL_WORK | ワークのキャンセル |
SEND_ANSWER_CASE | 相談された案件の回答 |
ROLE_TO_USER | ロールトレーからユーザトレーへの案件の移動 |
API_MSG | ログに出力したユーザデータ |
SEND_BACK_ROOT_CASE | 案件の差し戻し |
TAKE_BACK_ROOT_CASE | 案件の引き戻し |
END_OF_ROOT_CASE | 案件の遷移終了 |
END_OF_WORK | ワークの終了 |
(c) 記述例
# WFログ出力コマンド パラメタファイル
# 作成 1998年8月30日
edit_log_type = MOVE_ROOT_CASE,GO_ROOT_CASE,END_OF_ROOT_CASE,¥
END_OF_WORK
(d) 注意事項
コマンド実行時に,パラメタファイルの指定(-pオプション)が省略された場合,省略値(ALL)を仮定し,すべてのワークフローログを編集します。
(3) WFanalyst_resultコマンドのパラメタファイル
(a) 形 式
result_user=ユーザ稼働実績の集計要否
result_bp=ビジネスプロセス稼働実績の集計要否
analysis_type=集計期間の設定種別
time_table=タイムテーブル
day_table=日付テーブル
(b) オペランド
- result_user=ユーザ稼働実績の集計要否(ON)
ユーザの稼働実績を集計するかどうか指定します。
- ON
- ユーザ稼働実績を集計します。
- OFF
- ユーザ稼働実績を集計しません。
- result_bp=ビジネスプロセス稼働実績の集計要否(ON)
ビジネスプロセスの稼働実績を集計するかどうか指定します。
- ON
- ビジネスプロセス稼働実績を集計します。
- OFF
- ビジネスプロセス稼働実績を集計しません。
- analysis_type=集計期間の設定種別(EVERYDAY)
集計の対象となる期間を指定します。指定値は複数記述できません。
- EVERYDAY
- 毎日集計します。集計の範囲は,0時0分0秒から23時59分59秒までです。
- EVERYWEEK
- 毎週集計します。集計の範囲は,毎週月曜0時0分0秒から日曜23時59分59秒までです。
- EVERYMONTH
- 毎月集計します。集計範囲は,毎月1日0時0分0秒から31日23時59分59秒までです。
- TIMETABLE
- 任意に時間を区切って集計します。区切り方はtime_tableオペランドで指定します。
- DAYTABLE
- 任意に日付を区切って集計します。区切り方はday_tableオペランドで指定します。
- time_table=HH:MM-hh:mm
集計時間の範囲を指定します。指定値は,コンマ(,)で区切って複数記述できます。
- HH:MM-hh:mm
- 開始時刻及び終了時刻を,24時間制で指定します。00時00分から23時59分までの範囲で,「開始時間<終了時間」となるように指定してください。
このオペランドを指定する場合の注意事項を次に示します。
- 指定値を複数記述する場合,二つ目以降の時間の範囲が,それより前の時間の範囲と重ならないように注意してください。ただし,実際の集計に当たっては,集計終了時刻として指定された時間の1秒前までが,当該集計期間として処理されます。
- (例)time_table = 08:45-12:30,12:30-17:15
- この場合,12時30分00秒に発生したイベントは,2番目の集計範囲(12:30-17:15)に含まれます。
- time_tableでの指定期間外に発生したイベントは,その他の時間としてまとめて集計されます。
- (例)time_table =08:45-12:30,13:15-17:15,17:45-21:45
- この場合,1日を8時45分~12時30分,13時15分~17時15分,17時45分~21時45分,及び「その他」の四つの時間帯に分けて集計されます。
- day_table=YYYY/MM/DD/-yyyy/mm/dd
集計日時の範囲を指定します。指定値は,コンマ(,)で区切って複数記述できます。
- YYYY/MM/DD/-yyyy/mm/dd
- 開始日時及び終了日時を,「年(西暦)/月/日」の形式で指定します。1970年1月1日から2038年1月18日までの範囲で,「開始日時<終了日時」となるように指定してください。
このオペランドを指定する場合の注意事項を次に示します。
- 指定値を複数記述する場合,二つ目以降の日時の範囲が,それより前の日時の範囲と重ならないように注意してください。なお,実際の集計に当たっては,終了日時として指定した日の23時59分59秒までが当該集計期間として処理されます。
- (例)day_table =1998/07/21-1998/08/05,1998/08/06-1998/08/21
- 1998年8月5日23時59分59秒までに発生したイベントが,1番目の集計期間(1998/07/21-1998/08/05)に含まれます。
- day_tableでの指定期間外に発生したイベントは,その他の期間としてまとめて集計されます。
- (例)day_table =1998/07/21-1998/08/05,1998/08/06-1998/08/21
- この場合,1998年7月21日~1998年8月5日,1998年8月6日~1998年8月21日,及び「その他」の三つの期間に分けて集計されます。
(c) 記述例
- (例1)1日の業務実績を,午前,午後,定時後に分けて集計する場合
# 稼働実績集計コマンド パラメタファイル
analysis_type = TIMETABLE
time_table =08:45-12:30,13:15-17:15,17:45-21:45
- (例2)四半期単位での業務実績を集計する場合
# 稼働実績集計コマンド パラメタファイル
analysis_type = DAYTABLE
day_table = 1998/03/22-1998/06/21,1998/06/22-1998/09/21,¥
1998/09/22-1998/12/21,1998/12/22-1999/03/21
(d) 注意事項
- オペランドの指定が次のような場合には,コマンドは実行されません。
- analysis_typeオぺランドの指定値にTIMETABLE以外が記述され,time_tableオペランドが指定された場合
- analysis_typeオぺランドの指定値にTIMETABLEが記述され,time_tableオペランドが省略された場合
- analysis_typeオぺランド指定値にDAYTABLE以外が記述され,day_tableオペランドが指定された場合
- analysis_typeオぺランド指定値にDAYTABLEが記述され,day_tableオペランドが省略された場合
- コマンド実行時に,パラメタファイルの指定(-pオプション)が省略された場合,各オペランドの省略値が仮定されます。
- 稼働実績集計コマンドの処理時間の多くの部分は,アンロードジャーナルファイルの読み込みに費やされます。このため,result_user又はresult_bpにOFFを指定しても,処理時間を圧縮する効果は期待できません(出力ファイル量の削減にはなります)。
- result_user及びresult_bpの両方にOFFを指定した場合は,ヘッダ情報だけが出力されます。