cscpideleteプロセスインスタンスの実行履歴の削除

形式

cscpidelete [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           -csc <HCSCサーバ名>
           {-where <where句>
             |-idlist <プロセスインスタンスの識別子のリストが
                       記載されたファイル名>
             |-wherefile <where句が記載されたファイル名>
             |[-processname <ビジネスプロセス定義名>]
               [-date [<照会開始日時>],<照会終了日時>]
               [-status {executing|completed|faulted|error|all}]
             |-force}
           [-encoding <エンコーディング名>]

機能

セットアップ後のHCSCサーバに対して,指定された条件に従ってプロセスインスタンスの実行履歴を削除します。

ログインユーザIDなどの必須オプションは,HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで,このコマンドでの指定を省略できます。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。

-user <ログインユーザID> ~<半角英数字およびアンダーライン(_)> ((1-16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード> ~<半角英数字およびアンダーライン(_)> ((1-16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名> ~<半角英数字およびアンダーライン(_)> ((1-8文字))

SQLを実行するHCSCサーバ名を指定します。

-where <where句> ~ ((1文字以上))

削除対象となるプロセスインスタンスのプロセス概要情報を検索するためのwhere句を指定します。where句に記載できる内容については,使用しているデータベースのSQLリファレンスマニュアルを参照してください。

なお,where句には,テーブル名の指定およびコメント行の追加はできません。where句の設定で,誤った例と正しい例を次に示します。

設定例1

 誤った例:テーブル名を指定している
           P.Status='Completed'
 正しい例:テーブル名を指定していない
           Status='Completed'

設定例2

 誤った例:コメント行を追加している
           Status='Completed' AND
           # ProcessDefinitionName like 'BP%'
 正しい例::コメント行を追加していない
           Status='Completed' AND
           ProcessDefinitionName like 'BP%'

-idlist <プロセスインスタンスの識別子のリストが記載されたファイル名> ~ ((1-200バイト))

プロセスインスタンスの識別子のリストが記載されたファイル名を指定します。プロセスインスタンスの識別子のリストは,改行区切り(「¥r¥n」または「¥n」)で記載します。ファイルパスは,絶対パス,または相対パスで指定します。一つの改行の先頭と終端の空白文字は削除します。設定例を次に示します。

設定例
ProcessIDが「11111」,「44444」,「77777」のビジネスプロセスを削除する場合(改行コードは「¥n」で表示しています)。

11111¥n
44444¥n
77777¥n

-wherefile <where句が記載されたファイル名> ~ ((1-200バイト))

where句が記載されたファイル名を絶対パス,または相対パスで指定します。指定されたファイル内容に改行コードをスペースに置き換えて,プロセス概要情報を検索し,該当するプロセスインスタンスの実行履歴を削除します。

-processname <ビジネスプロセス定義名> ~((1文字以上))

指定したビジネスプロセス定義名のプロセスインスタンスを削除します。

-date [<照会開始日時>],<照会終了日時> ~<半角数字>

指定した照会開始日時から照会終了日時までの間に開始したプロセスインスタンスを削除します。照会開始日時を省略した場合,照会終了日時より前に開始したプロセスインスタンスを削除します。照会開始日時と照会終了日時の間のコンマ(,)の前後に余分なスペースを指定しないでください。なお,指定できる日時の形式は次の形式です。また,日時の指定にはデフォルトタイムゾーンを使用してください。

-status {executing|completed|faulted|error|all} ~<<completed>>

指定した状態のプロセスインスタンスを削除します。-whereオプション,-idlistオプション,-wherefileオプション,-statusオプション,および-forceオプションをすべて省略した場合,このオプションのcompletedが有効になります。

-force

データベース内の全プロセスインスタンスの情報を削除します。

-encoding <エンコーディング名> ~((1文字以上)) <<JavaVMのデフォルトエンコーディング>>

-wherefileオプションや-idlistオプションで指定した入力ファイルのエンコーディング名を指定します。次のエンコーディング名を指定できます。

入力例

(1)全情報を削除する場合

cscpidelete -user admin -pass admin -csc HCSC -force

(2)ステータスが「完了」のプロセスをすべて削除する場合

cscpidelete -user admin -pass admin -where "State='Completed'"

(3)ProcessIDが「11111」,「22222」,および「33333」のプロセスを削除する場合
  • where句が記載されたファイルで指定する場合
    cscpidelete -user admin -pass admin -wherefile delete_where.txt -csc HCSC
     delete_where.txtの中身
      ProcessID='11111' OR ProcessID='22222' OR ProcessID='33333'
  • プロセスインスタンスの識別子のリストを改行区切りで作成したファイルで指定する場合
    cscpidelete -user admin -pass admin -idlist idlist.txt -csc HCSC
     idlist.txtの中身
      11111
      22222
      33333

戻り値

戻り値意味
0正常終了しました。
1コマンドが異常終了しました。
2通信タイムアウトが発生しました。
3排他エラーが発生しました。
9実行権限のチェックエラーが発生しました。

注意事項