7.6.3 動作環境定義ファイル

Java クラスライブラリの動作については,動作環境定義ファイルに定義します。動作環境定義ファイルには,デフォルトの文書空間識別子およびトレースファイルに関する情報が定義できます。

<この項の構成>
(1) 動作環境定義ファイルの名称と格納先
(2) 動作環境定義ファイルの記述形式
(3) コンフィグレーションキーの詳細
(4) ファイルの内容の有効期間

(1) 動作環境定義ファイルの名称と格納先

動作環境定義ファイルの名称は,次のとおりです。

conf.properties

動作環境定義ファイルは,次のディレクトリに格納してください。

UNIXの場合

/opt/HiEDMS/client/java/etc

Windowsの場合

<インストールディレクトリ>¥java¥etc

(2) 動作環境定義ファイルの記述形式

動作環境定義ファイルは,環境に応じて編集してください。

動作環境定義ファイルの記述形式は,Javaのプロパティファイルの記述形式に従います。文書空間で使用する文字コード種別がUTF-8の場合は,印刷可能なASCIIコードで記述してください。

各行のキーにコンフィグレーションキーを指定して,キー値にその設定値を指定します。

形式は,次のとおりです。

コンフィグレーションキー = 設定値

(3) コンフィグレーションキーの詳細

動作環境定義ファイルに設定するコンフィグレーションキーと,設定する値の詳細を,次の表に示します。なお,指定した値が,使用できる値の範囲を満たさない場合は,省略時の値が仮定されます。

表7-1 コンフィグレーションキー

コンフィグレーションキー設定値省略値説明
APTracePath文字列(AIXの場合:1,022バイト以内,Windowsの場合:260バイト以内)
  • AIXの場合
    /opt/HiEDMS/client/java/log
  • Windowsの場合
    <インストールディレクトリ>¥java¥log
次に示すファイルを出力するディレクトリをフルパスで設定します。
  • アプリケーショントレースファイル
    「DbjAPTraceプロセスID(0xで始まる16進数)_トレースファイル番号.log」
  • アプリケーションエラーログファイル
    「DbjAPTraceErrプロセスID(0xで始まる16進数)_エラーログファイル番号.log」
なお,パスの区切り文字は,AIXの場合は「/」,Windowsの場合は「¥¥」を使用してください。
指定例:C:¥¥DocumentBroker¥¥log
APTraceLevel数値(0~30)10トレースレベルを設定します。
この設定は,次に示す出力先にトレース情報を出力する場合に有効になります。
  • コマンドプロンプト(Windowsの場合)
  • 標準出力・標準エラー出力(AIXの場合)
  • アプリケーショントレースファイル
APTraceSize数値(4,096~2,147,483,647)1,000,000アプリケーショントレースファイルのファイルサイズの上限を設定します(単位:バイト)。
APTraceNumber数値(0~16)2アプリケーショントレースファイルのファイルサイズの上限を超えた場合に,切り替えるファイルの数を設定します。
切り替えるファイルの数の上限を超えると,最初のファイルに戻って出力されます。このとき,ファイルは上書きされます。
0を設定した場合は,アプリケーショントレースファイルを出力しません。
APErrorLogSize数値(4,096~2,147,483,647)1,000,000アプリケーションエラーログファイルのファイルサイズの上限を設定します(単位:バイト)。
APErrorLogNumber数値(1~16)2アプリケーションエラーログファイルのファイルサイズの上限を超えた場合に,切り替えるファイルの数を設定します。
切り替えるファイルの数の上限を超えると,最初のファイルに戻って出力されます。このとき,ファイルは上書きされます。
DefaultDocSpaceId※1文字列(8-4-4-4-12形式のGUID文字列)DbjDef.DEFAULT_DOCSPCIDデフォルトの文書空間識別子を設定します。
EnableFunctionFlag※1※2数値(0x00000000​~0xffffffff)0x00000000​オブジェクトを操作したときの動作をbitフラグで指定します。ユーザは動作環境定義ファイルに記載した値を変更しないでください。なお,新規インストール時に記載されている値は0x00000003​です。
PromptOutputSTDOUTまたはSTDERRSTDOUTトレース情報を標準出力に出力するか,標準エラー出力に出力するかを次の文字列で設定します。文字列は,すべて大文字で設定します。
  • STDOUT:標準出力
  • STDERR:標準エラー出力
TracePath文字列(AIXの場合:1,022バイト以内,Windowsの場合:260バイト以内)
  • AIXの場合
    /opt/HiEDMS/client/java/log
  • Windowsの場合
    <インストールディレクトリ>¥java¥log
クライアント共用トレースファイル※3を出力するディレクトリをフルパスで設定します。
なお,パスの区切り文字は,AIXの場合は「/」,Windowsの場合は「¥¥」を使用してください。
指定例:C:¥¥DocumentBroker¥¥log
TraceSize数値(4,096~2,147,483,647)1,000,000クライアント共用トレースファイルのファイルサイズの上限を設定します(単位:バイト)。
TraceNumber数値(1~16)2クライアント共用トレースファイルのファイルサイズの上限を超えた場合に,切り替えるファイルの数を設定します。
切り替えるファイルの数の上限を超えると,最初のファイルに戻って出力されます。このとき,ファイルは上書きされます。
DocSpaceCharacterSetFROMSERVER,SJIS,またはUTF-8FROMSERVER文書空間で使用する文字コード種別を,次の文字列で設定します。文字列は,すべて大文字で設定します。
  • FROMSERVER:
    文書空間へのログイン時に,文書空間で使用する文字コード種別の設定をDocumentBroker Serverから受け取り,その設定に合わせた文字コード種別を使用します。
    この文字列は,文字コード種別が異なる複数の文書空間に接続する場合に設定します。
    なお,文書空間へのログイン前は無条件でShift-JISを使用するため,メソッドはログイン後に実行してください。
  • SJIS:
    Shift-JISを使用します。
    この文字列は,ログインする文書空間の文字コード種別がすべてShift-JISの場合に設定します。ログインする文書空間の文字コード種別と異なる文字コード種別を設定した場合の動作は保証しません。
  • UTF-8:
    UTF-8を使用します。
    この文字列は,ログインする文書空間の文字コード種別がすべてUTF-8の場合に設定します。ログインする文書空間の文字コード種別と異なる文字コード種別を設定した場合の動作は保証しません。
注※1
同一文書空間へ複数のクライアント環境から接続する構成の場合,コンフィグレーションキーの設定値は各クライアント環境の動作環境定義ファイルで同じ値を指定してください。
注※2
Java クラスライブラリを使用したアプリケーションを移設する場合,コンフィグレーションキーの設定値は移設前の環境の動作環境定義ファイルと同じ値を指定してください。
注※3
クライアント共用トレースファイル
「DBJComTraceプロセスID(0xで始まる16進数)_トレースファイル番号.log」

(4) ファイルの内容の有効期間

動作環境定義ファイルの内容は,Java クラスライブラリを初期化するときに読み込まれます。一度読み込まれたあとは,プロセスが終了するまで再読み込みはされません。