5.2.3 DocumentSpace構成定義ファイルdocspace.ini

DocumentSpace構成定義ファイルは,文書空間の構成を定義するファイルです。システム管理者がテキストエディタなどを使用して編集してください。

DocumentSpace構成定義ファイルの格納ディレクトリとファイル名を次に示します。

{File Sharingサーバのインストールディレクトリ}¥Server¥etc¥docspace.ini

<この項の構成>
(1) DocumentSpace構成定義ファイルのエントリ一覧
(2) DocumentSpace構成定義ファイルの記述形式
(3) DocumentSpace構成定義ファイルの詳細
(4) DocumentSpace構成定義ファイルの記述例
(5) DocumentSpace構成定義ファイルの注意事項

(1) DocumentSpace構成定義ファイルのエントリ一覧

DocumentSpace構成定義ファイルで指定するエントリを示します。各エントリの詳細は,「(3) DocumentSpace構成定義ファイルの詳細」を参照してください。

(a) [DocSpace]セクション

文書空間の共通定義を指定します。[DocSpace]セクションを構成する各エントリを次の表に示します。

表5-2 [DocSpace]セクションのエントリ一覧

種類設定項目エントリ指定内容指定方法
文書空間の共通定義文書空間の数CountFile Sharingサーバが提供する文書空間の数固定
VisiBrokerプロパティDocSpaceVBPropertyサービスプロセス監視プロセスに対するVisiBrokerプロパティ任意
エラーログErrLogFileCountエラーログを取得するファイル数任意
ErrLogFileSizeエラーログファイルのサイズ任意
(凡例)
固定:DocumentSpace構成定義ファイルに記述されているデフォルト値を変更してはならない項目です(必須)。
任意:任意で指定する項目です(省略可)。

(b) [Entry0001]セクション

文書空間の詳細を定義します。[Entry0001]セクションを構成する各エントリを次の表に示します。

表5-3 [Entry0001]セクションのエントリ一覧

種類設定項目エントリ名指定内容指定方法
サービス文書空間SerialId文書空間の識別子変更要
プロセス設定Processサービスプロセス数変更要
SessionMaxFile Sharingサーバに同時に接続できる最大数任意
SessionTimeOutセッションアイドル時間の最大値任意
ProcessVBProperty全プロセス共通のVisiBrokerプロパティ任意
ユーザ認証ユーザ認証UserAuthenticationユーザ認証方式固定
ユーザ認証ライブラリの設定UOCLibraryユーザ認証ライブラリの絶対パス変更要
データベース接続するデータベースの設定DbTypeデータベースの種別固定
HiRDB接続設定PdHostサーバのホスト名変更要
PdNamePortサーバのポート番号変更要
PdUserデータベースにアクセスするためのFile Sharing用のユーザ名とパスワード変更要
コネクションプールの設定DBConnectionPoolCountサービスプロセス当たりのDBコネクションプール数任意
DBConnectionPoolDynamicサービスプロセス当たりの一時コネクションの最大数任意
DBConnectionPoolTimingプールするDBコネクション作成のタイミング任意
DBConnectionPoolOverプールしているDBコネクションがすべて使用中,かつ一時コネクションが最大数に達している場合の動作任意
DBConnectionScopeDBコネクション割り当て期間任意
DBConnectionPoolWaitTimeOutDBコネクション割り当て待ち時間任意
アクセスログアクセスログの設定AcLogUseアクセスログの取得の有無任意
AcLogLevelアクセスログに出力するアクセスレベル任意
AcLogFileCountAcLogFileSizeエントリに指定した上限値を超えた場合,切り替えるファイル数任意
AcLogFileSizeアクセスログファイルのサイズ任意
メタ情報共有メモリの設定XdkShmemManageシステムが使用する値固定
XdkShmemSizeメタ情報管理用に確保するメモリマップトファイルのサイズ固定
ファイル分割転送機能データ転送サイズの設定FtpBufferSizeデータ転送サイズ任意
複数の実行環境サーバの選択SelectServerInMultiServer接続するFile Sharingサーバ任意
その他VarrayElementCheckシステムが使用する値固定
ErrChkFlagOfObjectOperationシステムが使用する値固定
EnbFncFlagOfObjectOperationシステムが使用する値固定
(凡例)
固定:DocumentSpace構成定義ファイルに記述されているデフォルト値を変更してはならない項目です(必須)。
変更要:DocumentSpace構成定義ファイルに記述されているデフォルト値を実行環境に応じて変更する項目です(必須)。
任意:任意で指定する項目です(省略可)。

(2) DocumentSpace構成定義ファイルの記述形式

[セクション名]
   エントリ名 = 値

(3) DocumentSpace構成定義ファイルの詳細

DocumentSpace構成定義ファイルは,次に示す二つのセクションと各セクションに指定するエントリによって構成されます。

以降,DocumentSpace構成定義ファイルを構成する各セクションとセクションごとに指定するエントリについて説明します。

(a) [DocSpace]セクション

文書空間の共通定義を指定します。[DocSpace]セクションを構成する各エントリは次のとおりです。

Countエントリ
File Sharingサーバが提供する文書空間の数を指定します。1を指定してください。なお,このエントリの指定は省略できません。
DocSpaceVBPropertyエントリ
文書空間のサービスプロセスの状態を監視するサービスプロセス監視プロセスに対してVisiBrokerプロパティを指定します。指定を省略した場合,「-Dvbroker.se.iiop_tp.scm.iiop_tp.manager.type=Socket -Dvbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMax=64」が仮定されます。指定できるVisiBrokerプロパティについては,マニュアル「Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。
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(1MB)が仮定されます。
エラーログとして得られる情報の詳細については,「9.1.6 エラーログ」を参照してください。
(b) [Entry0001]セクション

文書空間の詳細を定義します。[Entry0001]セクションを構成する各エントリは次のとおりです。

SerialIdエントリ
文書空間の識別子を指定します。System Object INIファイル({File Sharingサーバのインストールディレクトリ}¥Server¥etc¥slocalreg.ini)のServiceObjectIDエントリと同じ値を指定してください。なお,このエントリの指定は省略できません。
また,オブジェクト定義ファイル({File Sharingサーバのインストールディレクトリ}¥Server¥etc¥edms.ini)の[dmaClass_DocSpace]セクションの[dmaProp_DocSpaceId]エントリの値を同じ値に変更したあと,メタ情報を初期設定する必要があります。
Processエントリ
文書空間が提供するサービスプロセスの数を指定します。1~20の間で指定してください。なお,このエントリの指定は省略できません。
SessionMaxエントリ
File Sharingサーバに同時に接続できる最大数を指定します。
1~1,000の間で指定してください。指定を省略した場合,64が仮定されます。
SessionTimeOutエントリ
セッションアイドル時間の最大値を分単位で指定します。0~120(分)の間で指定してください。0を指定した場合,セッション監視機能を使用しません。指定を省略した場合,0が仮定されます。
ProcessVBPropertyエントリ
文書空間のサービスを供給する全プロセスに共通するVisiBrokerプロパティを指定します。指定を省略した場合,「-Dvbroker.se.iiop_tp.scm.iiop_tp.manager.type=Socket -Dvbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMax=64」が仮定されます。指定できるVisiBrokerプロパティについては,マニュアル「Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。
UserAuthenticationエントリ
文書空間で使用するユーザ認証方式を指定します。
ユーザ認証には,File Sharingサーバが提供するユーザ認証ライブラリを使用します。したがって,必ず「UOC」を指定してください。
UOCLibraryエントリ
ユーザ認証ライブラリのファイル名を絶対パスで指定します。このエントリの指定は省略できません。
デフォルトで「{File Sharingサーバのインストールディレクトリ}¥Server¥lib¥cfsauth_UTF-8.dll」が設定されています。文書空間の文字コード種別に応じて,次のどちらかの値を指定してください。
  • {File Sharingサーバのインストールディレクトリ}¥Server¥lib¥cfsauth_UTF-8.dll
    文書空間の文字コード種別にUTF-8を指定する場合に指定します。
  • {File Sharingサーバのインストールディレクトリ}¥Server¥lib¥cfsauth.dll
    文書空間の文字コード種別にShift-JISを指定する場合に指定します。
DbTypeエントリ
文書空間が接続するデータベース種別を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリには「HIRDB」と指定してください。なお,このエントリの指定は省略できません。
PdHostエントリ
データベースを構築しているサーバのホスト名を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリにはHiRDBサーバのホスト名を指定してください。なお,このエントリの指定は省略できません。
PdNamePortエントリ
データベースを構築しているサーバのポート番号を指定します。使用できるデータベースシステムはHiRDBです。したがって,このエントリにはHiRDBサーバのポート番号を指定してください。なお,このエントリの指定は省略できません。
PdUserエントリ
データベースにアクセスするためのFile Sharing用のユーザ名とパスワードを指定します。使用できるデータベースシステムはHiRDBです。したがって,HiRDBのユーザ権限でCONNECT権限およびスキーマ定義権限を付与したユーザを指定してください。指定方法を次に示します。

"ユーザ名"/"パスワード"

HiRDBのユーザ権限については,「3.7.3 HiRDBのユーザ権限の設定」を参照してください。なお,このエントリの指定は省略できません。
DBConnectionPoolCountエントリ
サービスプロセス当たりのDBコネクションプール数を指定します。0~64の間で指定してください。0を指定した場合,プールされずに,要求ごとにDBコネクションを確立します。指定を省略した場合,4が仮定されます。
ただし,DBConnectionPoolCountエントリに指定した値と,次に説明するDBConnectionPoolDynamicエントリに指定した値を合わせて,1以上になるように設定してください。
DBConnectionPoolDynamicエントリ
サービスプロセス当たりの一時コネクションの最大数を指定します。0~64の間で指定してください。0を指定した場合,一時コネクションは確立されません。指定を省略した場合,4が仮定されます。
ただし,上記で説明したDBConnectionPoolCountエントリに指定した値と,DBConnectionPoolDynamicエントリに指定した値を合わせて,1以上になるように設定してください。
DBConnectionPoolTimingエントリ
プールするDBコネクション作成のタイミングを指定します。
  • Static
    静的(File Sharingサーバの起動時)にプールするすべてのコネクションを作成します。
  • Dynamic
    動的(コネクション解放時)にプールします。
指定を省略した場合,「Static」が仮定されます。
DBConnectionPoolOverエントリ
プールしているDBコネクションがすべて使用中,かつ一時コネクションが最大数に達している場合の動作を指定します。
  • Error
    クライアントにエラーの戻り値を返却します。
  • FIFO
    コネクション待ち行列に入れ,空きコネクションが発生したときに割り当てます。
指定を省略した場合,「Error」が仮定されます。
DBConnectionScopeエントリ
DBコネクション割り当て期間を指定します。
  • Connection
    文書空間への接続単位に割り当てます。文書空間への接続時に割り当て,文書空間への接続解除時に解放します。
  • Transaction
    トランザクション単位に割り当てます。トランザクション開始時に割り当て,トランザクション終了時に解放します。
指定を省略した場合,「Transaction」が仮定されます。
DBConnectionPoolWaitTimeOutエントリ
DBConnectionPoolOverエントリにFIFOを指定している場合,DBコネクション割り当て待ち時間を0~7,200,000(ミリ秒)の範囲で指定します。
0を指定した場合,コネクション割り当て待ち時間が無制限になります。
このエントリの指定によってタイムアウトが発生した場合,エラーメッセージを出力して,DBコネクション割り当て待ちリストから削除します。このとき,File Sharingクライアントには,戻り値としてDMARC_LOST_CONNECTIONを返却します。指定を省略した場合,0(ミリ秒)が仮定されます。
AcLogUseエントリ
アクセスログの取得の有無を指定します。
  • Yes
    アクセスログを取得します。
  • No
    アクセスログを取得しません。
指定を省略した場合,「No」が仮定されます。
AcLogLevelエントリ
出力レベル(アクセスログに出力するアクセスレベル)を指定します。指定した出力レベルによってアクセスログに出力する出力ログ情報を調節します。
取得される情報の詳細については,「9.1.5 文書空間へのアクセスログ」を参照してください。なお,指定を省略した場合,「Write」が仮定されます。
出力レベルによる出力ログ情報を次の表に示します。

表5-4 アクセスログの出力レベルと出力ログ情報

出力レベル出力ログ情報
Write
  • セッションの確立・切断
  • オブジェクトの作成・削除
  • プロパティの設定
  • フォルダによるオブジェクト間の関連づけと関連づけの解除
  • ファイルのアップロード
Read
  • 出力レベルが「Write」の場合の出力ログ情報
  • プロパティの取得
  • ファイルのダウンロードまたは取得
  • 一覧の取得
  • 問い合わせの実行および結果の取得
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(1MB)が仮定されます。
XdkShmemManageエントリ
システムが使用する値です。DocumentSpace構成定義ファイルに記述されているデフォルトの指定値を変更しないでください。
XdkShmemSizeエントリ
メタ情報管理用に確保するメモリマップトファイルのサイズを指定するエントリです。DocumentSpace構成定義ファイルに記述されているデフォルトの指定値を変更しないでください。
なお,OSのページングファイルサイズの値には,このメモリマップトファイルが確保できる十分なサイズを指定してください。
メモリマップトファイルはOSのページングファイルサイズの制限を受けるため,メタ情報管理用に確保するメモリマップトファイルがこの制限を超えると,メモリマップトファイルを確保できないことがあります。コントロールパネルの[システム]-[詳細設定]タブ-[パフォーマンスオプション]ダイアログの仮想メモリを確認してください。このメモリマップトファイルを確保できない場合は,File Sharingサーバが停止します。このとき,KMBR02004-Eのメッセージが出力されます。メッセージの詳細については,マニュアル「Collaboration - File Sharing メッセージ」を参照してください。
FtpBufferSizeエントリ
ファイル分割転送機能を使用してファイル転送する場合の,データ転送サイズを指定します。指定できる値の範囲は,4,096~2,147,483,647(バイト)です。
このエントリの記述を省略した場合は,ファイル分割転送機能を使用しないでファイル転送を実行します。なお,ファイル分割転送機能については,「4.4.3(2) ファイル分割転送機能の設定」を参照してください。
SelectServerInMultiServerエントリ
複数の実行環境から,同じ文書空間にアクセスする運用形態の場合に,File Sharingクライアント側で接続するFile Sharingサーバを選択するかどうかを指定します。
  • Yes
    File Sharingクライアント側で接続するFile Sharingサーバを選択します。
  • No
    File Sharingクライアント側で接続するFile Sharingサーバを選択しません。
Yesを指定した場合,File Sharingクライアント側で,接続するFile Sharingサーバの実行環境識別子を指定する必要があります。
上記以外の値を指定した場合,File Sharingサーバの起動時にエラーが発生します。指定を省略した場合,「No」が仮定されます。
なお,同じ文書空間にアクセスするすべての実行環境でSelectServerInMultiServerエントリの値を同じにしてください。
VarrayElementCheckエントリ
システムが使用する値です。DocumentSpace構成定義ファイルに記述されているデフォルトの指定値を変更しないでください。
ErrChkFlagOfObjectOperationエントリ
システムが使用する値です。DocumentSpace構成定義ファイルに記述されているデフォルトの指定値を変更しないでください。
EnbFncFlagOfObjectOperationエントリ
システムが使用する値です。DocumentSpace構成定義ファイルに記述されているデフォルトの指定値を変更しないでください。

(4) DocumentSpace構成定義ファイルの記述例

DocumentSpace構成定義ファイルの次に示すエントリ(記述例の太字の個所)は,実行環境に応じて必ず変更してください。

DocumentSpace構成定義ファイルの記述例を次に示します。

[DocSpace]
Count      = 1

[Entry0001]
Process    = 1
SerialId   = 673d2be0-d1fd-11d0-ab59-08002be29e1d
DbType     = HIRDB
PdHost     = hostname
PdNamePort = 20550
PdUser     = "user"/"pass"
XdkShmemManage = NORMAL
XdkShmemSize   = 4000000
VarrayElementCheck = Yes
ErrChkFlagOfObjectOperation = 0x0000007f
EnbFncFlagOfObjectOperation = 0x000000ff

UserAuthentication = UOC
UOCLibrary         = C:¥Program Files¥Hitachi¥Collaboration¥filesharing¥Server¥lib¥cfsauth_UTF-8.dll

(5) DocumentSpace構成定義ファイルの注意事項

DocumentSpace構成定義ファイルを直接編集して,文書空間を定義する場合の注意事項について説明します。

(a) 文書空間の構成を変更する場合の注意事項

File Sharingの運用を開始してから,セッションタイムアウト時間の変更などによって,文書空間の構成を変更するような場合が考えられます。このような場合は,次の手順で文書空間の構成を変更してください。

  1. File Sharingサーバを終了します。
  2. 文書空間の構成定義を変更します。
  3. File Sharingサーバを再起動します。

なお,File Sharingサーバの起動と終了については,「7.2 File Sharingサーバの起動と終了」を参照してください。