5.3.6 実行環境制御ファイル(EDMOotCtrl.ini)
(1) 実行環境制御ファイルの記述形式
[セクション名]
エントリ名 = 値
- セクション名は,[ ](角括弧)で囲んで指定します。一つのセクションは,セクション名を指定してから,次のセクション名を指定するまで,またはファイルの終端までの範囲です。
- エントリは,「エントリ名 = 値」の形式で指定します。
- エントリは,その値が数値か文字列かによって記述方法が異なります。
- 数値の場合
任意の10進数を-2,147,483,648~2,147,483,647の間で記述します。
- 文字列の場合
指定できる文字列が限られている場合は,そのうちのどれかの文字列を記述します。任意の文字列を指定する場合は,1,039バイト以内の文字列を「'」(シングルクォーテーション)で囲んで記述します。
- 同一名のエントリを複数指定した場合,最初に指定したセクションが有効になります。
- 印刷可能なASCIIコードで記述してください。
- 「;」(セミコロン)または「#」(シャープ)で始まる行は,コメント行と見なされます。
- 空白行は無視されます。
- 行の終端は改行コードまたはEOFです。なお,改行コードはCR+NL(0x0d+0x0a)です。
- ファイルの終端はEOFです。
(2) 実行環境制御ファイルの詳細
実行環境制御ファイルは,次に示すセクションと各セクションに指定するエントリによって構成されます。
- [Session]セクション
- [Log]セクション
- [Output]セクション
- [Reference]セクション
以降,実行環境制御ファイルを構成する各セクションとセクションごとに指定するエントリについて説明します。
(a) [Session]セクション
このセクションには,File Sharingサーバの文書空間に接続するための情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションおよび各エントリの記述は省略できません。省略した場合は,オブジェクト操作ツールの実行時にエラーとなります。
- DocSpaceIdエントリ
- 接続先のFile Sharingサーバの文書空間識別子を「'」(シングルクォーテーション)で囲んで記述します。
- 記述例
DocSpaceId = '673d2be0-d1fd-11d0-ab59-08002be29e1d'
- UserNameエントリ
- オブジェクト操作ツールの実行ユーザとして,セキュリティ管理者のユーザ名を「'」(シングルクォーテーション)で囲んで記述します。
- 記述例
UserName = 'user01'
- Passwordエントリ
- セキュリティ管理者が接続先のFile Sharingサーバにログインするために使用するパスワードを「'」(シングルクォーテーション)で囲んで記述します。
- Passwordエントリの内容は変更しないでください。提供されるファイルの内容をそのまま使用してください。
(b) [Log]セクション
このセクションには,オブジェクト操作ツールを実行するときに出力されるコマンド実行ログを制御する情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- Levelエントリ
- コマンド実行ログの出力レベルを指定します。指定した出力レベルによってコマンド実行ログに出力する出力ログ情報を調節します。
- 取得される情報の詳細については,「9.1.7 オブジェクト操作ツールのコマンド実行ログ」を参照してください。なお,指定を省略した場合,Noneが仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 出力レベルによる出力ログ情報を次の表に示します。
表5-20 コマンド実行ログの出力レベルと出力ログ情報
出力レベル | 出力ログ情報 |
---|
None | 出力なし |
Write | - セッションの確立・切断
- オブジェクトの作成・削除
- プロパティの設定
|
Read | - 出力レベルが「Write」の場合の出力ログ情報
- プロパティの取得
- 問い合わせの実行および結果の取得
|
Error | - 出力レベルが「Read」の場合の出力ログ情報
- エラー
|
- 記述例
Level = Read
- FileCountエントリ
- コマンド実行ログを出力するファイルサイズの上限を超えた場合に,切り替えるファイルの数を,2~16の間で記述します。
- 出力ファイル名は「出力ファイル名プリフィックス_NO.log」で,「出力ファイル名プリフィックス」はPrefixエントリの指定値を示し,「NO」は出力ファイル通番を示します。出力ファイル通番とは,1~FileCountエントリに指定した数(出力ファイル数)です。
- コマンド実行ログは,出力ファイル通番が1のファイルから順番に出力されます。あるファイルにコマンド実行ログを出力する場合に,ファイルサイズがFileSizeエントリに指定した出力ファイルサイズよりも大きくなるとき,出力ファイル通番が一つ大きいファイルに出力します。例えば,出力ファイル通番が1であるファイルにコマンド実行ログを出力する場合に,このファイルのサイズの最大量を超えてしまうときは,ファイル出力通番が2のファイルにログを出力します。
- FileCountエントリに指定した最大のファイル通番のファイルにコマンド実行ログを出力しようとして,そのファイルのファイルサイズがFileSizeエントリに指定した出力ファイルサイズよりも大きくなってしまう場合,出力ファイル通番が1のファイルを初期化してログの出力を継続します。
- 指定を省略した場合,2が仮定されます。
- このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 記述例
FileCount = 4
- FileSizeエントリ
- コマンド実行ログを出力するファイルサイズを4,096~2,147,483,647(バイト)の間で記述します。デフォルトは1,048,576です。省略した場合は,デフォルト値が仮定されます。このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 記述例
FileSize = 8192
- Directoryエントリ
- コマンド実行ログの出力先ディレクトリを,「'」(シングルクォーテーション)で囲んで記述します。デフォルトは,「{オブジェクト操作ツールの実行環境ディレクトリ}¥spool¥aclog」です。省略した場合は,デフォルト値が仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 記述例
Directory = 'c:¥home¥user01¥aclog'
- Prefixエントリ
- コマンド実行ログを出力するファイル名として使用するプリフィックスを,「'」(シングルクォーテーション)で囲んで記述します。デフォルトはEDMOotAccessです。省略した場合は,デフォルト値が仮定されます。不正な値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 記述例
Prefix= 'Tool'
(c) [Output]セクション
このセクションには,コマンドの実行結果の出力を制御するための情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- LineSizeエントリ
- コマンドの実行結果を出力するときに,1行当たりの出力サイズを記述します。1,022~2,147,483,645(バイト)で記述します。デフォルトは8,190です。省略した場合は,デフォルト値が仮定されます。このエントリで指定できる範囲外の値が指定されている場合は,デフォルト値が仮定されます。なお,数値として指定できる範囲外の値が指定されている場合は,オブジェクト操作ツールの実行時にエラーとなります。
- 記述例
LineSize = 1048576
- Formatエントリ
- 一覧取得コマンドの出力形式を選択します。VR0200またはVR0112を指定します。この指定によって,出力される情報量を選択できます。VR0200を指定すると詳細な情報が出力され,VR0112を指定すると簡略化された情報が出力されます。デフォルトは,VR0200です。
- 指定する値の詳細は,「8.5.2(2) オブジェクト操作ツールのコマンドの実行結果」を参照してください。
- 記述例
Format = VR0200
(d) [Reference]セクション
このセクションには,ファイル実体の格納方法についての情報を記述します。セクションを構成するエントリについて,次に説明します。なお,このセクションを省略した場合,各エントリの値はデフォルト値が仮定されます。
- DefaultReferenceTypeエントリ
- ファイル実体の格納先とデータベースで管理する方法の種別(リファレンス種別)のデフォルトを指定します。
- 指定できる値は「Relative」です。デフォルト値はありません。
- Relativeは,ファイル実体を任意のファイルシステム上のファイル保管領域に格納することを示す値です。また,データベースには,ファイル実体の格納先を示すパス情報が登録されます。登録されるパス情報は,ベースパスからの相対パスです。
- DefaultContentBasePathエントリ
- ファイル実体の格納先のデフォルトのベースパスを,「'」(シングルクォーテーション)で囲んで記述します。デフォルト値はありません。この指定は,コマンドのオプションでベースパスの指定を省略した場合に有効になります。
- 例えば,ファイル実体がベースパス「C:¥dir01¥userdir」ディレクトリ下の「user01」ディレクトリに登録されている場合は,ベースパスとして「C:¥dir01¥userdir」を「'」(シングルクォーテーション)で囲んで指定します。ベースパスは,UNC形式でも指定できます。例えば,ベースパスをネットワーク上のマシン「SERVER01」下の共有ディレクトリ「userdir」を指定する場合は「¥¥SERVER01¥userdir」を「'」(シングルクォーテーション)で囲んで指定します。
- なお,このエントリに指定するベースパスと,ファイルの属性情報として管理しているファイル実体格納先の相対パスは,結合されて絶対パスとして使用されます。ベースパスの末尾またはファイル実体格納先の相対パスの先頭にパスの区切り文字が存在しない場合は,File Sharingサーバによって区切り文字が挿入されます。このため,パスの区切り文字は指定しなくてもかまいません。
- DefaultDeleteRootPathエントリ
- ファイルを削除する場合に,ファイル実体の削除と同時にファイルを格納したディレクトリも削除するときに指定します。削除するディレクトリのルートパスのデフォルトを,「'」(シングルクォーテーション)で囲んで指定します。この指定は,コマンドのオプションで,削除ディレクトリのルートパス指定を省略した場合に有効になります。デフォルト値はありません。
- DefaultContentBasePathエントリに指定するベースパスと同じパスを指定してください。
- ContentDeleteModeエントリ
- ファイルを削除するときに,ファイルの属性情報とファイル実体をまとめて削除するか,ファイルの属性情報だけを削除するかを指定します。このエントリに指定した値とコマンドの-kオプションの指定の組み合わせによって,ファイル実体が削除されるかどうかが決まります。
- 提供されるサンプルファイルで指定されている「Auto」のままで使用してください。なお,省略した場合のデフォルト値は「Specify」になります。
- Auto
コマンドで-kオプションの指定を省略した場合も,ファイル実体が削除されます。
- Specify
コマンドで-kオプションの指定を省略すると,ファイル実体が削除されません。
(3) 実行環境制御ファイルの記述例
-x CREATEオプションを指定して実行環境セットアップコマンドを実行した場合にコピーされる実行環境制御ファイルは次のとおりです。
[tab]はタブの制御文字を示します。
[Session]
DocSpaceId = '673d2be0-d1fd-11d0-ab59-08002be29e1d'
UserName = 'user'
Password = '3[tab]0'
[Reference]
DefaultReferenceType = Relative
ContentDeleteMode = Auto
このファイルの太字の個所を,それぞれのオブジェクト操作ツールの実行環境に応じて編集します。また,必要なエントリを追加してください。「UserName」は必ず編集してください。
実行環境制御ファイルの記述例を次に示します。
;; Session
[Session]
DocSpaceId = '673d2be0-d1fd-11d0-ab59-08002be29e1d'
UserName = 'user'
Password = '3[tab]0'
;; Log
[Log]
Level = Read
FileCount = 4
FileSize = 8192
Directory = 'c:¥home¥user01¥aclog'
Prefix = 'Tool'
;; Output
[Output]
LineSize = 1048576
Format = VR0200
;; Reference
[Reference]
DefaultReferenceType = Relative
DefaultContentBasePath = '¥¥SERVER01¥share¥REFERENCE_AREA1'
DefaultDeleteRootPath = '¥¥SERVER01¥share¥REFERENCE_AREA1'
ContentDeleteMode = Auto