3-1-1 クライアント側(API呼び出し側アプリケーション)の設定

クライアント側(API呼び出し側アプリケーション)の設定順序は次のとおりです。

  1. SVF Connect for .NET Frameworkアセンブリモジュールの参照設定

    SVF Connect for .NET Frameworkのアセンブリモジュールを使用してSVFのAPI関数を呼び出すアプリケーションを開発するには、インストールで指定したディレクトリにある「jp.co.fit.vfreport.SvfrClient.dll」を参照設定に追加する必要があります。

  2. .NET用アセンブリモジュールの動作設定
    • .NET用アセンブリモジュールの動作は、「svfrclient.properties」ファイルのオプション設定で制御されます。必要に応じて、svfrclient.propertiesを書き換えてください。
    • .NET用アセンブリモジュールの動作時に参照される「svfrclient.properties」ファイルは、次の順序で検索されます。必要に応じて、配置場所を決めてください。
      1. システム環境変数「jp.co.fit.vfreport.home」で指定されたディレクトリ
        環境変数は、手動で設定する必要があります。
      2. アプリケーションのカレントワーキングディレクトリ
        通常、アプリケーションのあるディレクトリです。ASP.NETのWebアプリケーションの場合は、「<ドライブ>:¥WINDOWS¥system32¥inetsrv」です。

svfrclient.propertiesのオプション

「svfrclient.properties」ファイルで設定するオプションは次のとおりです。必要な項目のみ設定してください。

Socket、HTTP共通

オプション 説明
Connection.Method 通信方式を指定します。
  • 0
    Socket(デフォルト)
  • 1
    HTTP
Support.Encodings サポートしているEncoding一覧です。デフォルトは「SJIS、MS932、Cp942、Cp942C、Cp943、Cp943C、MS874、MS936、MS949、MS950、Cp1250、Cp1251、Cp1252、Cp1253Cp1254Cp1258UTF8UTF16」です。「CP1251CP1253CP1258」はService Pack 1以降を、「Cp1254」はService Pack 2を適用すると追加されます。「CP1251CP1253CP1254CP1258」を使用するには、実行部(Java版)も該当のService Packを適用してください。
Default.Encoding デフォルトのEncodingを指定します。指定できるのは、Support.Encodingsに記述されているもののみです。
DefaultSpoolFileName VrSetSpoolFileName2関数を使用してスプールファイル名を指定しなかった場合、使用するファイル名を設定します。
Debug.Mode API呼び出し側アプリケーションのデバッグログのロギングを設定します。
  • true
    ロギングする
  • false
    ロギングしない(デフォルト)
Debug.CheckThread SVF Connect for .NET Framework APIでは、1スレッド1オブジェクトである必要があります。
  • true(デフォルト)
    複数スレッドによるアクセスを不正アクセスと認識する
  • false
    複数スレッドによるアクセスを不正アクセスと認識しない

「true」に設定した場合は、「System.UnauthorizedAccessException: Illegal thread access」という例外が発生します。

Debug.LogDir デバッグログの出力先(ディレクトリ)を指定します。
  • 指定例
    C:¥Debug¥
LocalPrint.Delete 転送成功時にスプールファイルを削除するかどうかを指定します。
  • true
    削除する(デフォルト)
  • false
    削除しない
LocalPrint.LogDir ログの出力先を指定します。デフォルトは一時領域です。
LocalPrint.LogRotate ログのローテートを指定します。
  • 0
    none(なし)
  • 1
    daily(日単位。デフォルト)
  • 2
    weekly(週単位。曜日に関係なく月の日を7日単位で区切る。「1」は1から7、「2」は8から14、「3」は15から21、「4」は22から28、「5」は29以降です。)
  • 3
    monthly(月単位)
LocalPrint.Spooler.[任意の文字列] 使用するスプーラーの種類を指定します。デフォルトは「なし」です。「任意の文字列」には半角英数字でスプーラー設定名を指定し、VrLocalPrint関数の引数として使用します。
LocalPrint.Spooler.[任意の文字列].Host スプーラーのホスト名を指定します。PAlite使用時のデフォルトは「127.0.0.1」です。IPv6のIPアドレスを指定する場合にはIPアドレスを[]で囲んでください。
  • 指定例
    [::1]
LocalPrint.Spooler.[任意の文字列].Port スプーラーのポート番号を指定します。PAlite使用時のデフォルトは「44201」です。
LocalPrint.Spooler.[任意の文字列].PrinterName スプーラーのプリンター名を指定します。PAlite使用時のデフォルトは「なし」です。
LocalPrint.Spooler.[任意の文字列].PAProtocolVersion スプーラーのバージョンを指定します。PAlite使用時のデフォルトは「3」です。

Socket

オプション 説明
Remote.retryCount SVF実行サーバー側接続用ランタイムとのTCP接続失敗時のリトライ回数を設定します。デフォルトは「5」です。
Remote.retryWait SVF実行サーバー側接続用ランタイムとのTCP接続失敗時のリトライ待ち時間(ミリ秒)を設定します。デフォルトは「3000」です。
Remote.Hosts SvfrClientの接続先ホストを示しています。デフォルトは「127.0.0.1」です。IPv6のIPアドレスを指定する場合にはIPアドレスを[]で囲んでください。
  • 指定例
    [::1]
Remote.port SvfrClientの接続先ポートを示しています。デフォルトは「4141」です。
Remote.CheckConnectionBusy クライアントライブラリから接続用ランタイムに接続した後、一定時間内に読み込み、書き込みが行われるかどうかをチェックすることで回線がビジー状態であるかどうかを判定します。
  • true
    チェックする(デフォルト)
  • false
    チェックしない
Remote.ConnectionTimeout

クライアントライブラリから接続用ランタイムに接続するときのタイムアウト時間(秒)を設定します。デフォルトは「0」(無効)です。

この値はアプリケーションサーバーOSの「TCPタイムアウト」に依存するため、「TCPタイムアウト」以上の値を設定した場合は無効となります。

「TCPタイムアウト」の値についてはOSの設定を確認してください。

Remote.CloseTimeout 切断時に待機するタイムアウト時間(秒)を設定します。デフォルトは「5」です。
Remote.KeepAliveInterval キープアライブの間隔(秒)を設定します。APIをコールした後応答がない場合、正常に動作しているかどうか判断できないので、サーバーから定期的にキープアライブパケットを送信することでAPIの応答がない状態であってもキープアライブタイムアウトの時間以内にパケットを受信しているかどうかの死活監視を行います。
設定を有効にするには、サーバー側のSVF実行部接続用ランタイムもキープアライブに対応している必要があります。「0」は無効(デフォルト)です。
Remote.KeepAliveTimeout キープアライブタイムアウトの時間(秒)を設定します。設定を有効にするには、サーバー側のSVF実行部接続用ランタイムもキープアライブに対応している必要があります。デフォルトは「120」です。Remote.KeepAliveIntervalで設定した値以上の秒数を設定してください。
Remote.RecvTimeout 各API呼び出し後の応答受信待ち時間のタイムアウトの間隔(分)を設定します。 デフォルトは「120」です。
Remote.SendTimeout 接続完了後、クライアントライブラリが送信可能状態になるまでの待ち時間(分)を設定します。デフォルトは「15」です。
ErrorRecovery.TargetErrorMode エラーリカバリモードを設定します。
  • 0
    リカバリなし(デフォルト)
  • 1
    ErrorRecovery.TargetErrorListにリカバリ対象にするエラーを設定する
  • 2
    ErrorRecovery.TargetErrorListにリカバリ対象にしないエラーを設定する
ErrorRecovery.TargetErrorList エラーリカバリモードが「1」または「2」の場合に該当するエラー(「-30」など)を設定します。エラーは、カンマ区切りで、複数指定できます。
ErrorRecovery.TargetErrorModeに「1」または「2」を設定した場合、エラー「-4971」が発生すると、リストに設定していなくてもリトライします。
ErrorRecovery.RetryCount エラーリカバリモードが「1」または「2」の場合にリカバリする回数を設定します。デフォルトは「3」です。
LocalServer.FileName オンデマンド起動により起動する.NET版接続用ランタイムのパスを設定します。
LocalServer.Arguments オンデマンド起動により起動する.NET版接続用ランタイムに渡す引数を設定します。  
LocalServer.StartTimeout オンデマンド起動時のタイムアウト時間(秒)を設定します。デフォルトは「30」です。

HTTP

オプション 説明
Connection.HTTP.Method HTTP通信における通信手段を指定します。
  • 0
    通常転送(デフォルト)
  • 1
    一括転送
Remote.HTTP.retryCount SVF実行サーバー側接続用ランタイムとのTCP接続失敗時のリトライ回数を設定します。デフォルトは「5」です。
Remote.HTTP.retryWait SVF実行サーバー側接続用ランタイムとのTCP接続失敗時のリトライ待ち時間(ミリ秒)を設定します。デフォルトは「3000」です。
Remote.HTTP.Hosts SvfrClientの接続先ホストを示しています。デフォルトは「127.0.0.1」です。IPv6のIPアドレスを指定する場合にはIPアドレスを[]で囲んでください。
  • 指定例
    [::1]
Remote.HTTP.port SvfrClientの接続先ポートを示しています。デフォルトは「44090」です。ポート番号を変更する際は、サポートセンターまでお問い合わせください。
Remote.HTTP.KeepAliveInterval キープアライブの間隔(秒)を設定します。APIをコールした後応答がない場合、正常に動作しているかどうか判断できないので、サーバーから定期的にキープアライブパケットを送信することでAPIの応答がない状態であってもキープアライブタイムアウトの時間以内にパケットを受信しているかどうかの死活監視を行います。
設定を有効にするには、サーバー側のSVF実行部接続用ランタイムもキープアライブに対応している必要があります。「0」は無効(デフォルト)です。
Remote.HTTP.KeepAliveTimeout キープアライブタイムアウトの時間(秒)を設定します。設定を有効にするには、サーバー側のSVF実行部接続用ランタイムもキープアライブに対応している必要があります。デフォルトは「120」です。Remote.HTTP.KeepAliveIntervalで設定した値以上の秒数を設定してください。
Remote.HTTP.ConnectionTimeout 本オプションは、SVF Connect for .NET Framework APIでは無効です。
Remote.HTTP.RecvTimeout 各API呼び出し後の応答受信待ち時間のタイムアウト間隔(分)を設定します。 デフォルトは「120」です。
Remote.HTTP.SendTimeout 接続完了後、クライアントライブラリが送信可能状態になるまでの待ち時間(分)を設定します。デフォルトは「15」です。
Remote.HTTP.SSL SSL通信を使用するかどうかを指定します。
  • true
    SSL通信を使用する
  • false
    SSL通信を使用しない(デフォルト)
Remote.HTTP.Batch.Compress 一括転送時に分割するデータを圧縮するかどうかを指定します。
  • true
    データを圧縮する(デフォルト)
  • false
    データを圧縮しない
Remote.HTTP.Batch.DivideSize 一括転送時に分割するデータの分割サイズを指定します。デフォルトは「16k」です。
ErrorRecovery.HTTP.TargetErrorMode エラーリカバリモードを設定します。
  • 0
    リカバリなし(デフォルト)
  • 1
    ErrorRecovery.HTTP.TargetErrorListにリカバリ対象にするエラーを設定する
  • 2
    ErrorRecovery.HTTP.TargetErrorListにリカバリ対象にしないエラーを設定する
ErrorRecovery.HTTP.TargetErrorList エラーリカバリモードが「1」または「2」の場合に該当するエラー(「-30」など)を設定します。
ErrorRecovery.HTTP.TargetErrorModeに「1」または「2」を設定した場合、エラー「-4971」が発生すると、リストに設定していなくてもリトライします。
ErrorRecovery.HTTP.RetryCount エラーリカバリモードが「1」または「2」の場合にリカバリする回数を設定します。デフォルトは「3」です。