updateConfigFile

指定したファイルで、ローカルPC上のSDPClientServiceの動作設定を更新します。

構文

sdp.updateConfigFile(configFile)

引数

引数 必須 説明
configFile 更新する設定内容が記載されたXML形式の設定ファイルを指定します。
指定する設定ファイルの詳細については「設定ファイルのフォーマット」を参照してください。

設定ファイルのフォーマット

設定ファイルは以下の形式で作成する必要があります。

  • 設定ファイルは、XML形式で記述します。
  • 設定ファイルのファイル名は任意です。
  • 設定ファイルは、UTF-8(BOMなし)で作成する必要があります。
  • 設定ファイルには、設定を変更する項目のみ記述します。記述のない項目は変更されません。

設定項目と指定値

設定ファイルに記述できる設定項目と指定値は以下のとおりです。動作設定の各項目の詳細については「4-2 SDPClientServiceの動作設定」を参照してください。

セクション キー 対応する設定内容と指定値
System PortNo

SDPClientServiceがJavaScript APIと通信するためのポート番号を指定します。「1」から「65535」の範囲で指定します。インストール時の初期値は「44580」です。

注意

ポート番号の変更を反映するには、SDPClientServiceの再起動が必要です。

SSLPortNo

SDPClientServiceがJavaScript APIとSSL通信するためのポート番号を指定します。「1」から「65535」の範囲で指定します。インストール時の初期値は「44543」です。

注意

ポート番号の変更を反映するには、SDPClientServiceの再起動が必要です。

DefaultEmfTrayMode トレイ制御モードを指定します。トレイ制御モードについては「トレイ制御モード」を参照してください。
  • 0(インストール時の初期値)
    既定トレイ指定。
  • 1
    ドライバー取得順指定。
  • 2
    トレイマップ指定。
CacheMode プレビュー表示時、プレビューデータを保持する方法を指定します。
  • 1(インストール時の初期値)
    メモリにキャッシュ。
  • 2
    ファイルにキャッシュ。
    プレビューデータが大きく、メモリ上にキャッシュしきれない場合などにファイルにキャッシュします。
CacheTime プレビューデータのキャッシュ時間を秒単位で指定します。「0」から「43200」の範囲で指定します。インストール時の初期値は1800秒です。
Resolution プレビュー画像の解像度をdpi単位で指定します。「1」から「2000」の範囲で指定します。インストール時の初期値は150dpiです。
Debug LogFolder ログファイルの出力先フォルダーを指定します。インストール時の初期値はありません。指定がない場合は、SVF Web Direct Printのインストールフォルダーに出力されます。
LogLevel ログを出力するか、する場合はログレベルを指定します。
  • NONE(インストール時の初期値)
    ログを出力しません。
  • WARN
    警告
  • INFO
    情報
  • DEBUG
    デバッグ
LogSaveDay ログファイルの保存日数を「0」から「100」の範囲で指定します。インストール時の初期値は7日です。

 

設定ファイルの記述例

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<SvfWebDirectPrintIni>
  <sections>
    <section name="System">
      <item
        key="PortNo"
        value="44581"
      />
      <item
        key="SSLPortNo"
        value="44544"
      />
      <item
        key="DefaultEmfTrayMode"
        value="2"
      />
      <item
        key="CacheMode"
        value="2"
      />
      <item
        key="CacheTime"
        value="3600"
      />
      <item
        key="Resolution"
        value="300"
      />
    </section>
    <section name="Debug">
      <item
        key="LogFolder"
        value="C:\Temp\Log"
      />
      <item
        key="LogLevel"
        value="WARN"
      />
      <item
        key="LogSaveDay"
        value="3"
      />
    </section>
  </sections>
</SvfWebDirectPrintIni>

戻り値

Promiseオブジェクトが返却されますので、処理結果による動作の制御に利用できます。
また、JavaScript APIがPromise経由でステータスコードを返すので、ステータスコードを利用した動作の制御も可能です。ステータスコードの使い方については「print」の「指定例」を参照してください。

 

ステータスコード 内容
-401 設定ファイルの更新失敗

 

指定例

SDPClientServiceの動作設定を「http://localhost:8080/config.xml」で更新します。
また、更新が成功した場合は警告ダイアログに「update success」を出力し、失敗した場合は「update error」を出力します。

var sdp = new SDP();
var promise = sdp.updateConfigFile('http://localhost:8080/config.xml');
promise.then(function(){
    window.alert('update success'); //更新成功時の処理
}).catch(function(){
    window.alert('update error'); //更新失敗時の処理
})