ecmRegisterDocuments.bat文書登録

形式

ecmRegisterDocuments.bat -d 文書空間識別子
                        -u ユーザID
                        -p パスワード
                      〔-b 共通のフォルダパス〕
                      〔-f フォルダパスの区切り文字〕
                      〔-e ファイル形式変換対象の拡張子〕
                      〔-m ファイル形式変換先のMIMEタイプ〕
                        -r 登録情報ファイル
                      〔-l ログファイルの出力先〕
                      〔-c〕
                      〔-s 関連ファイルの監査証跡ログ出力指定〕
                      〔-h 文書ファイルの最大ファイルサイズ〕
                      〔-n〕
                      〔-?〕

機能

Excelなどで作成したCSV形式の登録情報ファイルに基づいて,複数の一般文書をDocumentBroker Standard GUIに登録します。

コマンド引数

-d 文書空間識別子

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

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

-u ユーザID

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

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

-p パスワード

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

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

-b 共通のフォルダパス

すべての文書の登録先フォルダが同じフォルダの下位の場合に,共通するフォルダまでのフォルダパスを指定します。登録情報ファイルには,この引数に指定したフォルダの直下にあるフォルダから登録先フォルダまでのフォルダ名を指定してください。

この引数に,共通するフォルダまでのフォルダパスを指定することで,登録情報ファイルでのフォルダ名の指定を簡略化できます。

例えば,登録先フォルダが「部門/営業部/東京営業部/営業1課/国内プロジェクト」の文書Aと,登録先フォルダが「部門/営業部/東京営業部/営業5課/海外プロジェクト」の文書Bがあるとします。文書Aと文書Bでは,登録先フォルダのパスの「部門/営業部/東京営業部」の部分が共通です。そのため,この引数に「部門/営業部/東京営業部」を指定することで,登録情報ファイルではフォルダ名「部門/営業部/東京営業部」の指定を省略できます。

また,文書の登録先フォルダがすべて同じ場合は,この引数に登録先フォルダのパスを指定することで,登録情報ファイルではフォルダ名の指定を省略できます。

フォルダのパスは「/」で区切って指定します。なお,区切り文字は引数「-f」で指定することもできます。

この引数の指定を省略する場合,登録情報ファイルには1階層目から登録先フォルダまでのフォルダ名を指定する必要があります。

引数「-b」の指定例を次に示します。

(指定例)
次のように指定すると,文書の登録先がフォルダ「東京営業部」の下位になります。
-b△部門/営業部/東京営業部

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

-f フォルダパスの区切り文字

引数「-b」に指定する登録先フォルダのパスの区切り文字を1文字で指定します。

この引数の指定を省略すると,区切り文字を「/」とします。

-e ファイル形式変換対象の拡張子

一般文書のファイル形式変換機能を使用する場合,ファイル形式の変換対象とする拡張子を指定します。配置ディスクリプタ(web.xml)のapp.RenderingExtListパラメタと同じ値を指定してください。なお,拡張子の大文字と小文字は区別しません。

複数の拡張子を指定するときは,拡張子を「,(コンマ)」で区切って指定します。

この引数の指定を省略すると,一般文書のファイル形式変換機能を使用しないで文書を登録します。

(指定例)
-e△doc,xls,ppt,txt

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

-m ファイル形式変換先のMIMEタイプ

一般文書のファイル形式変換機能を使用する場合,変換先のファイル形式のMIMEタイプを指定します。このパラメタには,必ずapplication/pdfを指定してください。

引数「-e」の指定を省略すると,この引数の指定は無視されます。

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

(指定例)
-m△application/pdf

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

-r 登録情報ファイル

登録情報ファイルのパスをフルパスで指定します。

登録情報ファイルは事前に作成しておく必要があります。登録情報ファイルの詳細は,「6.3.1(1) 登録情報ファイル」を参照してください。

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

-l ログファイルの出力先

文書登録コマンドの実行結果を出力するログファイルのファイルパスを指定します。ファイルパスはフルパスで指定します。指定した出力先にすでにログファイルがある場合は,ファイルが上書きされます。

ログファイルはCSV形式です。文字コード種別はShift-JISです。

ログファイルには,引数「-r」に指定する登録情報ファイルと同じ項目が出力されます。登録情報ファイルの項目の詳細は,「6.3.1(1) 登録情報ファイル」を参照してください。

引数「-r」と引数「-l」に同じファイルパスを指定した場合,登録情報ファイルがログファイルで上書きされます。

-c

登録情報ファイルが正しく記述されているかをチェックします。チェックする項目を次に示します。

この引数を指定すると,登録情報ファイルが正しいかどうかのチェックだけが行われ,文書は登録されません。

-s 関連ファイルの監査証跡ログ出力指定

関連ファイルに対する操作の監査証跡ログを出力するかどうかを次の値で指定します。

不正な値を指定した場合は,エラーとなります。

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

-h 文書ファイルの最大ファイルサイズ

文書ファイルの最大ファイルサイズを,次の範囲で指定します。

0~2,147,483,647(バイト)

文書ファイルの最大サイズが,ここで指定した値を超えていないかをチェックします。指定した値を超える文書ファイルを登録しようとした場合は,エラーとなります。0を指定した場合は,文書ファイルの最大サイズのチェックをしません。指定を省略した場合は,0が仮定されます。

なお,最大サイズのチェックは主ファイルと関連ファイルの合計ではなく,ファイルごとにします。例えば,-hに20MBを指定した場合は次のとおりとなります。

なお,ファイルサイズが大きい場合,文書の操作にかなりの時間が必要となり,メモリ所要量が増大するため,システムに負荷が掛かります。さらに,物理メモリを増強しても,プロセスに割り当てられるメモリ所要量には限界があります。このため文書ファイルの最大サイズは20MBまで(稼働環境において物理的にメモリを確保できることが前提)を推奨します。

-n

すべてのフォルダ情報を取得しないで,登録情報ファイルに指定されたフォルダ情報だけを取得します。大量のフォルダが登録されている環境の場合,この引数の指定により登録性能の向上が期待できます。ただし,1つの登録情報ファイル内で大量のフォルダに文書を登録する場合は,登録性能が向上しないおそれがあります。

-?

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

この引数を指定すると,コマンドの使用方法の出力だけが行われ,文書は登録されません。

戻り値

なし

実行例

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

ecmRegisterDocuments.bat△-d△2f44eb5e-e211-44f1-b8c0-b589b6fafa0d△-u△admin△-p△pass△-r△C:¥work¥documents.csv△-l△C:¥work¥log.csv

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

注意事項