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

 
cscpidelete [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            -csc <HCSCサーバ名>
            {-where <where句>
             ｜-idlist <プロセスインスタンスの識別子のリストが
                        記載されたファイル名>
             ｜-wherefile <where句が記載されたファイル名>
             ｜-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：テーブル名を指定した場合

正しい例：State='Completed'
誤った例：P.State='Completed'

設定例2：コメント行を追加した場合

正しい例：State='Completed' AND

　　　　ProcessDefinitionName like 'BP%'

誤った例：State='1' AND
　　　　# process.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句が記載されたファイル名を絶対パス，または相対パスで指定します。指定されたファイル内容に改行コードをスペースに置き換えて，プロセス概要情報を検索し，該当するプロセスインスタンスの実行履歴を削除します。

-force

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

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

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

UTF-8
US-ASCII
ISO-8859-1
JavaVMがサポートしているエンコーディング名

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

 
cscpidelete -user admin -pass admin -csc MyCSC -force

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

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

(3)ProcessIDが「11111」，「22222」，および「33333」のプロセスを削除する場合

where句が記載されたファイルで指定する場合

 
cscpidelete -user admin -pass admin -wherefile delete_where.txt -csc MyCSC
 
delete_where.txtの中身
 
ProcessID='11111' OR ProcessID='22222' OR ProcessID='33333'

プロセスインスタンスの識別子のリストを改行区切りで作成したファイルで指定する場合

 
cscpidelete -user admin -pass admin -idlist idlist.txt -csc MyCSC
 
idlist.txtの中身
 
11111
22222
33333

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

このコマンドはSQLのwhere句をオプションに指定します。そのため，使用するユーザIDおよびパスワードを定期的に変更するなどして，第三者に不当にコマンドを実行されないようにしてください。
100件以上のプロセスインスタンスを削除対象として指定し，101件目以降の削除で例外が発生した場合，削除対象となっていた前100件のプロセスインスタンスは削除済みの状態になります。その場合，前100件の削除済みの情報は，エラーメッセージの詳細情報として表示されます。
データベースとCosminexus RMを使用する場合だけ，このコマンドを使用できます。