3.2.2 記述形式
実行環境制御ファイルは,五つのセクションと各セクションに指定するエントリによって構成されます。
セクションとエントリは,次のように記述します。
- セクション名は,角括弧([ ])で囲んで指定します。一つのセクションは,セクション名を指定してから,次のセクション名を指定するまで,またはファイルの終端までの範囲です。
- エントリは,「エントリ名=指定値」の形式で指定します。
記述形式は次のとおりです。
[<セクション名>]
〔<エントリ名>=<値>※〕
- 注※
- エントリの値は,その値が数値か文字列かによって記述方法が異なります。
- 数値の場合
任意の10進数を-2,147,483,648~2,147,483,647の間で記述します。
- 文字列の場合
指定できる文字列が限られている場合は,そのうちのどれかの文字列を記述します。任意の文字列を指定する場合は,1,039バイト以内の文字列をシングルクォート(')で囲んで記述します。
各セクションとセクションごとに指定するエントリについて説明します。
なお,各セクション内でエントリが重複して記述されている場合は,最初に指定されたエントリが有効となります。
- <この項の構成>
- (1) Sessionセクション
- (2) Logセクション
- (3) Outputセクション
- (4) FileLinkセクション
- (5) Referenceセクション
(1) Sessionセクション
このセクションには,DocumentBrokerサーバの文書空間に接続するための情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションおよび各エントリの記述は省略できません。省略した場合は,オブジェクト操作ツールの実行時にエラーとなります。
- DocSpaceIdエントリ
- 接続先のDocumentBrokerサーバの文書空間IDをシングルクォート(')で囲んで記述します。
- <記述例>
- DocSpaceId = '673d2be0-d1fd-11d0-ab59-08002be29e1d'
- UserNameエントリ
- オブジェクト操作ツールの実行ユーザとして,接続先のDocumentBrokerサーバに登録されているユーザ名をシングルクォート(')で囲んで記述します。なお,DocumentBrokerサーバで使用しているユーザ管理機能に登録されていないユーザ名を指定した場合は,文書空間に接続するときにエラーが発生します。ユーザ管理機能の詳細については,マニュアル「DocumentBroker Version 3 システム導入・運用ガイド」を参照してください。
- <記述例>
- UserName = 'user01'
- Passwordエントリ
- UserNameエントリに指定したユーザが,接続先のDocumentBrokerサーバにログインするために使用するパスワードをシングルクォート(')で囲んで記述します。
- <記述例>
- Password = 'password01'
(2) Logセクション
このセクションには,オブジェクト操作ツールを実行するときに出力されるコマンド実行ログを制御する情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- Levelエントリ
- コマンド実行ログの出力レベルを指定します。出力レベルには,「None」,「Write」,「Read」または「Error」を記述します。デフォルトは「None」です。省略した場合は,デフォルト値が仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 指定する値についての詳細は,「4.1.2 出力レベル」を参照してください。
- <記述例>
- Level = Read
- FileCountエントリ
- コマンド実行ログを出力するファイルサイズの上限を超えた場合に,切り替えるファイルの数を,2~16の間で記述します。デフォルトは2です。省略した場合は,デフォルト値が仮定されます。このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- <記述例>
- FileCount = 4
- FileSizeエントリ
- コマンド実行ログを出力するファイルサイズを4,096~2,147,483,647(単位はバイト)の間で記述します。デフォルトは1,048,576です。省略した場合は,デフォルト値が仮定されます。このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- <記述例>
- FileSize = 8192
- Directoryエントリ
- コマンド実行ログの出力先ディレクトリを,シングルクォート(')で囲んで記述します。デフォルトは,UNIXの場合は「実行環境ディレクトリ/spool/aclog」,Windowsの場合は「実行環境ディレクトリ¥spool¥aclog」です。省略した場合は,デフォルト値が仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- <記述例>
- Directory = 'c:¥home¥user01¥aclog'
- Prefixエントリ
- コマンド実行ログを出力するファイル名として使用するプリフィックスを,シングルクォート(')で囲んで記述します。デフォルトは「EDMOotAccess」です。省略した場合は,デフォルト値が仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- <記述例>
- Prefix= 'Tool'
(3) Outputセクション
このセクションには,コマンドの実行結果の出力を制御するための情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- LineSizeエントリ
- コマンドの実行結果を出力するときに,1行当たりの出力サイズを記述します。1,022~2,147,483,645(単位はバイト)で記述します。デフォルトは8,190です。省略した場合は,デフォルト値が仮定されます。このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- <記述例>
- LineSize = 1048576
- Formatエントリ
- 一覧取得コマンドの出力形式を選択します。「VR0200」または「VR0112」を指定します。「VR0200」を指定すると,一覧取得コマンドの出力情報として,リンク識別子なども出力されます。「VR0112」を指定すると,Version 1の出力形式と同じ形式で出力します。この場合,リンク識別子は出力されません。デフォルトは,「VR0200」です。
- 指定する値についての詳細は,「5. コマンドリファレンス」の「コマンド実行結果」および各コマンドの実行例を参照してください。
- <記述例>
- Format = VR0200
(4) FileLinkセクション
このセクションには,File Link連携機能を使用する場合の情報を記述します。
セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- DefaultFAMNameエントリ
- コンテントの登録先となるファイルサーバのFAM名を,シングルクォート(')で囲んで記述します。
- このエントリの指定は次の場合に有効になります。
- プロパティ情報ファイルのfilelink_famnameエントリの指定を省略して,dbrcrtdocコマンド(文書の作成)を実行した場合
- -jオプションを省略して,dbrrndrdocコマンド(文書のレンディション操作),またはdbrupdocコマンド(文書のアップロード)を実行した場合
- なお,ファイルサーバのFAM名の詳細については,マニュアル「HiRDB File Link」を参照してください。
- <記述例>
- DefaultFAMName = 'fam01'
- DefaultContentPathエントリ
- コンテントの登録先となるファイルサーバ上のディレクトリのパスを,シングルクォート(')で囲んで記述します。ディレクトリのパスの末尾にはデリミタ「/」(UNIXの場合)または「¥」(Windowsの場合)を記述します。
- このエントリの指定は次の場合に有効になります。
- プロパティ情報ファイルのfilelink_contentpathエントリの指定を省略して,dbrcrtdocコマンド(文書の作成)を実行した場合
- -gオプションを省略して,dbrrndrdocコマンド(文書のレンディション操作),またはdbrupdocコマンド(文書のアップロード)を実行した場合
- エントリに指定したディレクトリが存在しない場合,ディレクトリが作成され,コンテントが登録されます。ただし,ディレクトリのパスの末尾にデリミタ「/」(UNIXの場合)または「¥」(Windowsの場合)を記述しない場合,コンテント名称の自動生成を行わない(FileNamingModeエントリに「Specify」を指定している)環境で,このエントリに指定したディレクトリがファイルサーバ上に存在するとエラーになり,存在しないとこのエントリに指定した名称でコンテントが登録されます。
- なお,コンテントの登録先ディレクトリの詳細については,マニュアル「HiRDB File Link」を参照してください。
- <記述例>
- UNIXの場合に,コンテントの登録先ディレクトリが,「/dir01/data」の下位にある「area1」ディレクトリのときの記述例を次に示します。
指定形式の種別 | 指定例 |
---|
フルパス指定 | DefaultContentPath = '/dir01/data/area1/' |
エイリアス指定 | DefaultContentPath = 'DATA/area1/' (「/dir01/data」のエイリアス名が「DATA」のとき) |
-
- Windowsの場合に,コンテントの登録先ディレクトリが,「c:¥dir01¥data」の下位にある「area1」ディレクトリのときの記述例を次に示します。
指定形式の種別 | 指定例 |
---|
フルパス指定 | DefaultContentPath = 'c:¥dir01¥data¥area1¥' |
エイリアス指定 | DefaultContentPath = 'DATA¥area1¥' (「c:¥dir01¥data」のエイリアス名が「DATA」のとき) |
- FileNamingModeエントリ
- ファイルサーバに登録されるコンテントの名称付与モードを指定します。名称付与モードには,「Auto」または「Specify」を指定します。
- 「Auto」を指定した場合,HiRDB File Linkのコンテントの名称を自動生成する機能を使用して,登録するコンテントの名称を自動生成します。
- 「Specify」を指定した場合,プロパティ情報ファイルのurlエントリに指定されたファイルパスのファイル名が,ファイルサーバに登録されるコンテントの名称となります。
- デフォルトは「Specify」です。省略した場合は,デフォルト値が仮定されます。なお,HiRDB File Linkのコンテントの名称を自動生成する機能の詳細については,マニュアル「HiRDB File Link」を参照してください。
- <記述例>
- FileNamingMode = Specify
- ClientContentDeleteModeエントリ
- クライアントのコンテントを指定して,文書を作成もしくはアップロードする場合,またはレンディションを追加する場合に設定される,文書,文書のバージョン,または文書のレンディションを削除したときの,ファイルサーバ上のコンテントの削除モードを指定します。コンテントの削除モードには,「Sync」または「Async」を指定します。
- 「Sync」を 指定した場合,文書,文書のバージョン,またはレンディションの削除と同期してファイルサーバ上のコンテントを削除します。
- 「Async」を指定した場合,文書,文書のバージョン,またはレンディションを削除してもファイルサーバ上のコンテントは削除されません。
- デフォルトは「Sync」です。省略した場合は,デフォルト値が仮定されます。
- コンテントの削除モードは,文書を作成またはアップロードした時点,もしくはレンディションを追加した時点の設定が有効になります。文書,文書のバージョン,またはレンディションを削除する時に設定を変更しても有効になりません。
- <記述例>
- ClientContentDeleteMode = Sync
- ServerContentDeleteModeエントリ
- ファイルサーバ上に登録されているコンテントを指定して,文書を作成もしくはアップロードする場合,またはレンディションを追加する場合に設定される,文書,文書のバージョン,またはレンディションを削除したときの,ファイルサーバ上のコンテントの削除モードを指定します。コンテントの削除モードには,「Sync」または「Async」を指定します。
- 「Sync」を指定した場合,文書,文書のバージョン,またはレンディションの削除と同期してファイルサーバ上のコンテントを削除します。
- 「Async」を指定した場合,文書,文書のバージョン,またはレンディションを削除してもファイルサーバ上のコンテントは削除されません。
- デフォルトは「Async」です。省略した場合は, デフォルト値が仮定されます。
- コンテントの削除モードは,文書を作成またはアップロードした時点,もしくはレンディションを追加した時点の設定が有効になります。文書,文書のバージョン,またはレンディションを削除する時に設定を変更しても有効になりません。
- なお,コンテントを多重登録する場合(すでにFile Link連携機能を使用してファイルサーバ上に登録されたコンテントを指定して文書を作成もしくはアップロードする場合,またはレンディションを追加する場合)は,このエントリの設定を,前回コンテントを使用した時と同じ設定にする必要があります。
- <記述例>
- ServerContentDeleteMode = Async
(5) Referenceセクション
このセクションには,リファレンスファイル管理機能を使用する場合の情報を記述します。セクションを構成するエントリについて,次に説明します。
- DefaultReferenceTypeエントリ
- デフォルトの,コンテントの格納先とリファレンス種別を指定します。リファレンス種別には「Relative」を指定してください。
- このエントリの指定は次の場合に有効になります。
- プロパティ情報ファイルのreference_typeエントリの指定を省略して,dbrcrtdocコマンド(文書の作成)を実行した場合
- -aオプションを省略して,dbrdelcntrコマンド(コンテナの削除),dbrdeldocコマンド(文書の削除),dbrdowndocコマンド(文書のダウンロード),またはdbrupdocコマンド(文書のアップロード)を実行した場合
- 「Relative」を指定した場合,コンテントの格納先をファイルシステム上の領域とし,コンテントロケーションを相対パスで管理します。
- <記述例>
- DefaultReferenceType = Relative
- DefaultContentBasePathエントリ
- リファレンスファイル文書のリファレンス種別が「Relative」の場合,デフォルトのコンテント格納先ベースパスをシングルクォート(')で囲んで記述します。
- このエントリの指定は次の場合に有効になります。
- プロパティ情報ファイルのreference_contentbasepathエントリの指定を省略して,dbrcrtdocコマンド(文書の作成)を実行した場合
- リファレンス情報ファイルのreference_contentbasepathエントリの指定を省略して,dbrdelcntrコマンド(コンテナの削除)を実行した場合
- -bオプションを省略して,dbrdelcntrコマンド(コンテナの削除),dbrdeldocコマンド(文書の削除),dbrdowndocコマンド(文書のダウンロード),またはdbrupdocコマンド(文書のアップロード)を実行した場合
- このエントリには,リファレンスファイル文書の格納先となるディレクトリの基点となるパスを指定します。例えば,コンテントを「/drv01/dir01/userdir」ディレクトリの下位にある「user01」ディレクトリに格納する場合,「user01」ディレクトリの基点となるパスとして,「/drv01/dir01/userdir」をシングルクォート(')で囲んで指定します。このエントリの指定の末尾に,パスのデリミタ「/」(UNIXの場合)または「¥」(Windowsの場合)を記述する必要はありません。
- このエントリに指定したコンテント格納先ベースパスは,コンテント格納先パスと結合して絶対パスとして使用されます。ContentLocationプロパティには次に示すパスが格納されます。
- aaaa/bbbb/cccc
- aaaa:コンテント格納先パス
- bbbb:DocumentBrokerがコンテントを管理するためのディレクトリ
- cccc:ファイル名※
- 注※
- 次に示すどちらかのファイル名が設定されます。
- 登録ファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにOriginを指定した場合)
- DocumentBrokerが指定するファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにDivideを指定した場合)
- Windowsの場合,デフォルトのコンテント格納先ベースパスにUNC形式のパスを使用することもできます。例えば,「server01」というマシンのネットワーク上で共有しているフォルダ「share」をコンテント格納先ベースパスに指定する場合は,「¥¥server01¥share」をシングルクォート(')で囲んで指定します。
- <記述例>
- DefaultContentBasePath = '/drv01/dir01/userdir'
- DefaultDeleteRootPathエントリ
- リファレンスファイル文書と,リファレンスファイル文書が格納されているディレクトリを同時に削除する場合,デフォルトの削除ディレクトリのルートパスをシングルクォート(')で囲んで記述します。
- このエントリの指定は次の場合に有効になります。
- リファレンス情報ファイルのreference_deleterootpathエントリの指定を省略して,dbrdelcntrコマンド(コンテナの削除)を実行した場合
- -yオプションを省略して,dbrdelcntrコマンド(コンテナの削除)またはdbrdeldocコマンド(文書の削除)を実行した場合
- このエントリには,削除するディレクトリのルートパスを指定します。例えば,「/drv01/dir01/userdir/user01/<DocumentBrokerがコンテントを管理するためのディレクトリ>/<登録ファイル名>」のディレクトリ中の「user01」ディレクトリ以下のディレクトリを削除する場合は,「user01」ディレクトリのルートパスとして,「/drv01/dir01/userdir」をシングルクォート(')で囲んで指定します。ただし,コンテント格納先べースパスの上位のディレクトリは指定できません。また,エントリの指定の末尾に,パスのデリミタ「/」(UNIXの場合)または「¥」(Windowsの場合)を記述する必要はありません。
- DocumentBrokerがコンテントを管理するためのディレクトリは,このエントリまたはコマンドオプションで削除ディレクトリのルートパスの指定を省略した場合も,コンテントと同時に削除されます。
- Windowsの場合,デフォルトの削除ディレクトリのルートパスにUNC形式のパスを使用することもできます。例えば,「server01」というマシンがネットワーク上で共有しているフォルダ「share」を削除ディレクトリのルートパスに指定する場合は,「¥¥server01¥share」をシングルクォート(')で囲んで指定します。
- <記述例>
- DefaultDeleteRootPath = '/drv01/dir01/userdir'
- ContentDeleteModeエントリ
- リファレンスファイル文書を削除する場合の削除モードを指定します。削除モードには,「Auto」または「Specify」を指定します。デフォルト値は「Specify」です。
- 「Auto」を指定した場合,DocumentBrokerが自動的にリファレンスファイル文書かどうかを判別して,リファレンスファイル文書を削除します。
- 「Specify」を指定した場合,dbrdelcntrコマンド(コンテナの削除)またはdbrdeldocコマンド(文書の削除)の,-kオプションの指定に従って文書を削除します。このとき,-kオプションを省略すると,エラーになります。ContentDeleteModeエントリの指定とdbrdelcntrコマンド(コンテナの削除)およびdbrdeldocコマンド(文書の削除)の実行結果の対応を次の表に示します。
表3-2 ContentDeleteModeエントリの指定とdbrdelcntrコマンド,dbrdeldocコマンドの実行結果
削除する文書の種類 | ContentDeleteModeエントリの指定 | -kオプションの指定 | 実行結果 |
---|
リファレンスファイル文書 | Auto | Reference | ○ |
- | ○ |
Specify | Reference | ○ |
- | × |
リファレンスファイル文書以外 | Auto | Reference | ○ |
- | ○ |
Specify | Reference | ○ |
- | ○ |
- (凡例)
- -:指定しません。
- ○:削除されます。
- ×:エラーになるため,削除されません。
- <記述例>
- ContentDeleteMode = Auto