ecmCancelCheckOutDoc.bat文書一括チェックアウトキャンセル

形式

ecmCancelCheckOutDoc.bat   -d 文書空間識別子
               -u ユーザID
               -p パスワード
               -o 出力ファイルの格納先フォルダパス
              〔-e 出力ファイルの文字コード種別〕
              〔-s 関連ファイルの監査証跡ログ出力指定〕
              〔-l〕
              〔-?〕

機能

ユーザ情報・グループ情報を一括変更する場合に,文書管理サーバ内のすべてのチェックアウト中文書(一般文書)に対して,チェックアウトを取り消します。

コマンド引数

-d 文書空間識別子

処理対象となる文書空間の文書空間識別子を指定します。

この引数は必ず指定してください。

-u ユーザID

システム管理者のユーザのIDを指定します。

この引数は必ず指定してください。

-p パスワード

システム管理者のパスワードを指定します。

この引数は必ず指定してください。

-o出力ファイルの格納先フォルダパス

チェックアウトキャンセルの実行結果を出力する出力ファイルの格納先フォルダパスを指定します。

この引数は必ず指定してください。

-e

出力ファイルの文字コード種別を,「SJIS」または「UTF-8」で指定します。

この引数の指定を省略すると,SJISが仮定されます。

なお,文書管理サーバの文字コード種別がUTF-8の場合に,出力ファイルの文字コード種別をShift-JISとして出力しようとすると,文字化けが発生することがあります。

-s

関連ファイルに対する操作の監査証跡ログの出力有無を,「0」または「1」で指定します。

この引数の指定を省略すると,「0」が仮定されます。

-l

この引数を指定した場合,チェックアウトの取り消しを実行しないで,チェックアウト中文書の一覧だけを出力します。

-?

このコマンドの使用方法を出力します。

戻り値

コマンドの戻り値を次の表に示します。

表6-9 文書一括チェックアウトキャンセルコマンドの戻り値

戻り値意味
0コマンドが正常終了し,チェックアウト中文書情報取得処理,またはチェックアウトキャンセル処理でエラーが発生しませんでした。
1コマンドは正常終了しましたが,チェックアウト中文書情報取得処理,またはチェックアウトキャンセル処理でエラーが1件以上発生しました。
-1コマンドがエラー終了しました。

実行例

このコマンドの実行例を次に示します。

ecmCancelCheckOutDoc.bat△-d△2f44eb5e-e211-44f1-b8c0-b589b6fafa0d△-u△admin△-p△pass△-o△C:¥work¥out△-l

(凡例)△:半角スペース


出力ファイル

チェックアウトキャンセルの対象となった文書の一覧を「ecmCancelCheckOutDoc<YYYYMMDDHHmmssfff>.csv」というファイル名で出力します。YYYYMMDDHHmmssfffは,コマンドの実行を開始した日時です。なお,-l引数を指定した場合は,「ecmCheckOutDocList<YYYYMMDDHHmmssfff>.csv」というファイル名で出力します。

-o引数で指定されたフォルダが存在しない場合,また,出力ファイルと同名のファイルがすでにフォルダ内に存在した場合は,エラーとなります。

出力項目
出力項目を次の表に示します。

表6-10 出力ファイルの出力項目

項番項目名説明
1オブジェクト種別操作対象オブジェクトの種別には「2」が出力されます。
2文書の種別文書の種別には「1」が出力されます。
3フォルダ種別フォルダ種別には,何も出力されません。
4フォルダパス文書のフォルダパスが出力されます。最上位フォルダの場合は,空文字が出力されます。
5名前文書名が出力されます。
6更新者ID文書の更新者IDが出力されます。
7更新者名文書の更新者名が出力されます。
8更新日時文書の更新日付がYYYY/MM/DD HH:mm:ss形式で出力されます。
9チェックアウト者IDチェックアウトユーザのユーザIDが出力されます。
10チェックアウト者名チェックアウトユーザのユーザ名が出力されます。
11エラー情報チェックアウトキャンセル処理中にエラーが発生した場合,エラー原因を出力します。
12オブジェクトOIIDチェックアウト中文書のバージョン共通OIIDを出力します。
参考
  • チェックアウトキャンセル成功時にも,[チェックアウト者ID]列および[チェックアウト者名]列に値を出力します。
  • チェックアウト中文書が0件で出力対象が存在しない場合は,ヘッダ行だけ出力します。
  • 出力ファイルの文字コード種別のデフォルトはShift-JISです。ただし,コマンド実行時に[-e]引数で[UTF-8]を指定した場合は,UTF-8で出力されます。
  • 出力ファイルの文字コード種別をUTF-8で出力する場合,ファイルの先頭にBOMを挿入します。
  • 行内の各項目の値は,空文字の場合を除いて,常に["(半角ダブルクォーテーション)]で囲んで出力します。
  • 行内の各項目通しは[,(半角コンマ)]で区切って出力します。
  • 項目の値としてダブルクォーテーションが含まれる場合,ダブルクォーテーションを二重のダブルクォーテーション("")に置換します。

注意事項