ecmRFileMove.vbsリファレンスファイル文書化

形式

ecmRFileMove.vbs
              〔〔/p〕 |
                  /j
                〔/t:最大実行時間〕
                〔/i〕
                〔/d:コンテント格納先パス定義ファイルのパス〕〕

機能

リファレンスファイル文書化指示で作成したジョブ登録情報に基づいて,リファレンスファイル文書化をします。また,定義ファイルを使用することにより,文書のプロパティ値ごとにコンテントの格納先を振り分けることができます。

なお,リファレンスファイル文書化コマンド実行時にごみ箱へ移動している文書は,リファレンスファイル文書化の対象となりません。

次の文書はリファレンスファイル文書化の処理をスキップします。ただし,スキップの対象となる文書に対しても文書の状態をチェックするため,チェックの時間が必要となります。

スキップした文書が,リファレンスファイル文書化指示で作成したジョブ登録情報に含まれている場合は,該当するジョブ登録情報は削除されません。主ファイルと関連ファイルのどちらかがスキップの対象となる文書の場合,すでにリファレンスファイル文書化に成功したファイルも含めて,その文書のステータスはスキップとなります。スキップの要因を取り除いて,再度,リファレンスファイル文書化コマンドを実行してください。ただし,スキップしたファイルのステータスがSKIP5の場合で,その他の主ファイル,関連ファイルのステータスがすべてOKのときには,リファレンスファイル文書化されます。

注※
すでにリファレンスファイル文書化されている文書,およびPDF形式への変換がエラーとなった文書のジョブ登録情報は削除されます。

コマンド引数

/p

リファレンスファイル文書化指示画面で登録したジョブ情報の一覧として,リファレンスファイル文書化指示フォルダ情報の一覧を出力します。出力するファイルは,「リファレンスファイル文書化指示フォルダ情報出力ファイル」,「フォルダ情報対応ファイル」です。

コマンド引数の指定を省略してリファレンスファイル文書化コマンドを実行した場合,/pが仮定されて実行されます。

/j

リファレンスファイル文書化指示で作成したジョブ登録情報に基づいて,リファレンスファイル文書化を実行します。実行結果を「フォルダ情報対応ファイル」,「リファレンスファイル文書化実行結果ファイル」,および「文書情報対応ファイル」に出力します。

/t:最大実行時間

リファレンスファイル文書化の実行時間を分単位で指定します。実行時間に指定できる範囲は,半角数字で1~1440(最大1日)です。

指定を省略した場合,リファレンスファイル文書化が完了するまで処理を続けます。

/i

全文検索テキストが登録されていない文書もリファレンスファイル文書化の対象にします。

/iを指定しない場合,全文検索テキストが登録されていない文書はリファレンスファイル文書化の対象にならないで,ログ情報が出力されます。

/iを指定した場合,全文検索テキストが登録されていない文書についてもリファレンスファイル文書化の対象とします。このため,/iを指定しないでリファレンスファイル文書化コマンドを実行し,出力されたログ情報でスキップした文書がリファレンスファイル文書化の対象として問題がないことを確認してから,/iを指定して再度リファレンスファイル文書化コマンド実行することを推奨します。

/d:コンテント格納先パス定義ファイルのパス

リファレンスファイル文書化対象文書のコンテント格納先を,文書のプロパティ値ごとに振り分ける場合に,振り分けルールの定義ファイルのパスを指定します。

指定を省略した場合,配置ディスクリプタ(web.xml)のapp.ReferenceContentPathパラメタで指定した格納先にコンテントを格納します。

コンテント格納先パス定義ファイルの定義の詳細については,「6.3.3 リファレンスファイル文書化コマンドで使用するファイル」を参照してください。

戻り値

コマンドの戻り値を取得するときは,コマンドをCSCRIPTから起動してください。

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

表6-7 ecmRFileMove.vbsコマンドの戻り値

戻り値意味備考
0正常終了
1警告付き正常終了リファレンスファイル文書化の対象文書が存在しない
2引数不正エラー
3ファイル入出力エラー
4オブジェクト操作ツールエラー
6環境変数未設定エラー環境変数%MLD_HOME%が未設定または不正
7/t指定による中断/tで指定した最大実行時間に達したため処理を中断
上記以外そのほかのエラー

(凡例) -:該当しません。


ログファイル

コマンドの実行開始,実行終了,および各種エラー情報はログファイルに出力されます。

リファレンスファイル文書化コマンドは,指定した引数により出力されるログファイルが違います。出力されるログファイルとその内容を次の表に示します。

表6-8 ecmRFileMove.vbsコマンドのログファイル

ログファイル名称内容
フォルダ情報対応ファイルリファレンスファイル文書化指示対象フォルダのOIIDとフォルダ名が出力されます。
リファレンスファイル文書化コマンドを実行すると必ず出力されます。
リファレンスファイル文書化指示フォルダ情報出力ファイルリファレンスファイル文書化指示フォルダの一覧が出力されます。
/pを指定した場合出力されます。
リファレンスファイル文書化実行結果ファイルリファレンスファイル文書化コマンドを実行した結果が出力されます。主ファイルと関連ファイルの両方が出力されます。
/jを指定した場合出力されます。
文書情報対応ファイルリファレンスファイル文書化指示対象文書の主ファイルのOIIDと文書名が出力されます。
/jを指定した場合出力されます。

ログファイルは,コマンドを実行するごとに情報が蓄積され,ファイルサイズが増加します。このため,運用時は,定期的にバックアップを取得したあとにログファイルを削除するなどして,ファイルサイズが大きくなり過ぎないようにしてください。

各ログファイルについて,出力先,出力形式,および出力例を説明します。

フォルダ情報対応ファイル

リファレンスファイル文書化指示フォルダ情報出力ファイル

リファレンスファイル文書化実行結果ファイル

ステータスの意味を次の表に示します。関連ファイルに発行されるステータスには,それぞれのステータスの末尾に「_S」が付加されます。

ステータス意味
OKリファレンスファイル文書化に成功しました
SKIP_1主ファイルに文書の実体(コンテント)ファイルが登録されていないためスキップしました
SKIP_2チェックアウト中のためスキップしました
SKIP_3改訂中の公開文書のためスキップしました
SKIP_4全文検索テキストが登録されていないためスキップしました
全文検索テキストは登録されていませんが,すでにリファレンスファイル文書化を実行済みのためスキップしました
SKIP_5すでにリファレンスファイル文書化を実行済みのためスキップしました
SKIP_6PDF形式への変換が終了していない文書のためスキップしました
SKIP_7PDF形式への変換がエラーとなった文書のためスキップしました
ERRリファレンスファイル文書化でエラーが発生しました

文書情報対応ファイル

注意事項