uCosminexus DocumentBroker Version 3 システム導入・運用ガイド
![[目次]](figure/content.gif)
![[用語]](figure/gloss.gif)
![[索引]](figure/index.gif)
![[前へ]](figure/front.gif)
4.2.2 DocumentSpace構成定義ファイルの記述形式
ここでは,DocumentSpace構成定義ファイルの記述形式について説明します。
DocumentSpace構成定義ファイルは,次に示す二つのセクションと,各セクションに指定するエントリによって構成されます。
- [DocSpace]セクション
- [Entry0001]セクション
セクションとエントリの記述規則を次に示します。
- セクション名は,[ ](角括弧)で囲んで指定します。一つのセクションは,セクション名を指定してから,次のセクション名を指定するまで,またはファイルの終端までの範囲です。
- エントリは,「エントリ名=指定値」の形式で指定します。
- 「;」(セミコロン)で始まる行はコメント行として扱われます。
- 文書空間で使用する文字コード種別がUTF-8の場合は,印刷可能なASCIIコードで記述します。
記述形式を次に示します。
- [<セクション名>]
- <エントリ名>=<値>
以降,DocumentSpace構成定義ファイルを構成する各セクションと,セクションごとに指定するエントリについて説明します。
- <この項の構成>
- (1) [DocSpace]セクション
- (2) [Entry0001]セクション
(1) [DocSpace]セクション
文書空間の共通定義を指定します。[DocSpace]セクションを構成する各エントリは次のとおりです。
- Countエントリ
- DocumentBrokerが提供する文書空間の数を指定します。「1」を指定してください。なお,このエントリの指定は省略できません。
- DocSpaceOrbBoaOptionエントリ
- 文書空間のサービスプロセスの状態を監視するサービスプロセス監視プロセスに対してORBおよびBOAのオプションを指定します。指定を省略した場合,「-OAthreadMax 64 -OAlocalipc 0」が仮定されます。なお,指定できるオプションについては,マニュアル「VisiBroker for C++ プログラマーズガイド」を参照してください。
- なお,このエントリは,TPBroker V3環境の場合に指定するエントリです。TPBroker V5と連携して動作する環境では指定できません。TPBroker V5環境で指定した場合は,指定が無視され省略値も有効になりません。TPBroker V5環境では,VisiBrokerプロパティとしてDocSpaceVBPropertyエントリに指定してください。
- DocSpaceVBPropertyエントリ
- 文書空間のサービスプロセスの状態を監視するサービスプロセス監視プロセスに対してVisiBrokerプロパティを指定します。指定を省略した場合,「-Dvbroker.se.iiop_tp.scm.iiop_tp.manager.type=Socket -Dvbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMax=64」が仮定されます。なお,指定できるプロパティについては,マニュアル「VisiBroker Version 5 Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。
- なお,このエントリは,TPBroker V5環境の場合に指定するエントリです。TPBroker V3と連携して動作する環境では指定できません。TPBroker V3環境で指定した場合は,指定が無視され省略値も有効になりません。TPBroker V3環境では,ORB/BOAオプションとしてDocSpaceOrbBoaOptionエントリに指定してください。
- ErrLogFileCountエントリ
- エラーログを取得するファイル数を2〜16で指定します。出力ファイル名はEDMError_%d.logで,「%d」は出力ファイル通番を示します。出力ファイル通番とは,1〜ErrLogFileCountエントリに指定した数(出力ファイル数)です。
- エラーログは,出力ファイル通番が「1」のファイルから順番に出力されます。あるファイルにエラーログを出力する場合に,ファイルサイズがErrLogFileSizeエントリに指定した出力ファイルサイズよりも大きくなるとき,出力ファイル通番が一つ大きいファイルに出力します。例えば,出力ファイル通番が「1」であるファイルにエラーログを出力する場合に,このファイルのサイズの最大量を超えてしまうときは,ファイル出力通番が「2」のファイルにログを出力します。
- ErrLogFileCountエントリに指定した最大のファイル通番のファイルにエラーログを出力しようとして,そのファイルのファイルサイズがErrLogFileSizeエントリに指定した出力ファイルサイズよりも大きくなってしまう場合,出力ファイル通番が「1」のファイルを初期化してログの出力を継続します。
- 指定を省略した場合および範囲外の値を指定した場合,「2」が仮定されます。
- ErrLogFileSizeエントリ
- エラーログファイルのサイズを4,096〜2,147,483,647(バイト)で指定します。エラーログの出力が指定されたサイズを超える場合,次の通番のファイルへ出力を切り替えます。また,カレントファイル出力中に異常(入出力エラーなど)が発生した場合も,次のファイルへ出力を切り替えます。ただし,切り替えは1回だけ実行します。
- 指定を省略した場合および範囲外の値を指定した場合,1,048,576(1メガバイト)が仮定されます。
- エラーログとして得られる情報の詳細については,「6.6 エラーログに関する運用」を参照してください。
(2) [Entry0001]セクション
文書空間の詳細を定義します。[Entry0001]セクションを構成する各エントリは次のとおりです。
- SerialIdエントリ
- 文書空間の識別子として,GUIDを指定します。"インストールディレクトリ\Server\etc\slocalreg.ini"のServiceObjectIDエントリの値(文書空間のGUID)を指定してください。なお,このエントリの指定は省略できません。
- 次に示すファイルのエントリの値を,このエントリに指定したGUIDと同じ値に変更したあと,メタ情報を初期設定する必要があります。
- "インストールディレクトリ\Server\etc\slocalreg.ini"のServiceObjectIDエントリ
- "インストールディレクトリ\Server\etc\edms.ini"の[dmaClass_DocSpace]セクションのdmaProp_DocspaceIdエントリ
- Processエントリ
- 文書空間が提供するサービスプロセスの数を指定します。1〜20の間で指定してください。なお,このエントリの指定は省略できません。
- SessionMaxエントリ
- DocumentBrokerに同時に接続できるクライアントの最大数を指定します。
- 1〜1,024の間で指定してください。指定を省略した場合,「64」が仮定されます。
- SessionTimeOutエントリ
- セッションアイドル時間の最大値を分単位で指定します。0〜120(分)の間で指定してください。0を指定した場合,セッション監視機能を使用しません。指定を省略した場合,「0(分)」が仮定されます。
- ProcessOrbBoaOptionエントリ
- 文書空間のサービスを供給する全プロセスに共通するORBオプションおよびBOAオプションを指定します。指定を省略した場合,「-OAthreadMax 64 -OAlocalipc 0」が仮定されます。指定できるオプションについては,マニュアル「VisiBroker for C++ プログラマーズガイド」を参照してください。
- なお,このエントリは,TPBroker V3環境の場合に指定するエントリです。TPBroker V5と連携して動作する環境では指定できません。TPBroker V5環境で指定した場合は,指定が無視され省略値も有効になりません。TPBroker V5環境では,VisiBrokerプロパティとしてProcessVBPropertyエントリに指定してください。
- ProcessVBPropertyエントリ
- 文書空間のサービスを供給する全プロセスに共通するVisiBrokerプロパティを指定します。省略を省略した場合,「-Dvbroker.se.iiop_tp.scm.iiop_tp.manager.type=Socket -Dvbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMax=64」が仮定されます。指定できるプロパティの詳細は,マニュアル「VisiBroker Version 5 Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。
- なお,このエントリは,TPBroker V5環境の場合に指定するエントリです。TPBroker V3と連携して動作する環境では指定できません。TPBroker V3環境で指定した場合は,指定が無視され省略値も有効になりません。TPBroker V3環境では,ORB/BOAオプションとしてProcessOrbBoaOptionエントリに指定してください。
- UserAuthenticationエントリ
- 文書空間で使用するユーザ認証方式を指定します。
- BASIC
Windowsのユーザ管理システムと連携してユーザ認証を実行します。
- LDAP
LDAP対応のディレクトリサービスと連携してユーザ認証を実行します。この値を指定した場合は,LdapPrefixDnエントリの値として指定した相対識別名,LdapUserIdに指定した属性およびユーザが入力するログイン名からユーザ認証に使用するDNを生成します。ただし,LdapPrefixDnエントリの指定が省略されている場合は,ユーザが入力したログイン名がユーザ認証に使用されます。
また,この値を指定する場合はLdapPrefixDnエントリで指定した相対識別名の直下に,ユーザを一意に識別する情報がフラットな状態で構成されている必要があります。
- LDAPEX
LDAP対応のディレクトリサービスと連携してユーザ認証を実行します。使用するログイン名は,LdapUserRootエントリ,LdapUserClassエントリ,LdapUserIdエントリ,LdapUserFilterLeftエントリ,LdapUserFilterRightエントリなどの設定に依存します。
また,ユーザを識別する情報は一意である必要がありますが,DITの構成を意識する必要はありません。
- UOC
ユーザ管理システムへのアクセスルーチンとして,ユーザが作成したアクセスルーチンを使用する場合に指定します。
- 指定を省略した場合,「BASIC」が仮定されます。
- LdapClientLibエントリ
- UserAuthenticationエントリで,LDAPまたはLDAPEXを指定した場合に有効になります。DocumentBrokerのLDAP認証で必要になるLDAPクライアントライブラリの種別を指定します。なお,使用するライブラリが存在するパスは,システム環境変数「PATH」に指定しておいてください。
- iPlanet
Sun Java System Directory ServerまたはSun ONE Directory ServerのLDAPクライアントライブラリ(Sun Java System Directory Server5.1およびSun Java System Directory Server5.2同梱のnsldap32v50.dll,またはSun ONE Directory Server 5.0同梱のnsldap32v41.dll)を使用して,LDAP対応のディレクトリサービスとしてSun Java System Directory ServerまたはSun ONE Directory Serverと連携する場合に指定します。
- ActiveDirectory
Windows Server 2003,Windows Server 2003 R2,Windows Server 2008,Windows Server 2008 R2,またはWindows Server 2012のLDAPクライアントライブラリ(Windows Server 2003,Windows Server 2003 R2,Windows Server 2008,Windows Server 2008 R2,またはWindows Server 2012同梱のWldap32.dll)を使用して,LDAP対応のディレクトリサービスと連携する場合に指定します。
- なお,LDAP対応のディレクトリサービスとして,Sun Java System Directory Server 6.3およびSun Directory Server 7.0と連携する場合は,「ActiveDirectory」を指定してください。また,指定を省略した場合,「ActiveDirectory」が仮定されます。上記以外の不正な値を指定した場合にはエラーとなり,DocumentBrokerサーバの起動に失敗します。このとき,KMBR03005-Eのメッセージが出力されます。なお,メッセージの詳細については,マニュアル「DocumentBroker Version 3 メッセージ」を参照してください。
- LdapHostエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。LDAP対応のディレクトリサービスのホスト名またはIPアドレスを,255バイト以内で指定します。指定を省略した場合,自ホストが仮定されます。
- LdapPortエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。LDAP対応のディレクトリサービスのポート番号を指定します。指定を省略した場合,標準のポート番号(389)が仮定されます。
- UOCLibraryエントリ
- UserAuthenticationエントリでUOCを指定した場合には,必ずUOCライブラリへの絶対パスを指定します。
- パスは印刷可能なASCIIコードで指定してください。
- LdapPrefixDnエントリ
- UserAuthenticationエントリでLDAPを指定した場合に有効になります。ユーザ認証に使用するDNを生成するために,最初の相対識別名にDocumentBrokerが付与するDNのパスを,128バイト以内で指定します。指定を省略した場合,ログイン名として指定した文字列を,そのまま認証に使用します。すなわち,UserAuthenticationエントリでLDAPを指定している場合で,このエントリの指定を省略したときはログイン名としてDNをすべて指定することになります。
- LdapUserIdエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ユーザ識別子として利用するユーザクラスの属性を,64バイト以内で指定します。ただし,指定する属性は,ユーザの一意性を保証している必要があります。指定を省略した場合,「uid」が仮定されます。
- なお,UserAuthenticationエントリでLDAPEXを指定した場合で,LDAP対応のディレクトリサービスとしてActive Directoryを使用するときは,「sAMAccountName」または「userPrincipalName」を指定してください。
- ただし,「userPrincipalName」を指定した場合,ログイン名として「ユーザ名@ドメイン名」の形式で指定する必要があります。
- LdapUserTimeoutエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ディレクトリエントリからユーザを検索するときの最大待ち時間を指定します。0〜180(秒)の範囲で指定します。0を指定した場合,待ち時間が無制限になります。指定を省略した場合,「60(秒)」が仮定されます。
- LdapUserCaseエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。DocumentBrokerで扱うユーザ識別子の文字種についての制限を指定します。
- Upper
ユーザ識別子の文字列を,すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を,DocumentBroker内で大文字に変換します。
- Lower
ユーザ識別子の文字列を,すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を,DocumentBroker内で小文字に変換します。
- Default
ユーザ識別子の文字列を変換しません。
- 指定を省略した場合,「Default」が仮定されます。
- LdapUserRootエントリ
- UserAuthenticationエントリでLDAPEXを指定した場合に有効になります。DIT上でユーザを検索するベースとなるノードのDNを,128バイト以内で指定します。指定を省略した場合,「c=JP」が仮定されます。
- LdapUserScopeエントリ
- UserAuthenticationエントリでLDAPEXを指定した場合に有効になります。ディレクトリエントリからユーザを検索するときの検索範囲を指定します。
- Onelevel
検索開始点の一つ下のレベルにあるすべてのエントリを検索します。
- Subtree
検索開始点と,その下のすべてのレベルにあるすべてのエントリを検索します。
- 指定を省略した場合,「Subtree」が仮定されます。
- LdapUserClassエントリ
- UserAuthenticationエントリでLDAPEXを指定した場合に有効になります。ユーザとして定義しているクラスの名称を,64バイト以内で指定します。指定を省略した場合,「inetOrgPerson」が仮定されます。
- なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「user」またはuserのサブクラスを指定してください。
- LdapUserFilterLeftエントリ
- UserAuthenticationエントリでLDAPEXを指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「(」(左括弧)および追加指定する検索フィルタの内容を,128バイト以内で指定します。指定を省略した場合,「(」が仮定されます。
- LdapUserFilterRightエントリ
- UserAuthenticationエントリでLDAPEXを指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「)」(右括弧)および追加指定する検索フィルタの内容を,128バイト以内で指定します。指定を省略した場合,「)」が仮定されます。
- LdapGroupエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ識別子を,メンバ(ユーザ)をリストとしたオブジェクトから検索することを指定します。
- Yes
メンバ(ユーザ)をリストとしたオブジェクトから検索します。
- No
メンバ(ユーザ)をリストとしたオブジェクトから検索しません。
- 指定を省略した場合,「Yes」が仮定されます。
- LdapGroupRootエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。DIT上でグループを検索する基となるノードのDNを,128バイト以内で指定します。指定を省略した場合,「c=JP」が仮定されます。
- LdapGroupScopeエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ディレクトリエントリでグループを検索する場合の検索範囲を指定します。
- Onelevel
検索開始点の一つ下のレベルにあるすべてのエントリを検索します。
- Subtree
検索開始点とその下のすべてのレベルにあるすべてのエントリを検索します。
- 指定を省略した場合,「Subtree」が仮定されます。
- LdapGroupClassエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ識別子としてメンバ(ユーザ)をリストとしたオブジェクトのクラスを,64バイト以内で指定します。指定を省略した場合,「hdsgroupOfUniqueNames」が仮定されます。
- なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「group」またはgroupのサブクラスを指定してください。
- LdapGroupIdエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ識別子として利用する属性を,64バイト以内で指定します。指定を省略した場合,「groupOfUniqueNamesId」が仮定されます。
- なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「sAMAccountName」を指定してください。
- LdapGroupFilterLeftエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループを検索するときに指定する検索フィルタの「(」(左括弧)および追加指定する検索フィルタの内容を,128バイト以内で指定します。指定を省略した場合,「(」が仮定されます。
- LdapGroupFilterRightエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループを検索する場合にLDAPに指定する検索フィルタの「)」(右括弧)および追加指定する検索フィルタの内容を,128バイト以内で指定します。指定を省略した場合,「)」が仮定されます。
- LdapGroupMemberエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定し,LdapGroupエントリにYesを指定したときに有効になります。グループに所属しているユーザを記述する属性を指定します。指定を省略した場合,「uniqueMember」が仮定されます。
- なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「member」を指定してください。
- LdapGroupFromUserAttrエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ識別子としてユーザの属性値からディレクトリのノード情報を検索するか,検索しないかを指定します。
- Yes
ユーザの属性値からディレクトリのノード情報を検索します。
- No
ユーザの属性値からディレクトリのノード情報を検索しません。
- 指定を省略した場合,「No」が仮定されます。
- LdapGroupIdFromUserAttrエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ情報が格納されているユーザの属性を64バイト以内で指定します。指定を省略した場合,「ou」が仮定されます。
- LdapGroupIsDnFromUserAttrエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ユーザの属性に格納されているグループの情報がDNかどうかを指定します。
- Yes
ユーザの属性に格納されているグループの情報がDNの場合,指定します。この場合,DocumentBrokerは,LdapGroupIdAttrFromUserAttrエントリで指定されたグループの属性の情報を取得します。
- No
ユーザの属性に格納されているグループの情報がDNでない場合,指定します。この場合,格納された情報を,そのままグループ識別子とします。
- 指定を省略した場合,「No」が仮定されます。
- LdapGroupIdAttrFromUserAttrエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ユーザの属性から取得した情報で,グループのグループ識別子として利用する属性を,64バイト以内で指定します。指定を省略した場合,「dn」が仮定されます。
- LdapGroupFromUserDnエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。グループ識別子をユーザエントリのDNの構成要素となる属性値から検索するか,検索しないかを指定します。
- Yes
ユーザのDNからディレクトリのノード情報を検索します。
- No
ユーザのDNからディレクトリのノード情報を検索しません。
- 指定を省略した場合,「No」が仮定されます。
- LdapGroupIdFromUserDnエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ユーザエントリのDNの構成要素の中で,グループ識別子として使用する属性名を,64バイト以内で指定します。指定を省略した場合,「ou」が仮定されます。
- LdapGroupTimeoutエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。ディレクトリエントリからグループを検索するときの最大待ち時間を指定します。0〜180(秒)の範囲で指定します。0を指定した場合,待ち時間が無制限になります。指定を省略した場合,「60(秒)」が仮定されます。
- LdapGroupCaseエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。DocumentBrokerで扱うグループ識別子の文字種についての制限を指定します。
- Upper
グループ識別子の文字列を,すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を,DocumentBroker内で大文字に変換します。
- Lower
グループ識別子の文字列を,すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を,DocumentBroker内で小文字に変換します。
- Default
グループ識別子の文字列を変換しません。
- 指定を省略した場合,「Default」が仮定されます。
- LdapBindUserDNエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。
- ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して認証を行ってバインドする場合は,認証に使用するDNを指定します。
- 指定を省略した場合,ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して匿名バインドを使用します。
- なお,ディレクトリサービスに対して認証を行ってバインドする場合は,必ずLdapBindUserDNエントリとLdapBindPasswordエントリの両方を指定してください。どちらか一方でも指定を省略した場合は,ディレクトリサービスに対して匿名バインドを使用します。
- LdapBindPasswordエントリ
- UserAuthenticationエントリでLDAPまたはLDAPEXを指定した場合に有効になります。
- ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して認証を行ってバインドする場合は,認証に使用するパスワードを指定します。
- なお,ディレクトリサービスに対して認証を行ってバインドする場合は,必ずLdapBindUserDNエントリとLdapBindPasswordエントリの両方を指定してください。どちらか一方でも指定を省略した場合は,ディレクトリサービスに対して匿名バインドを使用します。
- DbTypeエントリ
- 文書空間が接続するデータベース種別を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリには「HIRDB」と指定してください。なお,このエントリの指定は省略できません。
- PdHostエントリ
- データベースを構築しているサーバのホスト名を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリにはHiRDBサーバのホスト名を指定してください。なお,このエントリの指定は省略できません。
- PdNamePortエントリ
- データベースを構築しているサーバのポート番号を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリにはHiRDBサーバのポート番号を指定してください。なお,このエントリの指定は省略できません。
- PdUserエントリ
- データベースにアクセスするためのDocumentBroker用のユーザ名とパスワードを指定します。使用できるデータベースシステムはHiRDBです。したがって,HiRDBのユーザ権限でCONNECT権限およびスキーマ定義権限を付与したユーザを指定してください。指定方法を次に示します。
- "ユーザ名"/"パスワード"
- HiRDBのユーザ権限については,「3.10.3 HiRDBのユーザ権限の設定」を参照してください。なお,このエントリの指定は省略できません。
- DBConnectionPoolCountエントリ
- サービスプロセス当たりのDBコネクションプール数を指定します。0〜64の間で指定してください。0を指定した場合,プールされずに,要求ごとにDBコネクションを確立します。指定を省略した場合,「4」が仮定されます。
- ただし,DBConnectionPoolCountエントリに指定した値と,次に説明するDBConnectionPoolDynamicエントリに指定した値を合わせて,1以上になるように設定してください。
- DBConnectionPoolDynamicエントリ
- サービスプロセス当たりの一時コネクションの最大数を指定します。0〜64の間で指定してください。0を指定した場合,一時コネクションは確立されません。指定を省略した場合,「4」が仮定されます。
- ただし,上記で説明したDBConnectionPoolCountエントリに指定した値と,DBConnectionPoolDynamicエントリに指定した値を合わせて,1以上になるように設定してください。
- DBConnectionPoolTimingエントリ
- プールするDBコネクション作成のタイミングを指定します。
- Static
静的(DocumentBroker起動時)にプールするすべてのコネクションを作成します。
- Dynamic
動的(コネクション解放時)にプールします。
- 指定を省略した場合,「Static」が仮定されます。
- DBConnectionPoolOverエントリ
- プールしているDBコネクションがすべて使用中,かつ一時コネクションが最大数に達している場合のアクションを指定します。
- Error
クライアントにエラーの戻り値を返却します。
- FIFO
コネクション待ち行列に入れ,空きコネクションが発生したときに割り当てます。
- 指定を省略した場合,「Error」が仮定されます。
- DBConnectionScopeエントリ
- DBコネクション割り当て期間を指定します。
- Connection
文書空間への接続単位に割り当てます。文書空間への接続時に割り当て,文書空間への接続解除時に解放します。
- Transaction
トランザクション単位に割り当てます。トランザクション開始時に割り当て,トランザクション終了時に解放します。
- 指定を省略した場合,「Transaction」が仮定されます。
- DBConnectionPoolWaitTimeOutエントリ
- DBConnectionPoolOverエントリに「FIFO」を指定している場合,DBコネクション割り当て待ち時間を0〜7,200,000(ミリ秒)の範囲で指定します。
- 0を指定した場合,コネクション割り当て待ち時間が無制限になります。
- このエントリの指定によってタイムアウトが発生した場合,エラーメッセージを出力して,DBコネクション割り当て待ちリストから削除します。この時,DocumentBrokerクライアントには,戻り値としてDMARC_LOST_CONNECTIONを返却します。指定を省略した場合,「0」が仮定されます。
- PdTSPluginOwnerエントリ
- 全文検索および構造指定検索を実行する場合に,HiRDB Text Search Plug-inを登録したユーザの認可識別子を指定します。
- なお,HiRDB Text Search Plug-inはデフォルト(MASTER)のスキーマに格納されるため,このエントリの指定は不要です。HiRDB Text Search Plug-inの登録時に,pdplgrgstコマンドの-uオプション(プラグイン登録スキーマ指定)を使用した場合だけ,このエントリの指定が必要です。
- AcLogUseエントリ
- アクセスログの取得の有無を指定します。
- Yes
アクセスログを取得します。
- No
アクセスログを取得しません。
- 指定を省略した場合,「No」が仮定されます。
- AcLogLevelエントリ
- アクセスログに出力するアクセスレベルを指定します。指定した出力レベルによってアクセスログに出力する出力ログ情報を調節します。表4-4に出力レベルによる出力ログ情報を示します。
- アクセスログレベルおよび取得される情報の詳細については,「6.5 アクセスログに関する運用」を参照してください。なお,指定を省略した場合,「Write」が仮定されます。
表4-4 アクセスログの出力レベルと出力ログ情報
| 出力レベル |
出力ログ情報 |
| Write |
- セッションの確立
- セッションの切断
- オブジェクトの作成
- オブジェクトの削除
- オブジェクト間の関連づけの設定
- オブジェクト間の関連づけの解除
- ACLのバインド
- ACLのバインドの解除
- バージョンのチェックイン
- バージョンのチェックアウト
- チェックアウトの取り消し
- バージョンの削除
- バージョンの固定
- バージョンの固定の解除
- リレーション情報の作成
- リレーション情報の削除
- レンディションの作成
- レンディションの削除
- マスタレンディションの変更
- プロパティの設定
- ファイルのアップロード
- 全文検索インデクスの作成
- 全文検索インデクスの削除
|
| Read |
- 出力レベルが「Write」の場合に出力される情報
- オブジェクトとの接続
- オブジェクトの接続の解除
- オブジェクト一覧の取得
- オブジェクトを包含するコンテナ一覧の取得
- コンテナに包含されるオブジェクト一覧の取得
- ACL一覧の取得
- バージョン一覧の取得
- バージョン管理情報一覧の取得
- リザベーションの取得
- リレーション情報の一覧取得
- レンディションの一覧取得
- プロパティの取得
- ファイルのダウンロード
- edmSQLの構文チェック
- 問い合わせの実行
- 問い合わせの実行と問い合わせ結果の取得
- 問い合わせ結果の削除
|
| Error |
- 出力レベルが「Read」の場合に出力される情報
- エラー
|
- AcLogFileCountエントリ
- アクセスログを取得しているファイルのサイズが,AcLogFileSizeエントリに指定した上限値を超えた場合に,切り替えるファイル数を2〜16で指定します。出力ファイル名はEDMAccess_NO.logで,「NO」は出力ファイル通番を示します。出力ファイル通番とは,1〜AcLogFileCountエントリに指定した数(出力ファイル数)です。
- アクセスログは,出力ファイル通番が「1」のファイルから順番に出力されます。あるファイルにアクセスログを出力する場合に,ファイルサイズがAcLogFileSizeエントリに指定した出力ファイルサイズよりも大きくなるとき,出力ファイル通番が一つ大きいファイルに出力します。例えば,出力ファイル通番が「1」であるファイルにアクセスログを出力する場合に,このファイルのサイズの最大量を超えてしまうときは,ファイル出力通番が「2」のファイルにログを出力します。
- AcLogFileCountエントリに指定した最大のファイル通番のファイルにアクセスログを出力しようとして,そのファイルのファイルサイズがAcLogFileSizeエントリに指定した出力ファイルサイズよりも大きくなってしまう場合,出力ファイル通番が「1」のファイルを初期化してログの出力を継続します。
- 指定を省略した場合,「2」が仮定されます。
- AcLogFileSizeエントリ
- アクセスログファイルのサイズを,4,096〜2,147,483,647(バイト)で指定します。アクセスログの出力が指定されたサイズを超える場合,次の通番のファイルへ出力を切り替えます。また,カレントファイル出力中に異常(入出力エラーなど)が発生した場合も,次の通番のファイルへ出力を切り替えます。ただし,切り替えは1回だけ実行します。
- 指定を省略した場合,「1,048,576(1メガバイト)」が仮定されます。
- XdkShmemManageエントリ
- メタ情報管理用のメモリマップトファイルの確保,解放の方法を指定します。なお,DocumentSpace構成定義ファイルに定義されている値を変更しないでください。
- XdkShmemSizeエントリ
- メタ情報管理用に確保するメモリマップトファイルのサイズを,3,000,000〜1,073,741,824(バイト)で指定します。指定を省略した場合,「3,000,000(バイト)」が仮定されます。なお,このメモリマップトファイルのサイズは,システム環境変数「XDK_SHMEM_SIZE」にも指定できます。この場合,次の点に注意してください。
- XdkShmemSizeエントリおよびシステム環境変数「XDK_SHMEM_SIZE」の両方に値を指定している場合は,XdkShmemSizeエントリの値が優先されます。
したがって,メタ情報管理用に確保するメモリマップトファイルのサイズは,XdkShmemSizeエントリに指定することを推奨します。
- システム環境変数「XDK_SHMEM_SIZE」を指定できるのは,インストール方法で「標準インストール」を選択した場合だけです。インストール方法で「セットアップ識別子付きインストール」を選択した場合は,XdkShmemSizeエントリに指定してください。
- メタ情報管理用に確保するメモリマップトファイルのサイズに設定される値を次の表に示します。
表4-5 メタ情報管理用に確保するメモリマップトファイルのサイズの値
| XDK_SHMEM_SIZE |
XdkShmemSizeエントリ |
メモリマップトファイルのサイズの値 |
| ○ |
○ |
XdkShmemSizeエントリの指定値 |
| ○ |
− |
XDK_SHMEM_SIZEの指定値 |
| − |
○ |
XdkShmemSizeエントリの指定値 |
| − |
− |
3,000,000バイト |
- (凡例)
- ○:指定あり。
- −:指定なし。
- なお,オペレーティングシステムのページングファイルサイズの値には,このメモリマップトファイルが確保できる十分なサイズを指定してください。
- メモリマップトファイルはオペレーティングシステムのページングファイルサイズの制限を受けるため,メタ情報管理用に確保するメモリマップトファイルがこの制限を超えると,メモリマップトファイルを確保できないことがあります。コントロールパネルの[システム]−[詳細設定]タブの[パフォーマンス]ボタンをクリックして表示される[パフォーマンスオプション]ダイアログ(Windows Server 2003,Windows Server 2003 R2の場合),またはコントロールパネルの[システム]−[システムの詳細設定]アンカー−[詳細設定]タブ−[パフォーマンスオプション]ダイアログ(Windows 2008,Windows Server 2008 R2,またはWindows Server 2012の場合)の仮想メモリを確認してください。このメモリマップトファイルを確保できない場合は,DocumentBrokerサーバが停止します。このとき,KMBR02004-Eのメッセージが出力されます。メッセージの詳細については,マニュアル「DocumentBroker Version 3 メッセージ」を参照してください。
- XdkShmemSizeエントリおよびシステム環境変数「XDK_SHMEM_SIZE」に指定する,メタ情報管理用に確保するメモリマップトファイルのサイズの見積もり式を次に示します。
メタ情報管理用に確保するメモリマップトファイルのサイズ(バイト) = 3,000,000 + 10,640 × A + 12,584 × B + 752 × C
- (凡例)
- A
- ユーザが定義するクラス数を表します。
- B
- ユーザが定義するプロパティ数を表します。
- C
- ユーザが定義するクラスに定義するユーザ定義のプロパティの総数を表します。この値はメタ情報の追加コマンド(EDMAddMeta)に指定する定義情報ファイル内の[AddProperty/クラス名]の数です。
- FtpBufferSizeエントリ
- ファイル分割転送機能を使用してファイル転送する場合の,データ転送サイズを指定します。指定できる値の範囲は,4,096〜2,147,483,647(バイト)です。なお,4,096〜65,000(バイト)の範囲で指定することを推奨します。
- このエントリの記述を省略した場合は,ファイル分割転送機能を使用しないでファイル転送を実行します。なお,ファイル分割転送機能については,「3.13.3(2) ファイル分割転送機能の設定」を参照してください。
- SelectServerInMultiServerエントリ
- 複数の実行環境から,同じ文書空間にアクセスする運用形態の場合に,クライアント側で接続するDocumentBrokerサーバを選択するかどうかを指定します。
- Yes
クライアント側で接続するDocumentBrokerサーバを選択します。
- No
クライアント側で接続するDocumentBrokerサーバを選択しません。
- 「Yes」を指定した場合,クライアント側で,接続するDocumentBrokerサーバの実行環境識別子を指定する必要があります。指定方法については,マニュアル「DocumentBroker Version 3 クラスライブラリ C++ 解説」を参照してください。上記以外の値を指定した場合,DocumentBrokerサーバの起動時にエラーが発生します。指定を省略した場合,「No」が仮定されます。
- なお,同じ文書空間にアクセスするすべての実行環境でSelectServerInMultiServerエントリの値を同じにしてください。また,DocumentBrokerサーバのバージョンが02-40より前のメタ情報ファイルを使用している場合,このエントリを省略するか,「No」を指定してください。「Yes」を指定した場合,DocumentBrokerサーバ起動時にエラーが発生します。
- VArrayElementCheckエントリ
- VariableArray型プロパティの要素に指定した値をチェックするか,チェックしないかを指定します。
- Yes
VariableArray型プロパティの要素の値をチェックします。
- No
VariableArray型プロパティの要素の値をチェックしません。
- 次に,VariableArray型のプロパティに指定した値のデータ型と実行されるチェックの内容について次の表に示します。なお,指定を省略した場合,「No」が仮定されます。
表4-6 VariableArray型プロパティのデータ型と実行されるチェックの内容
| プロパティに指定した値のデータ型 |
チェックの内容 |
| DMA_DATATYPE_BOOLEAN |
DMA_TRUE,DMA_FALSE,またはDMA_UNKNOWN以外はDMARC_BAD_VALUEのエラーになる。 |
| DMA_DATATYPE_INTEGER32 |
プロパティの最小値,および最大値をメタ情報から取得し,この範囲外であればDMARC_BAD_VALUEのエラーになる。※1 |
| DMA_DATATYPE_STRING |
プロパティの最大文字列長をメタ情報から取得し,これを超える場合はDMARC_BAD_VALUEのエラーになる。※2 |
- 注※1
- プロパティの最小値および最大値は,「−2,147,483,648〜2,147,483,647」です。最小値よりも小さい値または最大値よりも大きい値の場合,エラーになります。
- 注※2
- プロパティの最大文字列長は,ユーザがVariableArray型プロパティを定義する場合に設定した最大文字列長です。最大文字列長よりも長い文字列の場合,エラーになります。
- ErrChkFlagOfObjectOperationエントリ
- DocumentBrokerのオブジェクトを操作するときに実行するエラーチェックをbitフラグで指定します。なお,DocumentSpace構成定義ファイルで定義されている値を変更できるのは,次の場合だけです。
- ユーザのアプリケーションプログラムが動作していた実行環境を移行する場合
アプリケーションが動作していたDocumentBroker実行環境のDocumentSpace構成定義ファイルで指定されている値に変更してください。
- 複数の実行環境から同じ文書空間にアクセスする実行環境を構築する場合
メタ情報初期設定コマンド(EDMInitMeta)を実行したDocumentBroker実行環境のDocumentSpace構成定義ファイルで指定されている値に変更してください。
- EnbFncFlagOfObjectOperationエントリ
- DocumentBrokerのオブジェクトを操作したときの動作をbitフラグで指定します。なお,DocumentSpace構成定義ファイルで定義されている値を変更できるのは,次の場合だけです。
- ユーザのアプリケーションプログラムが動作していた実行環境を移行する場合
アプリケーションが動作していたDocumentBroker実行環境のDocumentSpace構成定義ファイルで指定されている値に変更してください。
- 複数の実行環境から同じ文書空間にアクセスする実行環境を構築する場合
メタ情報初期設定コマンド(EDMInitMeta)を実行したDocumentBroker実行環境のDocumentSpace構成定義ファイルで指定されている値に変更してください。
- ReferenceStorageModeエントリ
- リファレンスファイル文書の格納方式を設定します。
- Origin
リファレンスファイル文書のコンテントを管理するためのディレクトリが,コンテント単位に異なります。指定を省略した場合,「Origin」が仮定されます。
- Divide
リファレンスファイル文書のコンテントを管理するためのディレクトリが,複数のコンテントで共有されます。
- 「Divide」を指定すると,DocumentBrokerがコンテントを管理するためのディレクトリ階層が少なくなります。Hitachi Content Archive Platformを使用する場合など,リファレンスファイル文書のコンテント数が,「ノードあたりのディレクトリの最大数/2」を超える可能性がある場合は,「Divide」を指定してください。それ以外の場合は,「Origin」を指定してください。
- 運用開始後にこのエントリの指定値を変更してもシステムは問題なく動作しますが,異なる格納形式の文書が混在するようになります。そのため,リファレンスファイル文書のコンテント数を見積もり,運用を開始する前に適切な値を設定してください。運用開始後にこのエントリの指定値を変更しないことをお勧めします。
- ReferenceDirDivideNumエントリ
- このエントリは,ReferenceStorageModeエントリでDivideを指定した場合に有効になります。リファレンスファイル文書のコンテントを格納するためのディレクトリの数を,1〜10,000の範囲で指定します。指定を省略した場合は100が仮定されます。
- 運用開始後にこのエントリの指定値を変更してもシステムは問題なく動作しますが,DocumentBrokerがコンテントを管理するためのディレクトリ内のコンテント数に偏りが発生するため,運用開始後にこのエントリの指定値を変更しないことをお勧めします。
- BlobSubstrModeエントリ
- マルチファイル管理機能を使用する場合の,BLOBデータの取得・格納方法を指定します。
- ALL
文書からコンテントを取得する場合,BLOBに格納されたファイルを1回のデータベースへのアクセスで取得して,ファイル単位に出力します。
文書にコンテントを格納する場合(文書を作成する場合または文書のコンテントを更新する場合),1回のデータベースへのアクセスで,複数のファイルを一つのBLOBに格納します。
この方式では,データベースへのアクセスの回数が削減されます。ただし,BLOBデータの取得先には,一つの文書に格納しているファイルの合計サイズ分のメモリまたはディスク容量が必要です。
- ELEMENT
文書からコンテントを取得する場合,BLOBに格納されたファイルをファイル単位のデータベースへのアクセスで取得して,ファイル単位に出力します。
文書にコンテントを格納する場合(文書を作成する場合または文書のコンテントを更新する場合),ファイル単位のデータベースへのアクセスで,複数のファイルを一つのBLOBに格納します。
この方式では,データベースへのアクセス回数は増加します。ただし,BLOBデータの取得先に必要なメモリまたはディスク容量が,一つのファイルサイズ分だけになります。
- THRESHOLD
文書からコンテントを取得する場合,BLOBに格納されたファイルをBlobSubstrThresholdエントリに指定するサイズ単位のデータベースへのアクセスで取得して,ファイル単位に出力します。
文書にコンテントを格納する場合(文書を作成する場合または文書のコンテントを更新する場合),BlobSubstrThresholdエントリに指定するサイズ単位のデータベースへのアクセスで,複数のファイルを一つのBLOBに格納します。
この方式では,データベースへのアクセスの回数は,すべてのファイルの合計サイズをBlobSubstrThresholdエントリに指定するサイズで割った商+1の値になります。また,BLOBデータの取得先には,BlobSubstrThresholdエントリに指定するサイズ分のメモリまたはディスク容量が必要です。
- 指定を省略した場合,「ELEMENT」が仮定されます。
- BlobSubstrThresholdエントリ
- マルチファイル管理機能を使用する場合で,BlobSubstrModeエントリの値にTHRESHOLDを指定しているときに,1回のデータベースへのアクセスで取得・格納するデータのサイズを指定します。指定する値の単位はバイトです。4,096〜5,242,880(バイト)の間で指定してください。
- なお,BlobSubstrModeエントリの値にALLまたはELEMENTを指定している場合,BlobSubstrThresholdエントリの設定値は無視されます。
- 指定を省略した場合,「1,048,576(バイト)」が仮定されます。
- BlobGettingMethodエントリ
- データベースからBLOBデータを取得するときの取得先を指定します。
- Mem
メモリを使用してBLOBデータを取得します。
「Mem」を指定する場合は,メモリ所要量を確保してください。容量の見積もりについては,「2.7.1 仮想メモリ所要量の見積もり」を参照してください。
- File
BLOBデータを"インストールディレクトリ\Server\tmp"下に一時ファイルとして取得します。
「File」が指定できるのは,DocumentBrokerサーバとHiRDBサーバが同一マシンの場合だけです。DocumentBrokerサーバとHiRDBサーバが異なるマシンの場合は,データベースからBLOBデータを取得しようとしたときにエラーになります。
「File」を指定する場合は,一時ファイルの容量を確保してください。容量の見積もりついては,「2.7.3 ディスク占有量の見積もり」を参照してください。
- 指定を省略した場合,「Mem」が仮定されます。
- LifeCycleSuiteConnectionエントリ
- DocumentBroker Life Cycle Suiteを使用してWorkCoordinatorと連携するか,連携しないかを指定します。
- Yes
DocumentBroker Life Cycle Suiteを使用してWorkCoordinatorと連携します。
- No
DocumentBroker Life Cycle Suiteを使用してWorkCoordinatorと連携しません。
- 指定を省略した場合,「No」が仮定されます。
- なお,このエントリは,TPBroker V3環境の場合に指定するエントリです。TPBroker V5と連携して動作する環境では指定できません。TPBroker V5環境で指定した場合は,指定が無視され省略値も有効になりません。
All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.