4.3.2 文書空間構成定義ファイルの記述形式

文書空間構成定義ファイルの記述形式を次に示します。なお,文書空間構成定義ファイルの記述規則については,「4.1.1(1) プロパティファイルの記述規則」を参照してください。

<プロパティ名>=<値>

以降,文書空間構成定義ファイルに記述するプロパティについて説明します。

DocSpaceIdプロパティ
文書空間の識別子として,GUIDを指定します。GUIDはdbjgenguidコマンドで生成できます。GUIDは「X」を0~9,およびa~f(小文字)で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX(8-4-4-4-12)」の形式で表されます。デフォルト値は存在しません。また,このプロパティの指定は省略できません。
ConnectorNameプロパティ
データベースに対応するリソースアダプタの設定で指定するDB Connectorの表示名を指定します。
DBTypeプロパティ
文書空間が接続するデータベース種別指定します。「HiRDB」を指定します。指定を省略した場合は「HiRDB」が仮定されます。
UserAuthenticationプロパティ
文書空間で使用するユーザ認証方式を指定します。
  • LDAP
    LDAP対応のディレクトリサービスと連携してユーザ認証を実行します。
    DocumentBrokerでは,LDAP対応のディレクトリサービスとして,次の製品との連携をサポートしています。
    ・Windows Server 2008 R2およびWindows Server 2012のActive Directory
    ・Oracle Directory Server Enterprise Edition
  • UOC
    ユーザ管理システムへのアクセスルーチンとして,ユーザが作成したアクセスルーチンを使用する場合に指定します。
指定を省略した場合,「LDAP」が仮定されます。
LdapHostプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。
LDAP対応のディレクトリサービスのホスト名またはIPアドレスを指定します。指定を省略した場合,何も仮定されません。
UOCClassプロパティ
UserAuthenticationプロパティで「UOC」を指定した場合には,必ずUOCで使用するClassのクラス名を指定します。指定を省略した場合,何も仮定されません。
LdapPortプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。LDAP対応のディレクトリサービスのポート番号を指定します。指定を省略した場合,標準のポート番号(389)が仮定されます。
LdapUserIdプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザ識別子として利用するユーザを検索するときのキーとなる属性を指定します。ただし,指定する属性は,ユーザの一意性を保証している必要があります。指定を省略した場合,「uid」が仮定されます。
LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「sAMAccountName」または「userPrincipalName」を指定してください。ただし,「userPrincipalName」を指定した場合,ログイン名として「ユーザ名@ドメイン名」の形式で指定する必要があります。
LdapUserTimeoutプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからユーザを検索するときの最大待ち時間を指定します。0~180(秒)の範囲で指定します。0を指定した場合,待ち時間が無制限になります。指定を省略した場合,「60(秒)」が仮定されます。
LdapUserCaseプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DocumentBrokerで扱うユーザ識別子の文字種についての制限を指定します。
  • Upper
    ユーザ識別子の文字列を,すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を,DocumentBroker内で大文字に変換します。
  • Lower
    ユーザ識別子の文字列を,すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を,DocumentBroker内で小文字に変換します。
  • Default
    ユーザ識別子の文字列を変換しません。
指定を省略した場合,「Default」が仮定されます。
LdapUserRootプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DIT上でユーザを検索するベースとなるノードのDNを指定します。指定を省略した場合,何も仮定されません。
LdapUserScopeプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからユーザを検索するときの検索範囲を指定します。
  • Onelevel
    検索開始点の一つ下のレベルにあるすべてのプロパティを検索します。
  • Subtree
    検索開始点と,その下のすべてのレベルにあるすべてのプロパティを検索します。
指定を省略した場合,「Subtree」が仮定されます。
LdapUserClassプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザとして定義しているクラスの名称を指定します。
LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「user」またはuserのサブクラスを指定してください。指定を省略した場合,「inetOrgPerson」が仮定されます。
LdapUserFilterLeftプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「(」(左括弧)および追加指定する検索フィルタの内容を指定します。指定を省略した場合,「(」が仮定されます。
LdapUserFilterRightプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「)」(右括弧)および追加指定する検索フィルタの内容を指定します。指定を省略した場合,「)」が仮定されます。
LdapGroupプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子を,メンバ(ユーザ)をリストとしたオブジェクトから検索することを指定します。
  • Yes
    メンバ(ユーザ)をリストとしたオブジェクトから検索します。
  • No
    メンバ(ユーザ)をリストとしたオブジェクトから検索しません。
指定を省略した場合,「Yes」が仮定されます。
LdapGroupRootプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DIT上でグループを検索する基となるノードのDNを指定します。指定を省略した場合,何も仮定されません。
LdapGroupScopeプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティでグループを検索する場合の検索範囲を指定します。
  • Onelevel
    検索開始点の一つ下のレベルにあるすべてのプロパティを検索します。
  • Subtree
    検索開始点とその下のすべてのレベルにあるすべてのプロパティを検索します。
指定を省略した場合,「Subtree」が仮定されます。
LdapGroupClassプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子としてメンバ(ユーザ)をリストとしたオブジェクトのクラスを指定します。指定を省略した場合,「groupOfUniqueNames」が仮定されます。
なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「group」またはgroupのサブクラスを指定してください。
LdapGroupIdプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子として利用する属性を指定します。指定を省略した場合,「cn」が仮定されます。
なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「sAMAccountName」を指定してください。
LdapGroupFilterLeftプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループを検索するときに指定する検索フィルタの「(」(左括弧)および追加指定する検索フィルタの内容を指定します。指定を省略した場合,「(」が仮定されます。
LdapGroupFilterRightプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループを検索する場合にLDAPに指定する検索フィルタの「)」(右括弧)および追加指定する検索フィルタの内容を指定します。指定を省略した場合,「)」が仮定されます。
LdapGroupMemberプロパティ
UserAuthenticationプロパティで「LDAP」を指定し,LdapGroupプロパティに「Yes」を指定したときに有効になります。グループに所属しているユーザを記述する属性を指定します。指定を省略した場合,「uniqueMember」が仮定されます。
なお,LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合,「member」を指定してください。
LdapGroupFromUserAttrプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザの属性値からのグループ識別子を取得するか,取得しないかを指定します。
  • Yes
    ユーザの属性値からグループ識別子を取得します。
  • No
    ユーザの属性値からグループ識別子を取得しません。
指定を省略した場合,「No」が仮定されます。
LdapGroupIdFromUserAttrプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ情報が格納されているユーザの属性を指定します。指定を省略した場合,「ou」が仮定されます。
LdapGroupIsDnFromUserAttrプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザの属性に格納されているグループの情報がDNかどうかを指定します。
  • Yes
    ユーザの属性に格納されているグループの情報がDNの場合,指定します。この場合,DocumentBrokerは,LdapGroupIdAttrFromUserAttrプロパティで指定されたグループの属性の情報を取得します。
  • No
    ユーザの属性に格納されているグループの情報がDNでない場合,指定します。この場合,格納された情報を,そのままグループ識別子とします。
指定を省略した場合,「No」が仮定されます。
LdapGroupIdAttrFromUserAttrプロパティ
LdapGroupFromUserAttrプロパティおよびLdapGroupIsDnFromUserAttrプロパティに「Yes」を指定した場合に有効になります。
ユーザの属性から取得した情報で,グループのグループ識別子として利用する属性を指定します。指定を省略した場合,「dn」が仮定されます。
LdapGroupFromUserDnプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子をユーザプロパティのDNの構成要素となる属性値から検索するか,検索しないかを指定します。
  • Yes
    グループ識別子をユーザプロパティのDNの構成要素となる属性から取得します。
  • No
    グループ識別子をユーザプロパティのDNの構成要素となる属性から取得しません。
指定を省略した場合,「No」が仮定されます。
LdapGroupIdFromUserDnプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザプロパティのDNの構成要素の中で,グループ識別子として使用する属性名を指定します。指定を省略した場合,「ou」が仮定されます。
LdapGroupTimeoutプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからグループを検索するときの最大待ち時間を指定します。0~180(秒)の範囲で指定します。0を指定した場合,待ち時間が無制限になります。指定を省略した場合,「60(秒)」が仮定されます。
LdapGroupCaseプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DocumentBrokerで扱うグループ識別子の文字種についての制限を指定します。
  • Upper
    グループ識別子の文字列を,すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を,DocumentBroker内で大文字に変換します。
  • Lower
    グループ識別子の文字列を,すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を,DocumentBroker内で小文字に変換します。
  • Default
    グループ識別子の文字列を変換しません。
指定を省略した場合,「Default」が仮定されます。
LdapGroupFromGroupDnプロパティ
UserAuthenticationプロパティで「LDAP」を指定し,LdapGroupプロパティに「Yes」を指定した場合に有効になります。グループ識別子をグループプロパティの上位にあるプロパティから取得するかどうかを指定します。
なお,最上位プロパティはLdapGroupRootプロパティ,グループを検索するときのキーとなる属性はLdapGroupIdプロパティの指定値となります。
  • Yes
    グループ識別子をグループプロパティの上位にあるプロパティから取得します。
  • No
    グループ識別子をグループプロパティの上位にあるプロパティから取得しません。デフォルトの値です。
指定を省略した場合,「No」が仮定されます。
LdapGroupFromGroupMemberプロパティ
UserAuthenticationプロパティで「LDAP」を指定し,LdapGroupプロパティに「Yes」を指定した場合に有効になります。グループ識別子をグループプロパティに関連付いているグループプロパティから,再帰的に取得する場合に指定します。なお,関連付いているグループを記述する属性はLdapGroupMemberプロパティ,グループを検索するときのキーとなる属性はLdapGroupIdプロパティで指定した値となります。
  • Yes
    グループ識別子をグループプロパティに関連付いているグループプロパティから,再帰的に取得します。
  • No
    グループ識別子をグループプロパティに関連付いているグループプロパティから,再帰的に取得しません。デフォルトの値です。
指定を省略した場合,「No」が仮定されます。
LdapBindUserDNプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して認証を行ってバインドする場合は,認証に使用するDNを指定します。
指定を省略した場合,ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して匿名バインドが使用されます。
なお,ディレクトリサービスに対して認証を行ってバインドする場合は,必ずLdapBindUserDNプロパティとLdapBindPasswordプロパティの両方を指定してください。どちらか一方でも指定を省略した場合は,ディレクトリサービスに対して匿名バインドが使用されます。
LdapBindPasswordプロパティ
UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリサービスからのデータ読み込み時に,ディレクトリサービスに対して認証を行ってバインドする場合は,認証に使用するパスワードを指定します。
なお,ディレクトリサービスに対して認証を行ってバインドする場合は,必ずLdapBindUserDNプロパティとLdapBindPasswordプロパティの両方を指定してください。どちらか一方でも指定を省略した場合は,ディレクトリサービスに対して匿名バインドが使用されます。
SecurityAdminプロパティ
DocumentBrokerに登録されたオブジェクトやオブジェクトのアクセス権を保守するユーザ(セキュリティ管理者)を指定します。このプロパティは,アクセス制御機能に対応するデータベーススキーマが構築されている場合,有効になります。セキュリティ管理者名には,ユーザ識別子を指定してください。
セキュリティ管理者を複数指定する場合は,ユーザ識別子を「,」(コンマ)で区切って指定します。セキュリティ管理者の人数に制限はありません。セキュリティ管理者の指定例を次に示します。
セキュリティ管理者の指定例
SecurityAdmin=ユーザ識別子1,ユーザ識別子2
ユーザ識別子については,「3.7.3(1) ユーザ情報の取得方法」を参照してください。なお,このプロパティの指定は省略できません。
UserPermDefプロパティ
文書空間のすべてのオブジェクトに対しての権限をユーザ,またはグループ単位で定義するか,定義しないかを指定します。定義する場合,ユーザ権限定義ファイルを作成します。ユーザ権限定義ファイルについては,「4.4 ユーザ権限定義ファイル(userperm.properties)」を参照してください。このプロパティは,アクセス制御機能に対応するデータベーススキーマが構築されている場合,有効になります。
  • Yes
    文書空間のすべてのオブジェクトに対しての権限をユーザ,またはグループ単位で定義します。
  • No
    文書空間のすべてのオブジェクトに対しての権限をユーザ,またはグループ単位で定義しません。
指定を省略した場合,「No」が仮定されます。
DefaultACFlagOwnerプロパティ
オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。オブジェクトの所有者に対するパーミッションを指定します。ACFlagは,表4-6および表4-7に示されるパーミッション文字列を「|」(ストローク)で結合して指定します。指定を省略した場合,「FULL_CONTROL」が仮定されます。
DefaultACFlagGroupプロパティ
オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。グループに対するパーミッションを指定します。ACFlagは,表4-6および表4-7に示されるパーミッション文字列を「|」(ストローク)で結合して指定します。指定を省略した場合,「FULL_CONTROL」が仮定されます。
DefaultACFlagEveryoneプロパティ
オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。すべてのユーザに対するパーミッションを指定します。ACFlagは,表4-6および表4-7に示されるパーミッション文字列を「|」(ストローク)で結合して指定します。指定を省略した場合,「FULL_CONTROL」が仮定されます。

DefaultACFlagOwnerプロパティ,DefaultACFlagGroupプロパティ,およびDefaultACFlagEveryoneプロパティに設定できるパーミッションには,基本パーミッション組み合わせパーミッションがあります。どちらのパーミッションも指定できます。また,この2種類のパーミッションを組み合わせて指定することもできます。したがって,各プロパティの値には,次に示す表のパーミッション文字列を指定します。基本パーミッションと対応する文字列を表4-6に示します。また,組み合わせパーミッションと対応する文字列を表4-7に示します。

表4-6 基本パーミッションと対応する文字列

パーミッション文字列パーミッション意味
PRIM_READ_PROPS基本プロパティ参照権プロパティを参照する権限
PRIM_WRITE_PROPS基本プロパティ更新権プロパティを更新する権限
PRIM_READ_CONTENTS基本コンテンツ参照権文書の内容を参照する権限
PRIM_WRITE_CONTENTS基本コンテンツ更新権文書の内容を更新する権限
PRIM_LINK基本リンク権オブジェクト同士を関連づける権限
PRIM_VERSION基本バージョン管理権オブジェクトのバージョンに対する操作をする権限
PRIM_DELETE基本削除権オブジェクトを削除する権限

基本プロパティ参照権は,そのほかの基本パーミッションにも含まれます。したがって,基本プロパティ参照権以外の基本パーミッションを指定すると,各基本パーミッションで許可される操作に加えて,オブジェクトのプロパティの参照が許可されます。なお,基本パーミッションは,アクセス制御の対象となるオブジェクトごとに許可される操作の内容が異なります。詳細については,マニュアル「DocumentBroker Version 5 概説」を参照してください。

表4-7 組み合わせパーミッションと対応する文字列

パーミッション文字列パーミッション意味
READ_PROPSプロパティ参照権基本プロパティ参照権と同じ権限
READ参照権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本コンテンツ参照権
WRITE_PROPSプロパティ更新権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本プロパティ更新権
READ_WRITE参照更新権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本プロパティ更新権
  • 基本コンテンツ参照権
  • 基本コンテンツ更新権
DELETE削除権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本削除権
LINKリンク権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本リンク権
VERSIONバージョン権次の基本パーミッションを組み合わせた権限
  • 基本プロパティ参照権
  • 基本プロパティ更新権
  • 基本コンテンツ参照権
  • 基本コンテンツ更新権
  • 基本バージョン管理権
FULL_CONTROLフルコントロールすべての基本パーミッションを組み合わせた権限

なお,表4-6および表4-7に示したパーミッションのほかに,「NONE」が指定できます。NONEを指定すると,新規にオブジェクトを作成した場合に権限は設定されません。また「NONE」は,ほかのパーミッション文字列と一緒には指定できません。例えば,「DefaultACFlagEveryone=NONE|LINK」といった指定はできません。

MaxContentSizeプロパティ
登録する文書のファイルの最大サイズを,0~2147483647の範囲で指定します。単位はバイトです。0を指定した場合,登録する文書のサイズをチェックしません。指定を省略した場合は「0」が仮定されます。
MaxFullTextSizeプロパティ
登録する文書の全文検索インデクスを作成するファイルの最大サイズを,0~2147483647の範囲で指定します。単位はバイトです。0を指定した場合,ファイルのサイズをチェックしません。指定を省略した場合は「0」が仮定されます。
BinaryAccessSizeプロパティ
コンテンツ,および全文検索テキストを操作する場合に一度に要求するバイト数を,1~2097151の範囲で指定します。単位はキロバイトです。実データのサイズが指定したサイズよりも小さい場合,実データのサイズでアクセスします。指定を省略した場合は「1024」が仮定されます。
ReferenceStorageModeプロパティ
リファレンスファイル文書の格納方式を設定します。
「Divide」を指定すると,DocumentBrokerがコンテンツを管理するためのディレクトリ階層が少なくなります。
リファレンスファイル文書のコンテンツ数が,「ノードあたりのディレクトリの最大数/2」を超える可能性がある場合は,「Divide」を指定してください。それ以外の場合は,「Origin」を指定してください。
運用開始後にこのプロパティの指定値を変更してもシステムは問題なく動作しますが,異なる格納形式の文書が混在するようになります。そのため,リファレンスファイル文書のコンテンツ数を見積もり,運用を開始する前に適切な値を設定してください。運用開始後にこのプロパティの指定値を変更しないことをお勧めします。
  • Origin
    リファレンスファイル文書のコンテンツを管理するためのディレクトリが,コンテンツ単位に異なります。デフォルトの値です。
  • Divide
    リファレンスファイル文書のコンテンツを管理するためのディレクトリが,複数のコンテンツで共有されます。
指定を省略した場合,「Origin」が仮定されます。
ReferenceDirDivideNumプロパティ
ReferenceStorageModeプロパティで「Divide」を指定した場合に有効となります。リファレンスファイル文書のコンテンツを格納するための,ディレクトリの数を指定します。1~10,000の範囲で指定してください。デフォルトの値は100です。指定を省略した場合,「100」が仮定されます。
運用開始後にこのプロパティの指定値を変更してもシステムは問題なく動作しますが,DocumentBrokerがコンテンツを管理するためのディレクトリ内のコンテンツ数に偏りが発生するため,運用開始後は指定値を変更しないことを推奨します。
ReferenceBasePathプロパティ
リファレンスファイル管理機能で,コンテンツの格納先となるベースパスのデフォルトを指定します。コンテンツの格納先となるベースパスはDbjSession.setReferencePath()でセッションごとに変更できます。相対パスや存在しないパスを指定した場合,リファレンスファイル文書の操作時に例外が発生します。指定を省略した場合,「null」が仮定されます。
TempDirectoryプロパティ
文書のコンテンツをストリーム形式でダウンロードする時に生成される一時ファイルの出力先ディレクトリを指定します。複数の実行環境を構築する場合,実行環境ごとに異なるディレクトリを指定してください。また,このディレクトリ下にはユーザデータを格納しないでください。
指定するディレクトリ下のディスク容量は,次の計算式で算出して必要量を割り当ててください。
 
最大文書サイズ×同時ダウンロード実行数
 
指定を省略した場合,「%DOCB_CONF_DIR%¥tmp(Windowsの場合)」または「$DOCB_CONF_DIR/tmp(UNIXの場合)」が仮定されます。