uCosminexus 電子フォームワークフロー 解説

[目次][用語][索引][前へ][次へ]

12.1.4 完了案件削除ユティリティの実行方法

完了案件削除ユティリティの実行方法について説明します。

このユティリティは,アプリケーションサーバで実行してください。

<この項の構成>
(1) 実行コマンド
(2) 削除結果ファイル
(3) ワークファイル
(4) ロックファイル

(1) 実行コマンド

実行コマンドの実行方法について説明します。

注意事項
  • 完了案件削除ユティリティの実行時にJava VMのヒープサイズが不足する場合は,最大ヒープサイズを指定してください。
  • 最大ヒープサイズは,次の使用メモリの計算式を参考にしてください。
    Oracleの場合
    1トランザクションで使用するメモリ
    = 添付ファイルの最大サイズ × -aオプションの値
    HiRDB(LOCATOR)の場合
    1トランザクションで使用するメモリ
    = HiRDB_for_Java_LONGVARBINARY_ACCESS_SIZEの値 × -aオプションの値
    HiRDB(REAL)の場合
    1トランザクションで使用するメモリ
    = HiRDB_for_Java_MAXBINARYSIZEの値 × -aオプションの値
    SQL Serverの場合
    1トランザクションで使用するメモリ
    = 添付ファイルの最大サイズ × -aオプションの値
(a) 入力形式

[図データ]

(b) 実行コマンド
BLCDelPI
完了案件削除ユティリティの実行用コマンドです。変更できません。
(c) オプション
-u ユーザID
データベース接続用のユーザIDを指定します。テーブルを作成した認可識別子またはユーザを指定します(小文字で指定する場合は,「"」で文字列を囲んでください)。指定は必須です。
-p パスワード
-uオプションで指定したユーザIDに対応するデータベース接続用のパスワードを指定します。指定は必須です。
-o <削除結果ファイル>
完了案件削除ユティリティが出力する削除結果ファイルを,フルパス名で指定します。削除結果ファイルの詳細は,「(2) 削除結果ファイル」を参照してください。このオプションは,-cオプションの有無によって指定が異なります。
  • -cオプションを指定する場合
    -oオプションは省略できます。指定した場合,指定は無効になり,削除結果ファイルに,初期化,書き込みなどの変更はされません。
  • -cオプションを指定しない場合
    -oオプションの指定は必須になります。
    すでに削除結果ファイルがある場合は,初期化をしてから上書きします。
    削除結果ファイルがない場合は,新規に作成します。ただし,ファイルパスに含まれるディレクトリは作成されません。
-c
削除対象となる業務完了案件の件数を取得するだけの場合に指定します。業務完了案件の件数をメッセージに出力したあと,業務完了案件の保管または削除をしないで完了案件削除ユティリティを終了します。このオプションを指定した場合,-oオプションを省略できます。-sオプションおよび-gオプションは,指定しても無効になります。
-s
業務完了案件の保管をする場合に指定します。省略した場合は,業務完了案件の削除だけをして,業務完了案件の保管はしません。
このオプションと-gオプションの指定の関係を次に示します。
  • -sオプションを指定する場合
    -sオプションを指定した場合の動作は,-gオプションの指定の有無によって次のようになります。
    動作 -gオプション
    指定あり 指定なし
    業務データベースの保管 ×
    業務完了案件の保管
    業務データベースの削除 ×
    業務完了案件の削除
    (凡例)
    ○:実行されます。
    ×:実行されません。

  • -sオプションを指定しない場合
    -sオプションを指定しない場合の動作は,-gオプションの指定の有無によって次のようになります。
    動作 -gオプション
    指定あり 指定なし
    業務データベースの保管 × ×
    業務完了案件の保管 × ×
    業務データベースの削除 ×
    業務完了案件の削除
    (凡例)
    ○:実行されます。
    ×:実行されません。

-g
業務データベースの保管および削除をする場合に指定します。このオプションを指定した場合は,業務データベース保管用プロシージャおよび業務データベース削除用プロシージャを登録してください。省略した場合は,業務データベースの保管および削除はしません。
このオプションと-sオプションの指定の有無で,業務データベースの動作が変わります。
このオプションと-sオプションの指定の関係を次に示します。
  • -gオプションを指定する場合
    -gオプションを指定した場合の動作は,-sオプションの指定の有無によって次のようになります。
    動作 -sオプション
    指定あり 指定なし
    業務データベースの保管 ×
    業務完了案件の保管 ×
    業務データベースの削除
    業務完了案件の削除
    (凡例)
    ○:実行されます。
    ×:実行されません。

  • -gオプションを指定しない場合
    -gオプションを指定しない場合の動作は,-sオプションの指定の有無によって次のようになります。
    動作 -sオプション
    指定あり 指定なし
    業務データベースの保管 × ×
    業務完了案件の保管 ×
    業務データベースの削除 × ×
    業務完了案件の削除
    (凡例)
    ○:実行されます。
    ×:実行されません。

-d 案件終了後の経過日数
業務完了案件を特定するための案件終了後の経過日数を指定します。0〜3,650(10年)の値を指定してください。省略した場合は,31日となります。0を指定した場合は,すべての終了案件を対象とします。
日数はGMT(グリニッジ標準時間)で次のように求めます。
 
案件の完了日時≦
(実行日−(-dオプションで指定した日数+1日))の23時59分59秒
-b <BP定義名ファイル>
業務完了案件を絞り込むためのBP定義名を格納したファイルをフルパス名で指定します。省略した場合は,CSCIWに登録されているすべてのBP定義を対象とします。指定したファイルパスがない場合は,エラーとなります。
BP定義名ファイルは,プロパティ形式で作成してください。
キーの値は,001〜100です。これ以外のキーを指定しても無視されます。
BP定義名はキー一つにつき1件を記述してください。指定できるキーの数は最大100です。
001〜100のキーを重複して指定した場合,あとから読み込まれた方が有効となります。
001〜100のキーが途中で抜けていても,エラーにはなりません。
キーの指定順に昇順,降順などの規定はありません。
同じBP定義名を重複して指定してもエラーになりません。
誤ったBP定義名を指定したり,ワーク管理データベースにないBP定義名を指定したりした場合はエラーとなり,ユティリティが異常終了します。
指定したBP定義名がすべてワーク管理データベースにない場合は,エラーとなります。
BP定義名に該当する業務完了案件を確認するには,実行後の削除結果ファイルを参照してください。
BP定義名ファイルは,Unicodeコード文字エンコーディングされた値で構成されたファイルである必要があります。
BLCでは,エンコーディングされたBP定義名ファイル(DelPIbpname.sam)をサンプルとして提供しています。DelPIbpname.samファイルは,次のディレクトリに格納されています。
  • Windows版の場合
    <BLC2のインストールディレクトリ>\conf\DelPIbpname.sam
DelPIbpname.samファイルをDelPIbpname.txtというファイル名でコピーし,使用してください。
提供するファイル(エンコーディングされたファイル)の例を次に示します。
[図データ]
BP定義名ファイルを編集するには,いったんネイティブコードに変換する必要があります。変換には,Cosminexusに付属のJDKコマンド(native2asciiコマンド)を使用します。
内容を変更する場合はnative2ascii -reverseでネイティブコードのファイルに変換し,編集したあとnative2asciiで変換してください。
操作手順をWindows版の場合を例に示します。
操作手順
  1. エンコーディングされているBP定義名ファイルをnative2asciiコマンドで変換します。

    [図データ]

    native2ascii -reverseでネイティブコードに変換したファイルの例を次に示します。

    [図データ]

  2. ネイティブコードに変換したファイルをメモ帳などのテキストエディタで編集します。
  3. 編集したファイルをnative2asciiコマンドでエンコーディングされたファイルに変換します。

    [図データ]

-a 処理単位
何件ごとに案件を処理するかを指定するオプションです。実行時に,画面に処理中であることを示す「.」(ピリオド)を表示する単位です。10〜255の値を指定してください。10〜255以外の値を指定した場合は,エラーとなります。省略した場合は,50となります(50案件を1単位として保管および削除をします)。
(d) オプションの注意事項

(2) 削除結果ファイル

削除結果ファイルは,完了案件削除ユティリティを実行した場合に作成されます。

削除結果ファイルの形式は,CSVファイル(コンマ区切りの可変長テキストファイル)です。各項目は「"」(半角ダブルクォーテーション)で囲まれます。

画面に表示される開始メッセージ(KDLC5006-I),および終了メッセージ(KDLC5007-I)が削除結果ファイルに出力されます。

削除対象の案件がない場合,開始メッセージ,ヘッダとフッタ,および終了メッセージだけが出力されます。

削除対象の案件がない場合,ヘッダだけが出力されます。

(a) ファイル名と出力先

完了案件削除ユティリティの実行コマンドの-oオプションで指定したファイルパスに作成されます。

(b) ファイル形式

削除結果ファイルの文字セットはUTF-8で出力されます。

削除結果ファイルに出力されるヘッダ,内容形式およびフッタを次に示します。

処理の途中で異常終了した場合,フッタは出力されません。

図12-16 削除結果ファイルのヘッダ,内容形式およびフッタ

[図データ]

(c) 注意事項
(d) 削除結果ファイルの内容

削除結果ファイルに出力される内容について次に示します。

表12-5 削除結果ファイルの内容一覧

カラム名 内容 備考
Action 動作 処理の名称
PIID 案件ID 案件ID
PIName 案件名 案件の名称
BPID BP定義ID 案件が所属するビジネスプロセス定義のID
BPName BP定義名 案件が所属するビジネスプロセス定義の名称
Code 案件状態コード 案件の状態コード
ClosedDate 案件完了日時 案件の終了日時
Result 処理結果 各処理の結果
●動作の値

動作の値と内容を次に示します。

表12-6 動作の値

内容
SaveUDB 業務データベース保管処理
SaveBLC BLCデータベース保管処理
SaveCSCIW ワーク管理データベース保管処理
DeleteUDB 業務データベース削除処理
DeleteBLC BLCデータベース削除処理
DeleteCSCIW ワーク管理データベース削除処理
●案件状態コードの一覧

案件状態コードの値と内容を次に示します。

表12-7 案件状態コードの値

内容
o 完了
u 強制終了
v 異常終了

値の英字は小文字で,CSCIWの案件状態コードです。

●案件完了日時の形式

[図データ]

案件完了日時に設定されている各項目の内容を次に示します。

表12-8 案件完了日時の項目

項目 文字数 設定内容
yyyy 4 年(西暦)を4桁で表示します。(例:2002,2003・・・)
MM 2 月を2桁で表示します。(例:01,02・・・)
dd 2 日を2桁で表示します。(例:01,02・・・)
HH 2 時(24時間制)を2桁で表示します。(例:01,02・・・)
mm 2 分を2桁で表示します。(例:01,02・・・)
ss 2 秒を2桁で表示します。(例:01,02・・・)
●削除結果の値

処理結果の値と内容を次に示します。

表12-9 処理結果の値

内容 以降の処理
OK 正常終了しました。 処理を続行します。
NG 異常終了しました。 ユティリティの実行を終了します。
Duplicate 重複キーがあります。
すでに案件が保存されています。
処理を続行します。
NoData 該当データがありません。 処理を続行します。
PartLack 部分不足です。
BLCデータベースの保管処理で,システムに必須であるテーブル(BLC_BK_INBOX_T,BLC_BK_FORM_DATA_T)のデータがありませんでした。
処理を続行します。ただし保存用テーブルの内容が正しくないので,保管案件照会機能で正しく検索できない場合があります。
数値 業務データベース保存プロシージャ,業務データベース削除プロシージャから規定外の戻り値が返されました。
戻り値の数値をそのまま出力します。
プロシージャの戻り値が0,または正の数の場合,処理を続行します。負の数の場合,ユティリティの実行を終了します。
BLCデータベースの保管処理結果
BLCデータベースの保管処理では,BLC_INBOX_T,BLC_SENTLOG_T,BLC_FORM_DATA_TおよびBLC_FILE_Tのデータを案件単位に保管します。また,保管処理のトランザクションは,BLC_INBOX_T,BLC_SENTLOG_TおよびBLC_FORM_DATA_Tの1案件を1トランザクションで処理し,BLC_FILE_Tは1ファイルごとになっています。
BLCデータベースの保管処理時の状態と結果リストを次に示します。

表12-10 BLCデータベースの保管処理時の状態と結果リスト

テーブルおよび結果リスト 保管状態 1 2 3 4 5 6 7 8 9 10 11
BLC_INBOX_T 成功
保管済み
データなし
BLC_SENTLOG_T 成功
保管済み
データなし
BLC_FORM_DATA_T 成功
保管済み
データなし
BLC_FILE_T 成功
保管済み
データなし
結果リストの出力 NoD Dup OK OK OK OK PLK PLK PLK PLK PLK
(凡例)
○:その保管状態に該当している
−:その保管状態に該当していない
OK:"OK"
Dup:"Duplicate"
NoD:"NoData"
PLK:"PartLack"
注※
BLC_FILE_Tの定義なしを含みます。

BLCデータベースの保管処理中に例外が発生した場合は,該当する案件に対して結果リストに"NG"が出力されます。
なお,BLC_FILE_Tの処理で例外が発生した場合は,BLC_INBOX_T,BLC_SENTLOG_TおよびBLC_FORM_DATA_Tのデータは正常に保管されますが,結果リストには"NG"が出力されます。
ワーク管理データベースの保管処理結果
ワーク管理データベースの保管処理時の状態と結果リストを次に示します。

表12-11 ワーク管理データベースの保管処理時の状態と結果リスト

保管状態 1 2 3
成功
保管済み
データなし
結果リストの出力 OK Duplicate NoData
(凡例)
○:その保管状態に該当している
−:その保管状態に該当していない

ワーク管理データベースの保管処理中に例外が発生した場合は,処理単位の案件すべてに対して結果リストに"NG"が出力されます。

(e) 出力例

削除結果ファイルの出力例を次に示します。

図12-18 削除結果ファイルの出力例

[図データ]

(3) ワークファイル

ワークファイルは,完了案件削除ユティリティが実行時に作業用として使用するファイルです。

作業用ディレクトリの下にファイル名を「BLCDelPI.Wk」として作成されます。

実行時に,ワークファイルがない場合は新規に作成され,すでに作成されている場合は上書きされます。

ワークファイルが使用する容量の最大は,344×削除対象案件数(バイト)です。

(4) ロックファイル

ロックファイルは,完了案件削除ユティリティが実行時に作成し,終了時に削除するファイルです。

作業用ディレクトリの下にファイル名を「BLCDelPI.lock」として作成されます。

完了案件削除ユティリティの同時実行をチェックするために使用し,このファイルが存在する間は,ユティリティが実行中であると見なされます。

ロックファイルは,0バイトのファイルです。