オブジェクト操作ツールを使用するためには,環境変数の設定が必要です。
なお,設定する環境変数は,OSごとに異なります。
環境変数は,各マシンのログインシェル環境に合わせて次のファイルに設定してください。なお,「$HOME」は,ログインユーザのホームディレクトリを示します。
環境変数「LANG」には,使用する文字コードセットを設定します。DocumentBrokerの文書空間で使用する文字コード種別に合わせて値を設定してください。
ただし,次のときは「C」を設定してください。
なお,この環境変数に設定する値によって,メッセージの言語種別が変わります。「Ja_JP」を設定した場合は,日本語のメッセージが出力されます。「Ja_JP」以外を設定した場合は,英語のメッセージが出力されます。
環境変数「TZ」には,マシン時間のタイムゾーンを設定します。設定する値は「JST-9」です。
環境変数「XDK_HOME」には,SystemManagerオブジェクトのレジストリファイルの格納場所を設定します。設定する値は,「/opt/HiEDMS/client/etc」です。
関連プログラムのライブラリおよびDocumentBrokerのクライアントライブラリのインストールディレクトリを設定します。次の値を追加してください。
:/opt/hitachi/common/lib
:/usr/vacpp/lib※
:/opt/TPBroker/lib
:/opt/hitachi/common/lib
:/usr/vacpp/lib※
:TPBroker V5インストールディレクトリ/lib
:/opt/HiEDMS/client/lib
:/opt/HiEDMS/ACLibrary/lib
:/opt/HiEDMS/client/lib_tp5
:/opt/HiEDMS/ACLibrary/lib_tp5
環境変数「PATH」には,オブジェクト操作ツールのインストールディレクトリを追加します。オブジェクト操作ツールは,「/opt/HiEDMS/client/tools」および「/opt/HiEDMS/client/tools_tp5」ディレクトリにインストールされます。したがって,追加する値は,TPBroker V3を使用する場合は,「:/opt/HiEDMS/client/tools」,TPBroker V5を使用する場合は,「:/opt/HiEDMS/client/tools_tp5」です。
環境変数「DBRTOOLSDIR」には,オブジェクト操作ツールの実行環境ディレクトリを設定してください。
環境変数「DBR_DETAIL_ERRORLOG」は,詳細メッセージを取得する場合に設定します。詳細メッセージを取得する場合に設定する値は「ON」です。
環境変数「DBR_DETAIL_ERRORLOG」に「ON」が設定されている場合,オブジェクト操作ツール実行時の詳細メッセージが標準エラー出力および詳細エラーログファイルに出力されます。
出力される詳細メッセージは,オブジェクト操作ツールのコマンドが使用している,クラスライブラリのメソッドに関する詳細メッセージです。
この環境変数を省略した場合または値に「ON」以外を設定した場合は,詳細メッセージは標準エラー出力および詳細エラーログファイルのどちらにも出力されません。
出力される詳細メッセージの内容については,マニュアル「DocumentBroker Version 3 メッセージ」を参照してください。
環境変数「PSALLOC」には,メモリ領域の確保をメモリ使用時でなく,メモリ領域要求時に行う,早期ページスペース割り当てを実行するための設定をします。設定する値は「early」です。
環境変数「NODISCLAIM」には,メモリ領域の解放を抑止するための設定をします。設定する値は「true」です。
環境変数「EDMCLASSDEFPATH」が設定されている環境でオブジェクト操作ツールを使用する場合,オブジェクト操作ツールの実行時には,オブジェクト操作ツール実行環境ディレクトリ下に存在するクラス定義情報ファイルではなく,環境変数「EDMCLASSDEFPATH」に設定されたディレクトリに存在するクラス定義情報ファイルが参照されます。
なお,文書空間で使用する文字コード種別がUTF-8の場合,環境変数「EDMCLASSDEFPATH」には,印刷可能なASCIIコードで値を設定してください。
ただし,この場合も,文書空間識別子は,オブジェクト操作ツール実行環境ディレクトリ下の実行環境制御ファイルに記述されているものが使用されます。
環境変数を設定します。
全ユーザで共通の値にする場合は,「システム環境変数」に設定してください。ログインユーザごとに設定する場合は,「ユーザ環境変数」に設定してください。
環境変数は[コントロールパネル]の[システム]の[環境変数]ボタンをクリックして表示される[環境変数]ダイアログで設定します。なお,詳細については,各OSのヘルプで確認してください。
環境変数「PATH」には,オブジェクト操作ツールのインストールディレクトリを追加します。オブジェクト操作ツールは,「<インストールディレクトリ>¥tools」ディレクトリにインストールされます。したがって,インストールディレクトリが「C:¥Program Files¥HITACHI¥DocBroker¥Client」の場合,追加する値は,「;C:¥Program Files¥HITACHI¥DocBroker¥Client¥tools」です。
環境変数「DBRTOOLSDIR」には,オブジェクト操作ツールの実行環境ディレクトリを設定してください。
文書空間で使用する文字コード種別がUTF-8の場合,印刷可能なASCIIコードで値を設定してください。
環境変数「DBR_DETAIL_ERRORLOG」は,詳細メッセージを取得する場合に設定します。詳細メッセージを取得する場合に設定する値は「ON」です。
環境変数「DBR_DETAIL_ERRORLOG」に「ON」が設定されている場合,オブジェクト操作ツール実行時の詳細メッセージが標準エラー出力および詳細エラーログファイルに出力されます。
出力される詳細メッセージは,オブジェクト操作ツールのコマンドが使用している,クラスライブラリのメソッドに関する詳細メッセージです。
この環境変数を省略した場合または値に「ON」以外を設定した場合は,詳細メッセージは標準エラー出力および詳細エラーログファイルのどちらにも出力されません。
出力される詳細メッセージの内容については,マニュアル「DocumentBroker Version 3 メッセージ」を参照してください。
環境変数「EDMCLASSDEFPATH」が設定されている環境でオブジェクト操作ツールを使用する場合,オブジェクト操作ツールの実行時には,オブジェクト操作ツール実行環境ディレクトリ下に存在するクラス定義情報ファイルではなく,環境変数「EDMCLASSDEFPATH」に設定されたディレクトリに存在するクラス定義情報ファイルが参照されます。
なお,文書空間で使用する文字コード種別がUTF-8の場合,環境変数「EDMCLASSDEFPATH」には,印刷可能なASCIIコードで値を設定してください。
ただし,この場合も,文書空間識別子は,オブジェクト操作ツール実行環境ディレクトリ下の実行環境制御ファイルに記述されているものが使用されます。