intra-mart Accel Platform ViewCreator 管理者操作ガイド 第21版 2019-08-01

4.11. リスト集計におけるCSV出力の設定

リスト集計のCSV出力機能は設定ファイルを編集することで、出力されるファイルの文字コードや改行コードなどを変更することが可能です。

4.11.1. 設定ファイルの配置場所


%PUBLIC_STORAGE_PATH%/products/viewcreator/list-dataview-export-option.xml

4.11.2. 設定項目


基本的にはTableMaintenanceのテーブル・エクスポート機能と同様の設定が可能です。

<export-option>
  <!-- DATE型、TIMESTAMP型データをテキストデータに変換するためのフォーマット -->
  <date-format>yyyy-MM-dd HH:mm:ss</date-format>
  <!-- 数値系データをテキストデータに変換するためのフォーマット -->
  <decimal-format>#</decimal-format>
  <!-- エクスポートファイルで利用する改行コード CR, LF, CRLFのいずれか -->
  <newline-code>CRLF</newline-code>
  <!-- エクスポートファイルのエンコーディング -->
  <encoding>MS932</encoding>
  <!-- バイナリ系のデータを別ファイルへエクスポートするかどうか -->
  <include-binary>false</include-binary>
  <!-- エクスポートしたファイルを常にzipで圧縮するかどうか -->
  <zip-file>true</zip-file>
  <!-- エクスポート時の最大出力レコード数 -->
  <max-row>0</max-row>
  <!-- エクスポート時にStatement, ResultSetに設定するフェッチサイズ -->
  <fetch-size>10</fetch-size>
  <!-- null値に対する置換文字列 -->
  <null-value/>
  <!-- 未使用 -->
  <output-footer>false</output-footer>
  <!-- ヘッダを出力するかどうか -->
  <output-header>true</output-header>
  <!-- 未使用 -->
  <sleep-record-count>0</sleep-record-count>
  <!-- 未使用 -->
  <sleep-time>0</sleep-time>
  <!-- 未使用 -->
  <start-index>0</start-index>
  <!-- zip圧縮時のファイル名 -->
  <zip-file-name/>
  <table>
    <table-name>vcexport_sql</table-name>
    <!-- 出力ファイル(CSVファイル)のファイル名。 [[ と ]] で囲われた文字列は計算式として解釈されます。 -->
    <dest-file-name>[[DATAVIEWCODE()]]_[[FORMAT("yyyyMMddHHmmss", TODAY())]]</dest-file-name>
  </table>
  <exporter>
    <exporter-name>vcexporter</exporter-name>
    <!--
      出力したデータをダブルコーテーションで囲うかどうか
      true: 文字列型のデータを常にダブルコーテーションで囲います
      false: データの中にエスケープが必要な文字が含まれる場合のみダブルコーテーションで囲います
     -->
    <param>
      <param-name>useDoubleQuotation4AllStringValues</param-name>
      <param-value>false</param-value>
    </param>
  </exporter>
</export-option>

date-format
日時データのデフォルトの出力フォーマットを設定します。
データ参照編集のカラム設定でフォーマット文字列が指定されていない場合のみ適用されます。
この設定はタイムスタンプ型または日付型のカラムに対してのみ有効です。
※画面上のフォーマット設定項目で指定された値が優先されます。
decimal-format
数値データのデフォルトの出力フォーマットを設定します。
データ参照編集のカラム設定でフォーマット文字列が指定されていない場合のみ適用されます。
この設定は数値型のカラムに対してのみ有効です。
※画面上のフォーマット設定項目で指定された値が優先されます。
newline-code レコード単位の改行文字を設定します。 CR, LF, CRLFのいずれかを設定します。
encoding 出力ファイルの文字エンコーディングセットを設定します。
include-binary
バイナリ系のデータを別ファイルへエクスポートするかを設定します。
zip-file
エクスポートしたファイルを常にzipで圧縮するかどうか。
※画面上のダイアログで指定された値が優先されます。
conf/viewcreator-config.xmlで、export-data-settings/show-confirm-zipの設定値がfalseのときに適用されます。
max-row 出力する最大レコード数を設定します。 0を設定した場合は、最大レコード数は無制限として扱われます。
fetch-size
StatementやResultSetに設定するフェッチサイズです。フェッチサイズの値を変更することによりパフォーマンスが向上することがあります。
レコード数が多い場合、フェッチサイズの値を何度か変更して実行し、最適になる値を決定してください。
null-value データがnull値のときに出力する文字列を設定します。
output-footer 未使用
output-header カラムヘッダを出力するかどうかを設定します。
sleep-record-count 未使用
sleep-time 未使用
start-index 出力を開始するレコード位置を設定します。
zip-file-name
zip圧縮された場合のzipファイル名(拡張子なし)を設定します。
省略時はシステムで自動生成された値が利用されます。
table/table-name vcexport_sqlで固定です。変更はできません。
table/dest-file-name
エクスポートファイルのファイル名(拡張子なし)を設定します。
[[ と ]] で囲われた文字列は計算式として解釈されます。
exporter/exporter-name vcexporterで固定です。変更はできません。
param/param-name/useDoubleQuotation4AllStringValues
文字列データをダブルコーテーションで常に囲うかどうかを設定します。
true: 文字列型のデータを常にダブルコーテーションで囲います。
false: データの中にエスケープが必要な文字が含まれる場合のみダブルコーテーションで囲います。
use-bom
BOMを付与するかどうかを設定します。
BOMは出力ファイルの文字エンコーディングセットがUTF-8の場合のみ利用可能です。
true: 出力ファイルにBOMを付与します。
false: 出力ファイルにBOMを付与しません。

コラム

dest-file-nameは2014 Winter(Iceberg)から利用可能です。
useDoubleQuotation4AllStringValuesは2014 Winter(Iceberg)から利用可能です。
fetch-sizeは2017 Winter(Rebecca)から利用可能です。

注意

use-bomは2016 Spring(Maxima)から利用可能です。
標準では設定ファイルに設定されておりませんので、必要に応じて設定ファイルを編集しご利用ください。

4.11.2.1. フォーマット適用の優先順について

数値型、日付型、タイムスタンプ型に対して適用されるフォーマットの優先順は以下の通りです。

  • 画面表示の場合
  1. データ参照編集画面で設定されているフォーマット
  2. 個人設定の日付と時刻の形式で設定されているパターン(日付型とタイムスタンプ型)
  • 「CSV出力」の場合
  1. データ参照編集画面で設定されているフォーマット
  2. 設定ファイルで指定されているフォーマット

4.11.3. viewcreator-config.xmlで設定可能な項目について

CSV出力に関する一部の設定はviewcreator-config.xmlで行います。

ファイルパス:
WEB-INF/conf/viewcreator-config.xml

4.11.3.1. 設定項目

export-data-settings/show-confirm-zip

出力するときにzip圧縮選択のダイアログを表示するかどうかを設定します。
true:表示する
false:表示しない

コラム

show-confirm-zipは2014 Winter(Iceberg)から利用可能です。