Hitachi

uCosminexus Service Coordinator Interactive Workflow コマンド

2.5　ciwdelpi（案件の削除）

形式

注※

すべてのコマンドで同じ形式で指定します。詳細は，「1.5　コマンド共通のオプション」を参照してください。

機能

案件削除コマンドは，シンクノードに到達，または強制終了し不要となった案件や未処理の案件を一括で削除します。

削除対象の案件は，次に示す条件でフィルタリングできます。

また，案件IDを設定したファイルを使用すると，ファイルに設定した案件IDの案件を削除できます。

CSCIW 02-10以降では，BPMN連携機能のテーブルの案件データについても削除します。

また，コールアクティビティの呼び出しによって，案件に親子関係が発生します。親子関係にある案件の削除をする場合，次のルールに従って，案件を削除します。

実行条件

このコマンドを実行できるコンポーネントの稼働状態を次に示します。

コンポーネント

稼働状態

起動中

停止中

CSCIWManagementServer

×※

○

案件運用操作

×※

○

CSCIWライブラリを使用した業務アプリケーション（J2EEアプリケーション）

×※

○

CSCIWライブラリを使用した業務アプリケーション（Javaアプリケーション）

×※

○

アプリケーション呼び出しサービス

×※

○

RESTサービス

×※

○

運用管理RESTサービス

×※

○

同一マシンでのほかのコマンド

×

○

異なるマシンでの同一コマンド

○

○

異なるマシンでのほかのコマンド

×

○

DBMS

○

×
（凡例）

○：コマンドを実行できます。

×：コマンドを実行できません。

注※

-onlオプション指定時は，起動中でもコマンドを実行できます。

引数

-sid <system_id>

環境構築時に設定したシステムIDを指定します。指定したシステムIDに対応するワーク管理システム上の案件が対象になります。

指定できる値は，半角英大文字と半角数字で5文字以内です。ただし，先頭には半角英大文字を指定してください。

-dfc <elapsed_days>

このオプションは，-dfsオプションまたは-pidfileオプションと同時に指定できません。

案件の終了日時から経過した日数を指定します。指定した日数×24時間以上経過した「完了」状態の案件が削除されます。

案件終了後の経過日数は，1970/01/02 00:00:00 GMTから現在の日時までの経過した日数以内で指定してください。指定できる値は0〜2,147,483,647の整数です。

-allオプションを同時に指定すると，「完了」状態に加えて「強制終了」状態の案件を削除できます。

-dfs <elapsed_days>

このオプションは，-dfcオプションまたは-pidfileオプションと同時に指定できません。

案件の開始日時から経過した日数を指定します。指定した日数×24時間以上経過した「完了」状態の案件が削除されます。

案件開始後の経過日数は，1970/01/02 00:00:00 GMTから現在の日時までの経過した日数以内で指定してください。指定できる値は0〜2,147,483,647の整数です。

-allオプションを同時に指定すると，「完了」状態に加えて，「未実行」状態，「実行中」状態，「実行停止」状態および「強制終了」状態の案件を削除できます。ただし，「未実行」状態の案件を削除する場合は，案件開始後の経過日数に0を指定する必要があります。

-pidfile <process_instance_id_file_name>

このオプションは，-dfcオプションまたは-dfsオプションと同時に指定できません。

削除対象となる案件IDのリストを記述したファイル（案件IDリスト指定ファイル）を指定します。案件IDリスト指定ファイルに記述した案件IDに対応する「完了」状態の案件が，案件開始後または案件終了後の経過日数に関係なく削除されます。

案件IDに対応する案件が存在する場合だけ，案件は削除されます。

なお，案件IDに対応する案件が存在しなくても，このコマンドは異常終了しません。

-allオプションを同時に指定すると，案件IDリスト指定ファイルに記述されている案件のうち，「完了」状態の案件に加えて，「未実行」状態，「実行中」状態，「実行停止」状態，および「強制終了」状態の案件を削除できます。

案件IDリスト指定ファイルの記述形式を次に示します。

  • 「#」から始まる行はコメントになります。

  • 案件IDは，-2,147,483,648〜2,147,483,647の整数で指定します。

  • 複数の案件IDを指定する場合の区切り文字には，半角スペースまたは改行を指定します。

案件IDリスト指定ファイルの例を次に示します。この例は，「1」，「2」および「3」の案件IDの案件を削除する場合の例です。

例

ファイル名：ProcessInstaceIDList.txt

# 削除対象の案件IDのリスト
1 2
3

なお，案件IDリスト指定ファイル内の案件IDの数が多い場合，OutOfMemoryErrorが発生するおそれがあります。OutOfMemoryErrorが発生した場合は，次に示すどちらかの対処を実施してください。

  • コマンド用環境設定ファイル内のCSCIWCMD_JVM_ARGSに，-Xmxオプションを指定し，Javaヒープの最大サイズを増やします。

  • 案件IDリスト指定ファイルを分割し，1ファイル当たりの案件IDの数を減らします。

-ofs

このオプションは，-dfcオプションまたは-dfsオプションを指定した場合だけ指定できます。

経過日数の区切りを00（時）:00（分）:00（秒）とする場合に指定し，指定日数以上経過した案件を削除対象とします。指定日数は，-dfcオプションまたは-dfsオプションで指定します。

このオプションとともに-dfcオプションまたは-dfsオプションに「1」を指定した場合は，コマンド実行日の前日までにシンクノードに到達または案件投入した案件を削除します。また，このオプションとともに-dfcオプションまたは-dfsオプションに「0」を指定した場合は，シンクノードに到達または案件投入したすべての案件を削除します。

このオプションを省略した場合，指定日数×24時間以上経過した案件を削除対象とします。

-all

「完了」状態以外の案件を削除する場合に指定します。

削除できる案件の状態は，-dfcオプション，-dfsオプションまたは-pidfileオプションを指定しているかどうかによって異なります。削除できる案件の状態を次の表に示します。

表2‒14　削除できる案件の状態

指定するオプション

案件の状態

未実行

実行中

実行停止

完了

強制終了

-dfcだけ指定した場合

×

×

×

○

×

-dfcと-allを同時に指定した場合

×

×

×

○

○

-dfsだけ指定した場合

×

×

×

○

×

-dfsと-allを同時に指定した場合

○※

○

○

○

○

-pidfileだけ指定した場合

×

×

×

○

×

-pidfileと-allを同時に指定した場合

○

○

○

○

○
（凡例）

○：削除します。

×：削除しません。

注※

-dfsオプションに0を指定する必要があります。

-bpn <process_definition_name>

ビジネスプロセス定義名を指定します。指定したビジネスプロセス定義名を使用して生成したすべての案件が削除されます。

ビジネスプロセス定義名は，<SYSTEMID>_PROCESS_DEFテーブルのNameカラムのバイト数以内で指定してください。

-bpvオプションを同時に指定すると，ビジネスプロセス定義のバージョンも限定できます。

-bpv <process_definition_version>

このオプションは，-bpnオプションを指定した場合だけ指定できます。

ビジネスプロセス定義のバージョンを指定します。-bpnオプションに指定したビジネスプロセス定義名で，かつこのオプションに指定したバージョンのビジネスプロセス定義を使用して生成したすべての案件が削除されます。

指定できる値は，-32,768〜32,767です。ただし，有効な値はビジネスプロセス定義作成時に指定できる0〜9,999となります。

-pin <process_instance_name>

案件名を指定します。指定した案件名を使用して生成したすべての案件が削除されます。オプションだけ指定し，案件名を省略した場合は，案件名が設定されていない案件が削除されます。

案件名は，「%」（半角パーセント），「_」（半角アンダースコア）およびエスケープ文字を含め，<SYSTEMID>_PROCESS_INSTANCEテーブルのNameカラムのバイト数以内で指定してください。

案件名には，ワイルドカードが指定できます。ワイルドカードの指定方法は，SQLのLIKE条件に従います。任意の文字（0文字以上）を指定するときには「%」を，任意の1文字を指定するときには「_」を指定します。案件名に「%」だけ指定したときは，案件名が設定されているすべての案件が削除されます。

なお，「%」または「_」を含む案件名を指定するときには，「%」または「_」の前にエスケープ文字を指定してください。使用するエスケープ文字は，-escオプションで指定する必要があります。

-esc <escape_character>

このオプションは，-pinオプションを指定した場合だけ指定できます。

-pinオプションで使用するエスケープ文字を指定します。

エスケープ文字には，案件名で使用していない任意の1文字を指定してください。指定できる文字は，LIKE条件のESCAPE句に指定できる文字です。

-onl

このオプションは，-dfcオプションを指定した場合だけ指定できます。

このコマンドをCSCIWManagementServer，案件運用操作およびCSCIWライブラリを使用した業務アプリケーションと同時に実行するときに指定してください。

-unt <processing_unit>

案件を削除するときの処理単位を指定します。

削除処理のトランザクションは，処理単位ごとにコミットされます。

指定できる値は1〜10,000の整数です。なお，このオプションを省略した場合，またはオプションだけを指定して処理単位を省略した場合，100が仮定されます。

なお，HiRDBを使用しているワーク管理システムで，-untオプションの処理単位の値を大きくする場合，HiRDBの排他要求数（pd_lck_pool_size）の設定値以内かどうかを確認してください。処理単位の値が排他要求数（pd_lck_pool_size）の設定値を超える場合は，処理単位の値を小さくするか，または排他要求数（pd_lck_pool_size）の設定値を大きくしてください。なお，排他要求数（pd_lck_pool_size）の見積もりについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」のciwdelpiコマンド実行時の排他要求数の見積もりについて記載されている個所を参照してください。

BPMN連携機能の使用時にコールアクティビティを使用している場合の削除の処理単位は，ルート案件，およびルート案件に子案件が存在するときは子案件（子案件の子案件も含む）を含めて1単位とします。そのため，コールアクティビティを使用する場合は，ビジネスプロセス定義のコールアクティビティの数に応じて，-untオプションの値を検討する必要があります。

-vi

経過情報を標準出力およびメッセージファイルに出力する場合に指定します。

経過情報は，-untオプションに指定した処理単位ごとに出力されます。

-file <option_file_name>

このオプションは，すべてのコマンドで指定できます。詳細は，「1.5.1　-fileオプション」を参照してください。

-encoding <character_set>

このオプションは，すべてのコマンドで指定できます。詳細は，「1.5.1　-fileオプション」を参照してください。

-h

このオプションは，すべてのコマンドで指定できます。詳細は，「1.5.2　-hオプション」を参照してください。

戻り値

戻り値

内容

0

正常終了

1

致命的なエラー

9※

実行権限エラー

10

条件に指定したビジネスプロセス定義が存在しない

20

条件に指定した案件が存在しない

51

パラメーター不正

110

指定した案件IDの不正

150

ファイルアクセスエラー

254

異常終了
注※

Windowsの場合だけ発生します。

注意事項

ページの先頭へ

All Rights Reserved. Copyright (C) 2007, 2022, Hitachi, Ltd.