intra-mart Accel Platform 設定ファイルリファレンス 第34版 2024-04-01

IM-FileExchangeの設定

概要

IM-FileExchangeの動作設定を行います。

モジュール IM-FileExchange
フォーマットファイル(xsd) WEB-INF/schema/file-exchange-config.xsd
設定場所 WEB-INF/conf/file-exchange-config/file-exchange-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<file-exchange-config
    xmlns="http://intra-mart.co.jp/system/file_exchange/config/file-exchange-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/system/file_exchange/config/file-exchange-config ../../schema/file-exchange-config.xsd ">
  <bind-width>0</bind-width>
  <direct-download>false</direct-download>
  <max-number-of-upload-files>10</max-number-of-upload-files>
  <virus-scan-settings enable="false">
    <scan-command></scan-command>
  </virus-scan-settings>
  <upload-listeners>
    <listener id="mail" enable="true" path="file_exchange/common/notice/mail_upload_listener" />
  </upload-listeners>
  <download-listeners>
    <listener id="log" enable="true" path="file_exchange/common/notice/log_download_listener" />
  </download-listeners>
</file-exchange-config>

リファレンス

帯域幅の設定

タグ名 bind-width
ファイルダウンロード時の通信量を指定します。
0が指定されている場合、通信量を制限しません。

【設定項目】

<file-exchange-config>
  <bind-width>0</bind-width>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 ファイルダウンロード時の通信量を設定します。
単位・型 数値[Mbps] (0 - )
省略時のデフォルト値 0
親タグ file-exchange-config

直接ファイルダウンロードの設定

タグ名 direct-download
ダウンロードURLアクセス時にファイルを直接ダウンロードするかを設定します。

【設定項目】

<file-exchange-config>
  <direct-download>false</direct-download>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
true: 直接ダウンロードを行います。
false:「ファイルダウンロード」画面を表示します。
単位・型 真偽値
省略時のデフォルト値 false
親タグ file-exchange-config

コラム

直接ダウンロードする場合、アップロードされたファイル数によって動作が異なります。
アップロードされたファイルが複数の場合、全てのファイルを zip 形式でダウンロードします。
アップロードされたファイルが単体の場合、アップロードされたファイルをそのままダウンロードします。
本設定は 2022 Spring(Eustoma) から利用可能です。

アップロード可能なファイル数の設定

タグ名 max-number-of-upload-files
1度にアップロード可能なファイル数を設定します。

【設定項目】

<file-exchange-config>
  <max-number-of-upload-files>10</max-number-of-upload-files>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
1度にアップロード可能なファイル数を設定します。
単位・型 数値型 (1 - )
省略時のデフォルト値 10
親タグ file-exchange-config

コラム

本設定は 2022 Spring(Eustoma) から利用可能です。

ウィルス検査実行に関する設定

タグ名 virus-scan-settings
ファイルアップロード時のウィルス検査実行に関する設定を行います。

【設定項目】

<file-exchange-config>
  <virus-scan-settings enable="false">
    <scan-command></scan-command>
  </virus-scan-settings>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
scan-command ウィルス検査実行コマンドの設定情報
単位・型 なし
省略時のデフォルト値 なし
親タグ file-exchange-config

【属性】

属性名 説明 必須 デフォルト値
enable
false ウィルス検査を無効にします。
true ウィルス検査を有効にします。
× false

コラム

本設定は 2022 Spring(Eustoma) から利用可能です。

ウィルス検査実行コマンドの設定

タグ名 scan-command
ファイルアップロード時のウィルス検査の実行コマンドを設定します。

【設定項目】

<virus-scan-settings enable="true">
  <scan-command>"C:\Program Files\XXX\scan.exe" -File ${target_path}</scan-command>
</virus-scan-settings>

必須項目
複数設定 ×
設定値・設定する内容
ウィルス検査を実行するコマンドを設定します。
コマンドの終了コードは以下の意味を持つ必要があります。
0 ウィルス検査が正常に終了し、脅威が検出されなかったことを意味します。
1 ウィルス検査が正常に終了し、何らかの脅威が検出されたことを意味します。
上記以外 ウィルス検査で何らかの問題が発生し、異常終了したことを意味します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ virus-scan-settings

コラム

<scan-command> では以下の変数を利用できます。

注意

コマンドを実行するユーザは、アプリケーションサーバサービスを起動したユーザです。
コマンドで実行されるプログラムに対して、上記ユーザの実行権限が付与されている必要があります。

コマンドは半角スペース区切りで認識されるため、ファイルパス等に半角スペースが含まれる場合、予期せぬ動作になる可能性があります。
コマンドの区切り以外に半角スペースが使用される可能性がある場合は、適宜エスケープ処理を行ってください。
※テンポラリストレージ配下のパス(上記例の「...」の箇所)には、半角スペースが含まれることはありません。

アップロード通知リスナの設定

タグ名 upload-listeners
ファイルのアップロードされたことを通知するリスナを設定します。

【設定項目】

<file-exchange-config>
  <upload-listeners>
    <listener id="mail" enable="true" path="file_exchange/common/notice/mail_upload_listener" />
  </upload-listeners>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
listener アップロード通知リスナの設定情報
単位・型 なし
省略時のデフォルト値 なし
親タグ file-exchange-config

アップロードリスナの設定

タグ名 listener
ファイルアップロード通知リスナの設定を行います。

【設定項目】

<upload-listeners>
  <listener id="mail" enable="true" path="file_exchange/common/notice/mail_upload_listener" />
</upload-listeners>

必須項目
複数設定
設定値・設定する内容
ファイルアップロード通知リスナの有効/無効やプログラムパスを設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ upload-listeners

【属性】

属性名 説明 必須 デフォルト値
id 通知リスナのIDを指定します。 なし
enable
false リスナを無効にします。
true リスナを有効にします。
なし
path リスナのプログラムパスを指定します。 なし

ダウンロード通知リスナの設定

タグ名 download-listeners
ファイルがダウンロードされたことを通知するリスナを設定します。

【設定項目】

<file-exchange-config>
  <download-listeners>
    <listener id="log" enable="true" path="file_exchange/common/notice/log_download_listener" />
  </download-listeners>
</file-exchange-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
listener ダウンロード通知リスナの設定情報
単位・型 なし
省略時のデフォルト値 なし
親タグ file-exchange-config

ダウンロードリスナの設定

タグ名 listener
ファイルダウンロード通知リスナの設定を行います。

【設定項目】

<download-listeners>
  <listener id="log" enable="true" show-guest-address="false" path="file_exchange/common/notice/log_download_listener" />
</download-listeners>

必須項目
複数設定
設定値・設定する内容
ファイルダウンロード通知リスナの有効/無効やプログラムパスを設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ download-listeners

【属性】

属性名 説明 必須 デフォルト値
id 通知リスナのIDを指定します。 なし
enable
false リスナを無効にします。
true リスナを有効にします。
なし
path リスナのプログラムパスを指定します。 なし
show-guest-address
false ゲストユーザのアドレスを表示しない。
true ゲストユーザのアドレスを表示する。
× false