3.13.2 ファイル転送機能のためのDocumentBrokerクライアントでの環境設定

ここでは,ファイル転送機能を使用するための,DocumentBrokerクライアントの環境設定について説明します。次に示す手順で環境設定を実行してください。

<この項の構成>
(1) ファイル転送サービス実行環境ディレクトリの作成
(2) 環境変数の設定(AIXの場合)
(3) 環境変数の設定(Linuxの場合)
(4) ファイル転送サービス実行環境の作成
(5) ファイル転送サービス環境定義ファイルの設定
(6) ファイル転送サービスのメモリ所要量の見積もり
(7) ファイル転送サービスの開始モードの設定

(1) ファイル転送サービス実行環境ディレクトリの作成

ファイル転送サービスの実行環境を作成するためのディレクトリを作成してください。ここで,作成したディレクトリの下に,ファイル転送サービスの各種ディレクトリおよびファイルが格納されます。ディレクトリ名称は任意ですが,次に示す情報を設定してください。

(2) 環境変数の設定(AIXの場合)

ファイル転送サービスを使用するために,クライアントアプリケーション実行環境とファイル転送サービス実行環境に必要な環境変数を設定してください。設定が必要な環境変数について次に説明します。

(a) LANGの設定

環境変数「LANG」には,使用する文字コードセットを設定します。接続先のDocumentBrokerサーバの文書空間で使用する文字コード種別に合わせて値を設定してください。

文書空間で使用する文字コード種別がShift-JISの場合
設定する値は「Ja_JP」です。
文書空間で使用する文字コード種別がUTF-8の場合
使用する言語に合わせて適切な値を設定してください。

ただし,次のときは「C」を設定してください。

なお,この環境変数に設定する値によって,メッセージの言語種別が変わります。「Ja_JP」を設定した場合は,日本語のメッセージが出力されます。「Ja_JP」以外を設定した場合は,英語のメッセージが出力されます。

(b) TZの設定

次の値を指定します。

JST-9

(c) _HIEDMS_FTPDIRの設定

ファイル転送サービスの実行環境ディレクトリを指定してください。文書空間で使用する文字コード種別がUTF-8の場合は,印刷可能なASCIIコードで値を設定してください。

(d) DocumentBrokerクライアントのライブラリの設定

DocumentBrokerクライアントに必要なライブラリのディレクトリを次のように設定します。

LIBPATHの設定
  • TPBroker V3を使用する場合
    :/opt/HiEDMS/client/lib
  • TPBroker V5を使用する場合
    :/opt/HiEDMS/client/lib_tp5

(e) PATHの設定

次の値を追加します。

:ファイル転送サービスの実行環境ディレクトリ/bin

(f) _HIEDMS_FTPMODEの設定

使用するファイル転送サービスの開始モードを指定します。次のどれかを指定してください。なお,この環境変数は,クライアントアプリケーション実行環境だけに必要です。

STATIC
静的モードで開始されたファイル転送サービスを使用します。
DYNAMIC
動的モードで開始されたファイル転送サービスを使用します。
NONE
ファイル転送サービスを使用しません。

この環境変数の設定を省略した場合,「NONE」が仮定されます。

(g) _HIEDMS_FTPORBBOA_OPTIONの設定

動的モードで開始されるファイル転送サービスプロセスに固有のORBおよびBOAのオプションを指定します。この環境変数は,クライアントアプリケーション実行環境だけに必要です。

この環境変数の設定を省略した場合に仮定される値はありません。ORBおよびBOAのオプション以外の値を指定した場合,ファイル転送サービスプロセスの起動に失敗します。

動的モードで開始されるファイル転送サービスプロセスのORBおよびBOAのオプションは,ファイル転送サービス環境定義ファイルの[FtpService]セクションのFtpProcessOrbBoaOptionエントリの値と,この環境変数に設定した値を連結した値になります。

静的モードで開始する場合,この環境変数を設定しても無視されます。静的モードで開始する場合は,ファイル転送サービス環境定義ファイルの[FtpProcessXXXX]セクション(XXXXは0001~0020)のOrbBoaOptionエントリに設定してください。

なお,この環境変数は,TPBroker V5と連携して動作する環境では指定できません。

TPBroker V5環境で指定した場合は,指定が無視されます。TPBroker V5環境では,VisiBrokerプロパティとして_HIEDMS_FTPVB_PROPERTYに指定してください。

(h) _HIEDMS_FTPVB_PROPERTYの設定

動的モードで開始されるファイル転送サービスプロセスに固有のVisiBrokerプロパティを指定します。この環境変数は,クライアントアプリケーション実行環境だけに必要です。

この環境変数の設定を省略した場合に仮定される値はありません。VisiBrokerプロパティ以外の値を指定した場合,ファイル転送サービスプロセスの起動に失敗します。指定できるプロパティの詳細は,マニュアル「VisiBroker Version 5 Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。

動的モードで開始されるファイル転送サービスプロセスのVisiBrokerプロパティは,ファイル転送サービス環境定義ファイルの[FtpService]セクションのFtpProcessVBPropertyエントリの値と,この環境変数に設定した値を連結した値になります。

静的モードで開始する場合,この環境変数を設定しても無視されます。静的モードで開始する場合は,ファイル転送サービス環境定義ファイルの[FtpProcessXXXX]セクション(XXXXは0001~0020)のVBPropertyエントリに設定してください。

なお,この環境変数は,TPBroker V3と連携して動作する環境では指定できません。

TPBroker V3環境で指定した場合は,指定が無視されます。TPBroker V3環境では,ORB/BOAオプションとして_HIEDMS_FTPORBBOA_OPTIONに指定してください。

(i) PSALLOCの設定

メモリ領域の確保をメモリ使用時でなく,メモリ領域要求時に行う,早期ページスペース割り当てを実行するための設定をします。次の値を指定します。

early

(j) NODISCLAIMの設定

メモリ領域の解放を抑止するための設定をします。次の値を指定します。

true

(3) 環境変数の設定(Linuxの場合)

ファイル転送サービスを使用するために,クライアントアプリケーション実行環境とファイル転送サービス実行環境に必要な環境変数を設定してください。設定が必要な環境変数について次に説明します。

(a) LANGの設定

環境変数「LANG」には,使用する文字コードセットを設定します。接続先のDocumentBrokerサーバの文書空間で使用する文字コード種別に合わせて値を設定してください。

文書空間で使用する文字コード種別がShift-JISの場合
設定する値は「ja_JP.SJIS」です。
文書空間で使用する文字コード種別がUTF-8の場合
使用する言語に合わせて適切な値を設定してください。

ただし,次のときは「C」を設定してください。

なお,この環境変数に設定する値によって,メッセージの言語種別が変わります。「ja_JP.SJIS」を設定した場合は,日本語のメッセージが出力されます。「ja_JP.SJIS」以外を設定した場合は,英語のメッセージが出力されます。

(b) TZの設定

次の値を指定します。

JST-9

(c) _HIEDMS_FTPDIRの設定

ファイル転送サービスの実行環境ディレクトリを指定してください。文書空間で使用する文字コード種別がUTF-8の場合は,印刷可能なASCIIコードで値を設定してください。

(d) DocumentBrokerクライアントのライブラリの設定

DocumentBrokerクライアントに必要なライブラリのディレクトリを次のように設定します。

LD_LIBRARY_PATHの設定
:/opt/HiEDMS/client/lib

(e) PATHの設定

次の値を追加します。

:ファイル転送サービスの実行環境ディレクトリ/bin

(f) _HIEDMS_FTPMODEの設定

使用するファイル転送サービスの開始モードを指定します。次のどれかを指定してください。なお,この環境変数は,クライアントアプリケーション実行環境だけに必要です。

STATIC
静的モードで開始されたファイル転送サービスを使用します。
DYNAMIC
動的モードで開始されたファイル転送サービスを使用します。
NONE
ファイル転送サービスを使用しません。

この環境変数の設定を省略した場合,「NONE」が仮定されます。

(g) _HIEDMS_FTPORBBOA_OPTIONの設定

動的モードで開始されるファイル転送サービスプロセスに固有のORBおよびBOAのオプションを指定します。この環境変数は,クライアントアプリケーション実行環境だけに必要です。

この環境変数の設定を省略した場合に仮定される値はありません。ORBおよびBOAのオプション以外の値を指定した場合,ファイル転送サービスプロセスの起動に失敗します。

動的モードで開始されるファイル転送サービスプロセスのORBおよびBOAのオプションは,ファイル転送サービス環境定義ファイルの[FtpService]セクションのFtpProcessOrbBoaOptionエントリの値と,この環境変数に設定した値を連結した値になります。

静的モードで開始する場合,この環境変数を設定しても無視されます。静的モードで開始する場合は,ファイル転送サービス環境定義ファイルの[FtpProcessXXXX]セクション(XXXXは0001~0020)のOrbBoaOptionエントリに設定してください。

なお,この環境変数は,TPBrokerと連携して動作する環境では指定できません。

TPBroker環境で指定した場合は,指定が無視されます。TPBroker環境では,VisiBroker プロパティとして_HIEDMS_FTPVB_PROPERTY に指定してください。

(h) _HIEDMS_FTPVB_PROPERTYの設定

動的モードで開始されるファイル転送サービスプロセスに固有のVisiBrokerプロパティを指定します。この環境変数は,クライアントアプリケーション実行環境だけに必要です。

この環境変数の設定を省略した場合に仮定される値はありません。VisiBrokerプロパティ以外の値を指定した場合,ファイル転送サービスプロセスの起動に失敗します。指定できるプロパティの詳細は,マニュアル「VisiBroker Version 5 Borland(R) Enterprise Server VisiBroker(R) プログラマーズリファレンス」を参照してください。

動的モードで開始されるファイル転送サービスプロセスのVisiBrokerプロパティは,ファイル転送サービス環境定義ファイルの[FtpService]セクションのFtpProcessVBPropertyエントリの値と,この環境変数に設定した値を連結した値になります。

静的モードで開始する場合,この環境変数を設定しても無視されます。静的モードで開始する場合は,ファイル転送サービス環境定義ファイルの[FtpProcessXXXX]セクション(XXXXは0001~0020)のVBPropertyエントリに設定してください。

(i) PSALLOCの設定

メモリ領域の確保をメモリ使用時でなく,メモリ領域要求時に行う,早期ページスペース割り当てを実行するための設定をします。次の値を指定します。

early

(j) NODISCLAIMの設定

メモリ領域の解放を抑止するための設定をします。次の値を指定します。

true

(4) ファイル転送サービス実行環境の作成

ファイル転送サービスセットアップコマンドを実行してください。

AIXの場合
TPBroker V3 を使用する場合
ファイル転送サービスセットアップコマンド(/opt/HiEDMS/client/bin/FtpSvSetup)を実行してください。
TPBroker V5 を使用する場合
ファイル転送サービスセットアップコマンド(/opt/HiEDMS/client/bin_tp5/FtpSvSetup)を実行してください。
Linuxの場合
ファイル転送サービスセットアップコマンド(/opt/HiEDMS/client/bin/
FtpSvSetup)を実行してください。

ファイル転送サービスセットアップコマンドの文法と注意事項などの詳細については,「3.13.4 ファイル転送機能で使用するコマンド」を参照してください。

(5) ファイル転送サービス環境定義ファイルの設定

ファイル転送機能を使用するためには,ファイル転送サービス環境定義ファイルの定義が必要になります。ファイル転送サービス環境定義ファイルについては,「4.12 ファイル転送サービス環境定義ファイル(ftpsv.ini)」を参照してください。

(6) ファイル転送サービスのメモリ所要量の見積もり

ファイル転送サービスを使用する場合のメモリ所要量を算出します。計算式を次に示します。

計算式(単位:メガバイト)
AIXの場合
  • TPBroker V3を使用するとき
    7+(4×p)+(0.02+d)×u
  • TPBroker V5を使用するとき
    8+(6×p)+(0.02+d)×u
Linuxの場合
138+(125×p)+(0.02+d)×u
 
ただし,d=(4×s)

p,u,およびsに設定する値の説明を次の表に示します。なお,sの単位は,メガバイトです。

表3-11 ファイル転送サービスの所要メモリの計算式で使用する変数と設定する値

変数指定する値
pファイル転送サービスプロセス数
u同時にファイル転送するセッション数
s次の1.と2.で算出した値の中での最大値
  1. マルチファイル文書の場合
    DocumentSpace構成定義ファイルのBlobSubstrModeエントリに指定する値によって,算出値が異なります。
    ALLまたはELEMENTの場合:文書空間で管理する最大ファイルサイズ(メガバイト)
    THRESHOLDの場合:BlobSubstrThresholdエントリ値
  2. 上記以外の文書の場合
    文書空間で管理する最大文書サイズ(メガバイト)

(7) ファイル転送サービスの開始モードの設定

DocumentBrokerクライアント側での環境設定の際に,ファイル転送サービスの開始モードとして,「静的モード」または「動的モード」のどちらかを設定する必要があります。開始モードは,環境変数「_HIEDMS_FTPMODE」で設定します。環境変数「_HIEDMS_FTPMODE」については,「(2) 環境変数の設定(AIXの場合)」または「(3) 環境変数の設定(Linuxの場合)」を参照してください。