4.16.2 文書空間情報ファイルの記述形式
ここでは,文書空間情報ファイルの記述形式について説明します。
- <この項の構成>
- (1) 記述規則
- (2) 記述形式
- (3) [System]セクション
- (4) [RdAreaName]セクション
- (5) [RdAreaName]セクションで指定するRDエリアのエントリ指定と,割り当てられる領域の関係
(1) 記述規則
文書空間情報ファイルの記述規則を次に示します。
- 印刷可能なASCIIコードで記述します。
- 空白行は無視します。
- 「#」(シャープ)および「;」(セミコロン)で始まる行はコメントとして扱います。
- 各行は行の終端を除いて,2,046バイト以内で記述します。
- 行の終わりは,<EOF>または行末文字です。
- 行末文字は,<CR>+<LF>です。
- ファイルの終端は<EOF>です。
(2) 記述形式
文書空間情報ファイルは,次に示す二つのセクションと,各セクションに指定するエントリによって構成されています。
- [System]セクション
- [RdAreaName]セクション
セクションとエントリの記述規則を次に示します。
- セクション名は,[ ](角括弧)で囲んで指定します。一つのセクションは,セクション名を指定してから,次のセクションを指定するまで,またはファイルの終端までの範囲です。
- エントリは,「エントリ名=値」の形式で指定します。
- セクション名およびエントリ名は127バイト以内,値は1,023バイト以内で指定します。
- 指定できないセクションを指定した場合,指定したセクションはすべて無視されます。
- セクションを重複して記述している場合,エラーになります。
- セクション内でエントリを重複して記述している場合,エラーになります。
- 指定できないエントリを指定した場合,エラーになります。
- エントリの指定を無視する場合にも,値をチェックします。
記述形式を次に示します。
- [<セクション名>]
- <エントリ名>=<値>
以降,文書空間情報ファイルを構成する各セクションと,セクションごとに指定するエントリについて説明します。
(3) [System]セクション
システム全体のパラメタを定義します。[System]セクションを構成する各エントリは次のとおりです。
- AccessControlエントリ
- アクセス制御機能の使用の有無を指定します。
- ON
アクセス制御機能を使用します。この値を指定した場合は,セキュリティ運用者を設定してください。セキュリティ運用者は,セキュリティ定義ファイルおよびユーザ権限定義ファイルを作成してください。
- OFF
アクセス制御機能を使用しません。
- なお,このエントリは省略できません。
- PublicACLCountエントリ
- パブリックACLを作成するオブジェクト数を指定します。0~2,147,483,647の範囲で指定します。
- AccessControlエントリにONを指定した場合,有効になります。OFFを指定した場合,指定を無視します。
- 指定を省略した場合,「0」が仮定されます。
- AvBindPublicACLCountエントリ
- パブリックACLの平均バインド数を指定します。0~10の範囲で指定します。
- AccessControlエントリにONを指定した場合,有効になります。OFFを指定した場合,指定を無視します。
- 指定を省略した場合,「0」が仮定されます。
- AvLocalACECountエントリ
- ローカルACLの平均ACE数を指定します。0~64の範囲で指定します。
- AccessControlエントリにONを指定した場合,有効になります。OFFを指定した場合,指定を無視します。
- 指定を省略した場合,「0」が仮定されます。
- AvSecurityACECountエントリ
- セキュリティACLの平均ACE数を指定します。0~64の範囲で指定します。
- AccessControlエントリにONを指定した場合,有効になります。OFFを指定した場合,指定を無視します。
- 指定を省略した場合,「0」が仮定されます。
- LogModeTypeエントリ
- 文書のコンテントのログ取得モードを指定します。文書クラス定義ファイルのクラス定義のContentTypeエントリにSingleまたはMultiFileを指定する場合だけ有効になります。
- ALL
ログ取得モードでユーザLOB用RDエリアを運用する場合に指定します。ログ取得モードで運用すると,ロールバックおよびロールフォワードに必要なデータベースの更新ログを取得します。
- PARTIAL
更新前ログ取得モードでユーザLOB用RDエリアを運用する場合に指定します。更新前ログ取得モードで運用すると,ロールバックに必要なデータベースの更新ログを取得します。
- NONE
ログレスモードでユーザLOB用RDエリアを運用するときに指定します。ログレスモードで運用すると,データベースの更新ログを取得しません。
- 指定を省略した場合,「ALL」が仮定されます。
- ReferenceFileエントリ
- リファレンスファイル管理機能の使用の有無を指定します。文書クラス定義ファイルのクラス定義のContentTypeエントリにReferenceを指定する場合,このエントリにはONを設定します。
- ON
リファレンスファイル管理機能を使用します。
- OFF
リファレンスファイル管理機能を使用しません。
- 指定を省略した場合,「OFF」が仮定されます。
- FileLinkエントリ
- FileLink連携機能の使用の有無を指定します。文書クラス定義ファイルのクラス定義のContentTypeエントリにFileLinkを指定する場合,このエントリにはONを設定します。
- ON
FileLink連携機能を使用します。
- OFF
FileLink連携機能を使用しません。
- 指定を省略した場合,「OFF」が仮定されます。
- MultiFileMaxCountエントリ
- マルチファイル管理機能を使用する場合に,一つの文書で管理できるファイルの最大数を指定します。2~4,096の範囲で指定します。
- 文書クラス定義ファイルのクラス定義のContentTypeエントリにMultiを指定する場合,このエントリに値を設定します。
- 指定を省略した場合,マルチファイル管理機能は使用できません。
- AvMultiFileCountエントリ
- マルチファイル管理機能を使用する場合に,一つの文書の平均ファイル数を指定します。文書クラス定義情報ファイルのクラス定義でバージョンなし文書またはバージョン付き文書のクラスを定義して,文書の種別にマルチファイル文書を使用するクラスを指定して,文書空間定義コマンド(EDMCDefDocSpace)を実行した場合の見積もり基礎情報ファイルの行の数は,このエントリの指定によって決まります。
- このエントリは,MultiFileMaxCountエントリを指定していない場合,無効となります。また,このエントリは,MultiFileMaxCountエントリを指定した場合,必須となります。MultiFileMaxCountエントリの指定値以内で指定してください。
- なお,このエントリは省略できません。
- MultiRelationIndexエントリ
- 複数列インデクスを指定して,複数の同じ文書オブジェクトを,同時に一つの文書オブジェクトに対して関連づけるかどうかを指定します。
- ON
複数の異なる文書オブジェクトを,同時に一つの文書オブジェクトに対して関連づける場合にも指定できます。次に示すクラスのプロパティに対して複数列インデクスを定義します。
edmClass_Relationshipクラス
dmaProp_Headプロパティ
- OFF
複数列インデクスを指定しません。この場合,単一列インデクスが定義されます。
- 指定を省略した場合,「OFF」が仮定されます。
- UserIDMaxLengthエントリ
- ユーザ識別子の最大長を255バイト以上に拡張する場合に指定します。ユーザ識別子の最大長をバイト単位で指定します。255~512(バイト)の範囲で指定します。
- 指定を省略した場合,ユーザ識別子の最大長は254バイトになります。
- GroupIDMaxLengthエントリ
- グループ識別子の最大長を255バイト以上に拡張する場合に指定します。グループ識別子の最大長をバイト単位で指定します。255~512(バイト)の範囲で指定します。
- 指定を省略した場合,グループ識別子の最大長は254バイトになります。
- SpPropDefaultValueエントリ
- プロパティのデフォルト値をクラスごとに設定する場合に指定します。
- 複数のクラスに対して同じ名前のプロパティを追加する場合に,クラスごとにプロパティのデフォルト値を設定できます。
- ON
クラスごとにプロパティのデフォルト値を設定します。
- OFF
プロパティで同一のデフォルト値を設定します。
- プロパティのデフォルト値は,文書クラス定義ファイルのDefaultValueエントリに指定します。文書クラス定義ファイルについては,「4.16 文書クラス定義ファイル」を参照してください。
- 指定を省略した場合,「OFF」が仮定されます。
- DocSpaceCharacterSetエントリ
- 文書空間で使用する文字コード種別を指定します。
- SJIS
文書空間で使用する文字コード種別をShift-JISとします。
- UTF-8
文書空間で使用する文字コード種別をUTF-8とします。
- 指定を省略した場合,「SJIS」が仮定されます。
(4) [RdAreaName]セクション
RDエリア名を定義します。[RdAreaName]セクションを構成する各エントリは次のとおりです。
- MetaTblNameエントリ
- メタ情報の表を格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てる表の数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:METATBL0000001)が順次割り当てられます※。
- 指定を省略した場合,「METATBL」が仮定されます。
- MetaIdxNameエントリ
- メタ情報の表に定義されるインデクスを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てるインデクス数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:METAIDX0000001)が順次割り当てられます※。
- 指定を省略した場合,「METAIDX」が仮定されます。
- SysTblNameエントリ
- システムが定義する表を格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てる表の数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:SYSTBL0000001)が順次割り当てられます※。
- 指定を省略した場合,「SYSTBL」が仮定されます。
- SysIdxNameエントリ
- システムが定義する表に定義されるインデクスを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てるインデクス数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:SYSIDX0000001)が順次割り当てられます※。
- 指定を省略した場合,「SYSIDX」が仮定されます。
- UsrTblNameエントリ
- ユーザが定義する表を格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てる表の数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:USRTBL0000001)が順次割り当てられます※。
- 指定を省略した場合,「USRTBL」が仮定されます。
- UsrIdxNameエントリ
- ユーザが定義する表に定義されるインデクスを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- RDエリアに割り当てるインデクス数が500(HiRDBでの最大値)を超えると,指定値の後ろに7けたの追番が付いた別名称(例:USRIDX0000001)が順次割り当てられます※。
- 指定を省略した場合,「USRIDX」が仮定されます。
- DocTblNameエントリ
- 文書用LOBエリアを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- 指定を省略した場合,「DOC」が仮定されます。
- MultiDocTblNameエントリ
- マルチファイル文書用LOBエリアを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- 指定を省略した場合,「MULTIDOC」が仮定されます。
- SgmlTextNameエントリ
- 全文検索用の文書内容を格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- 全文検索用の表が複数指定された場合は,指定値の後ろに7けたの追番が付いた別名称(例:SGMLTXT0000001)が順次割り当てられます※。
- 指定を省略した場合,「SGMLTXT」が仮定されます。
- NgramIdxNameエントリ
- 全文検索用のインデクスを格納するRDエリアのRDエリア名を指定します。1~23(バイト)の文字列を指定します。
- 全文検索用の表が複数指定された場合は,指定値の後ろに7けたの追番が付いた別名称(例:NGRAMIDX0000001)が順次割り当てられます※。
- 指定を省略した場合,「NGRAMIDX」が仮定されます。
- 注
- RDエリア名には,すでに使用されているRDエリア名を指定しないでください。すでに使用されているRDエリア名を指定した場合のエラーチェックは行いません。そのため,RDエリアに割り当てる表およびインデクス数のチェックにRDエリアで使用されている表およびインデクス数は,RDエリアで使用されていないものとして,指定された表およびインデクスによって1からカウントされます。
- 次のRDエリア名には,ほかのエントリと重複しないRDエリア名を指定してください。
- LOBエリア格納用(DocTblNameエントリ,MultiDocTblNameエントリ)
- 全文検索用文書の内容格納用(SgmlTextNameエントリ)
- 全文検索インデクス格納用(NgramIdxNameエントリ)
- 自動的に付与される名称(7けたの追番が付与された別名称)と一致する名称は,各エントリに指定できません。
- 同じ表のインデクスが,複数のRDエリアに割り当てられないように調整されるため,インデクス数が一つのRDエリアに対して500未満となる場合があります。
- 指定できるRDエリア名称は,DocumentBrokerのエリア名の規則に従ってください。空白またはハイフンを含むRDエリア名は指定できません。空白を含むRDエリア名を指定した場合,EDMCBuildDocSpaceコマンド実行時にKMBR16920-Eのメッセージ(エラー情報:rc=5)またはKMBR10226-Wのメッセージが出力されてエラーとなるか,またはデータベース定義ユティリティ実行時にデータベースのエラーとなります。ハイフンを含むRDエリア名を指定した場合,文書空間構築コマンド(EDMCBuildDocSpace)実行時,またはデータベース定義ユティリティ実行時にデータベースのエラーとなります。
- 注※
- 割り当てられた名称は,見積もり基礎情報ファイルで確認できます。割り当てられたRDエリア名称を変更したい場合には,見積もり基礎情報ファイルの内容を基に,文書空間定義コマンド(EDMCDefDocSpace)で出力されるRDエリア定義情報ファイルを修正してください。
(5) [RdAreaName]セクションで指定するRDエリアのエントリ指定と,割り当てられる領域の関係
文書空間定義コマンド(EDMCDefDocSpace)のデフォルトの指定では,メタ情報格納用のRDエリア,システム用RDエリア,ユーザ用RDエリアの分類ごとにRDエリア名を割り当て,RDエリアの分類ごとにインデクス用のRDエリア名を割り当てます。RDエリアの分類と割り当てられるRDエリア名の関係を次の表に示します。
表4-36 RDエリアの分類と割り当てられるRDエリア名の関係
RDエリアの分類 | RDエリアに格納する要素 | 割り当てられるRDエリア名 |
---|
メタ情報格納用のRDエリア | メタ情報を格納する表 | MetaTblNameエントリの指定値 |
メタ情報を格納する表に設定するインデクス | MetaIdxNameエントリの指定値 |
システム用RDエリア | システムが定義する表 | SysTblNameエントリの指定値 |
システムが定義する表に設定するインデクス | SysIdxNameエントリの指定値 |
ユーザ用RDエリア | ユーザが定義するサブクラスに対応する表 | UsrTblNameエントリの指定値 |
ユーザが定義するサブクラスに対応する表に設定されるインデクス | UsrIdxNameエントリの指定値 |
HiRDB繰り返し列のインデクス | -※ |
注※ インデクスは指定できないため,RDエリア名は割り当てられません。