ecmDeleteDocuments.bat(文書削除)
形式
ecmDeleteDocuments.bat -d 文書空間識別子
-u ユーザID
-p パスワード
-s 検索条件ファイル
〔-q フォルダパスファイル〕
〔-t 削除対象となる文書の種類〕
〔-g 一般文書の操作種別〕
〔-k 検索対象のファイル種別〕
〔-w〕
〔-j〕
〔-wl〕
〔-i〕
〔-c〕
〔-utf8〕
〔-?〕
機能
指定した属性検索条件を基に検索を実行し,ヒットした文書の主ファイルと関連ファイルおよびすべての履歴を一括で削除します。検索対象は,確定している最新バージョンです。改訂中の公開文書,リファレンスファイル文書は削除されません。このコマンドは,次の場合などで利用できます。
なお,フォルダは削除されません。
コマンド引数
-d 文書空間識別子
処理対象となる文書空間の文書空間識別子を指定します。
この引数は必ず指定してください。
-u ユーザID
システム管理者のIDを指定します。
この引数は必ず指定してください。
-p パスワード
システム管理者のパスワードを指定します。
この引数は必ず指定してください。
-s 検索条件ファイルのフルパス名
検索条件ファイルのフルパス名を指定します。検索条件ファイルには,削除対象となる文書の検索条件を記述します。検索条件ファイルの詳細は,「6.3.4(1)検索条件ファイル」を参照してください。
この引数は必ず指定してください。
-q フォルダパスファイルのフルパス名
フォルダパスファイルのフルパス名を指定します。フォルダパスファイルに指定したフォルダパスの下位に属するすべての階層のフォルダに登録されている文書が検索対象となります。この引数の指定を省略すると,すべてのフォルダの文書を検索対象とします。ただし,指定を省略した場合,処理に時間が掛かることがあります。この引数を指定することを推奨します。フォルダパスファイルの詳細は,「6.3.4(2)フォルダパスファイル」を参照してください。
-t
削除対象の文書種別を次の値で指定します。この引数の指定を省略すると,NORMALが仮定されます。
-g
ごみ箱の文書の動作について次の値で指定します。この引数の指定を省略すると,NOUSEが仮定されます。
-k
検索対象に関連ファイルを含めるかどうかを次の値で指定します。この引数の指定を省略するとMAINが仮定されます。なお,削除対象は,ここでの指定に関係なく,検索条件でヒットした文書の主ファイルと関連ファイルおよびすべての履歴です。
主ファイルと関連ファイルのプロパティで,「文書ファイル名」および「ファイルサイズ」は,同じ値を共有しません。このため,ファイル名,およびファイルサイズを検索条件に指定した場合に,RELATIONを指定しているときには,関連ファイルだけがヒットすることがあります。このとき,ヒットした関連ファイルは,主ファイルと合わせて削除されます。
-w
チェックアウト中の文書を削除対象にする場合に指定します。指定を省略するとチェックアウト中の文書は削除されません。
-j
公開文書と公開文書の関連リンクが張られている場合,または案件から公開文書にリンクが張られている場合,関連リンクを無視して公開文書を削除するときに指定します。この引数の指定を省略すると,関連リンクが張られている公開文書は削除されません。
-wl
引数「-j」が指定されていない場合に,関連リンクが張られている公開文書に対して,警告を出力する場合に指定します。指定を省略すると,警告を出力せずに正常終了します。引数「-j」が指定されている場合は,この引数を指定しても無視されます。
-i
コマンド実行時の初期処理である削除対象文書の検索方法を指定します。大量の文書が登録されている環境で,次の場合は条件に一致する文書を検索する初期処理の検索時間を短縮できるときがあります。
ただし,次の場合は引数「-i」の指定は推奨しません。
-c
コマンドを実行する前に,コマンドの内容をチェックし,削除対象になる文書を確認したい場合に指定します。この引数を指定した場合は,削除処理は行わず削除対象となる文書に対してKARI27017-Iを出力します。他の動作は,この引数を指定しない場合と同じ動作となります。
-utf8
文書管理サーバの文字コード種別がUTF-8の場合に指定します。指定を省略すると,Shift-JISとして処理されます。文書管理サーバの文字コード種別がUTF-8の場合に指定を省略すると,ログファイルの出力内容で文字化けが発生することがあります。
-?
このコマンドの使用方法を出力します。
この引数を指定すると,コマンドの使用方法の出力だけが行われ,文書は削除されません。
戻り値
コマンドの戻り値を次の表に示します。
表6-11 文書削除コマンドの戻り値
戻り値 | 意味 |
---|---|
0 | 検索条件を満たす文書がすべて削除されました。 |
1 | 検索条件を満たす文書に対して,ワーニングメッセージとなる文書が存在しました。 例えば,引数「-w」や引数「-j」の指定を省略している場合で,一般文書がチェックアウト中である,公開文書に分岐先文書または分岐元文書の関連リンクが張られている,公開文書が改訂中であるなどで削除できなかった場合に返却されます。なお,引数「-wl」が指定されていない場合は,公開文書に分岐先文書または分岐元文書の関連リンクが張られている文書に対して,ワーニングメッセージを出さずに戻り値0を返却して,正常終了します。 |
-1 | 続行不可のエラーが発生しました。 |
実行例
このコマンドの実行例を次に示します。
ecmDeleteDocuments.bat△-d△2f44eb5e-e211-44f1-b8c0-b589b6fafa0d△-u△admin△-p△pass△-s△C:¥work¥search.txt△-q△C:¥work¥folder.csv△-t△ALL△-g△NOUSE△-k△MAIN△-w△-wl△-c |
(凡例)△:半角スペース
ログファイル
コマンドの実行経過はログファイルに出力されます。
YYYY/MM/DD hh:mm:ss message |
ログファイルは,コマンドを実行するごとに情報が蓄積され,ファイルサイズが増加します。このため,運用時は,定期的にバックアップを取得したあとにログファイルを削除するなどして,ファイルサイズが大きくなり過ぎないようにしてください。
注意事項