intra-mart Accel Platform 設定ファイルリファレンス 第31版 2022-12-01

ViewCreatorの設定

概要

ViewCreatorの動作設定を行います。

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

<?xml version='1.0' encoding='UTF-8' ?>
<viewcreator-config
    xmlns="http://jp/co/intra-mart/foundation/viewcreator"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://jp/co/intra-mart/foundation/viewcreator http://jp/co/intra-mart/foundation/viewcreator/viewcreator-config.xsd ">
  <system-parameters>
    <param>
      <param-name>USER_ID</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterUserId</class-name>
    </param>
    <param>
      <param-name>ENCODING</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterEncoding</class-name>
    </param>
    <param>
      <param-name>LOCALE</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterLocale</class-name>
    </param>
    <param>
      <param-name>SYSTEM_DATE</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </param>
    <param>
      <param-name>SYSTEM_DATE(yyyy/MM/dd)</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </param>
    <param>
      <param-name>SYSTEM_DATE(yyyy/MM/dd HH:mm)</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </param>
    <range-param>
      <param-name>SYSTEM_DATE</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </range-param>
    <range-param>
      <param-name>SYSTEM_DATE(yyyy/MM/dd)</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </range-param>
    <range-param>
      <param-name>SYSTEM_DATE(yyyy/MM/dd HH:mm)</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </range-param>
  </system-parameters>
  <data-source-list>
    <data-source>
      <id>files</id>
      <class-name>jp.co.intra_mart.foundation.viewcreator.expansion.impl.FileDataSource</class-name>
    </data-source>
  </data-source-list>
  <date-format-list>
    <date-format>yyyy/MM/dd HH:mm:ss</date-format>
    <date-format>yyyy/MM/dd HH:mm</date-format>
    <date-format>yyyy/MM/dd</date-format>
    <date-format>yyyy/MM</date-format>
  </date-format-list>
  <replacement-null-value> - </replacement-null-value>
  <graphbody-jssp-path>viewcreator/views/dataview/graph_body/chart_graph</graphbody-jssp-path>
  <report-settings>
    <report-creator-class-name></report-creator-class-name>
    <report-create-command>COMMAND_NAME %INPUT_PATH% %OUTPUT_PATH%</report-create-command>
    <file-suffix>pdf</file-suffix>
  </report-settings>
  <!-- リスト・サマリ集計のファイル出力(エクスポート)に関する設定 -->
  <export-data-settings>
    <!-- 出力するときにzip圧縮選択のダイアログを表示するかどうか true:表示する false:表示しない -->
    <show-confirm-zip>true</show-confirm-zip>
  </export-data-settings>
  <use-old-query-edit-screen>false</use-old-query-edit-screen>
  <dataview-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </dataview-list-settings>
  <query-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </query-list-settings>
  <applicable-dsp-time-zone>Asia/Tokyo</applicable-dsp-time-zone>
  <applicable-csv-time-zone>UTC</applicable-csv-time-zone>
  <search-settings>
    <option-item-max-number>500</option-item-max-number>
  </search-settings>
  <invalid-binary-type>false</invalid-binary-type>
  <cross-dataview-settings>
    <fetch-size>1000</fetch-size>
    <max-col-length>100</max-col-length>
    <max-row-length>100</max-row-length>
    <max-col-column-length>5</max-col-column-length>
    <max-row-column-length>5</max-row-column-length>
    <max-val-column-length>2</max-val-column-length>
  </cross-dataview-settings>
</viewcreator-config>

リファレンス

システムパラメータ設定

タグ名 system-parameters
動的に抽出条件値を生成するためのクラスを登録します。
paramタグには文字列検索用のパラメータクラスを登録します。
range-paramタグには数値や日付などの大小比較用のパラメータクラスを登録します。

【設定項目】

<viewcreator-config>
  <system-parameters>
    <param>
      <param-name>USER_ID</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterUserId</class-name>
    </param>
    <range-param>
      <param-name>SYSTEM_DATE(yyyy/MM/dd HH:mm)</param-name>
      <class-name>jp.co.intra_mart.foundation.viewcreator.params.SystemParameterSystemDate</class-name>
    </range-param>
  </system-parameters>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容
param-name 動的パラメータのID
class-name 動的パラメータ値を生成するSystemParameterインタフェースの実装クラス
単位・型 文字列
省略時のデフォルト値 なし
親タグ viewcreator-config

日付フォーマットリスト設定

タグ名 date-format-list
日付型やタイムスタンプ型のフィールドに対して設定された、文字列形式の入力値を
java.util.Date型に変換するためのフォーマット文字列を登録します。

【設定項目】

<viewcreator-config>
  <date-format-list>
    <date-format>yyyy/MM/dd HH:mm:ss</date-format>
    <date-format>yyyy/MM/dd HH:mm</date-format>
    <date-format>yyyy/MM/dd</date-format>
    <date-format>yyyy/MM</date-format>
  </date-format-list>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

日付フォーマット設定

タグ名 date-format
日付型やタイムスタンプ型のフィールドに対して設定された、文字列形式の入力値を
java.util.Date型に変換するためのフォーマット文字列を登録します。

【設定項目】

<viewcreator-config>
  <date-format-list>
    <date-format>yyyy/MM/dd HH:mm:ss</date-format>
    <date-format>yyyy/MM/dd HH:mm</date-format>
    <date-format>yyyy/MM/dd</date-format>
    <date-format>yyyy/MM</date-format>
  </date-format-list>
</viewcreator-config>

必須項目 ×
複数設定
設定値・設定する内容 日付フォーマット文字列
単位・型 文字列
省略時のデフォルト値 DateTimeFormatterクラスから取得されるフォーマット文字列のみが適用されます
親タグ date-format-list

外部データソースリスト設定

タグ名 data-source-list
ViewCreator上で様々なデータを扱うためのデータソース設定です。
VCDataSourceインタフェースの実装クラスを登録します。

【設定項目】

<viewcreator-config>
  <data-source-list>
    <data-source>
      <id>files</id>
      <class-name>jp.co.intra_mart.foundation.viewcreator.expansion.impl.FileDataSource</class-name>
    </data-source>
  </data-source-list>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

外部データソース設定

タグ名 data-source
ViewCreator上で様々なデータを扱うためのデータソース設定です。
VCDataSourceインタフェースの実装クラスを登録します。

【設定項目】

<viewcreator-config>
  <data-source-list>
    <data-source>
      <id>files</id>
      <class-name>jp.co.intra_mart.foundation.viewcreator.expansion.impl.FileDataSource</class-name>
    </data-source>
  </data-source-list>
</viewcreator-config>

必須項目 ×
複数設定
設定値・設定する内容
id 接続ID
class-name VCDataSourceインタフェースの実装クラス
単位・型 文字列
省略時のデフォルト値 なし
親タグ data-source-list

null値に対する代替表示文字列の設定

タグ名 replacement-null-value
リスト集計およびサマリ集計でレコードのデータがnullの場合に、画面上で表示する代替文字列です。

【設定項目】

<viewcreator-config>
  <replacement-null-value> - </replacement-null-value>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 null値の代わりに表示する文字列
単位・型 文字列
省略時のデフォルト値 ハイフン
親タグ viewcreator-config

グラフ描画用プログラムパス

タグ名 graphbody-jssp-path
グラフ集計でグラフ描画を行うスクリプト開発のプログラムパスを設定します。

注意

2016 Summer(Nirvana)より、本タグは使用不可となりました。

【設定項目】

<viewcreator-config>
  <graphbody-jssp-path>viewcreator/views/dataview/graph_body/chart_graph</graphbody-jssp-path>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 スクリプト開発のプログラムパス
単位・型 文字列
省略時のデフォルト値 viewcreator/views/dataview/graph_body/chart_graph
親タグ viewcreator-config

帳票出力設定

タグ名 report-settings
データ参照を帳票として出力するためのコマンドやクラスを設定します。
report-creator-class-nameタグは、帳票変換を行うjp.co.intra_mart.foundation.viewcreator.report.ReportFileConvertorインタフェースを実装したクラス名を設定します。
report-create-commandタグは、HTMLを帳票ファイルへの変換処理を行うための、実行可能なコマンドを設定します。

※report-create-commandとreport-creator-class-nameはどちらか1つだけ設定してください

file-suffixタグは、帳票ファイルの拡張子を設定します。

【設定項目】

<viewcreator-config>
   <report-settings>
      <report-creator-class-name></report-creator-class-name>
      <report-create-command>COMMAND_NAME %INPUT_PATH% %OUTPUT_PATH%</report-create-command>
      <file-suffix>pdf</file-suffix>
   </report-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
report-creator-class-name 帳票変換用実装クラスの名前
report-create-command 帳票変換コマンド
file-suffix 出力される帳票の拡張子
単位・型 文字列
省略時のデフォルト値 なし
親タグ viewcreator-config

ファイル出力に関する設定・ZIP圧縮選択ダイアログの表示

タグ名 show-confirm-zip
リスト集計、サマリ集計表示において、CSV出力を実行したときにZIP圧縮選択ダイアログを表示するかどうかを設定します。

【設定項目】

<viewcreator-config>
  <export-data-settings>
    <show-confirm-zip>true</show-confirm-zip>
  </export-data-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
true: CSV出力時にZIP圧縮選択ダイアログを表示します。
false:CSV出力時にZIP圧縮ダイアログの表示を行いません。
単位・型 真偽値
省略時のデフォルト値 true
親タグ export-data-settings

クエリ編集画面設定

タグ名 use-old-query-edit-screen
Flash版の画面を利用するか、HTML版の画面を利用するかを設定します。

【設定項目】

<viewcreator-config>
  <use-old-query-edit-screen>false</use-old-query-edit-screen>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
true: クエリ一覧からクエリ編集の画面を開く際に、Flash版の画面を表示します。
false:クエリ一覧からクエリ編集の画面を開く際に、HTML版の画面を表示します。
単位・型 真偽値
省略時のデフォルト値 false
親タグ viewcreator-config

コラム

URLを直接入力することで、任意の画面に遷移することも可能です。
・ HTML版
{コンテキストパス}/viewcreator/query/new
{コンテキストパス}/viewcreator/query/edit/{任意のクエリコード}
・ Flash版
{コンテキストパス}/viewcreator/query_edit?query_cd=
{コンテキストパス}/viewcreator/query_edit?query_cd={任意のクエリコード}

データ参照一覧のリスト設定

タグ名 dataview-list-settings
データ参照一覧に表示するリストを設定します。
【設定項目】
<viewcreator-config>
  <dataview-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </dataview-list-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

データ参照一覧の行番号リスト設定

タグ名 row-number-list
データ参照一覧の1ページに表示できる件数のリストを設定します。
【設定項目】
<viewcreator-config>
  <dataview-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </dataview-list-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ dataview-list-settings

データ参照一覧の行番号設定

タグ名 row-number
データ参照一覧の1ページに表示できる件数を設定します。
【設定項目】
<viewcreator-config>
  <dataview-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </dataview-list-settings>
</viewcreator-config>

必須項目 ×
複数設定
設定値・設定する内容 1ページに表示できる件数
単位・型 数値型 (1 - )
省略時のデフォルト値
10,20,50が設定されて、初期表示件数は50が設定されます。
親タグ row-number-list

【属性】

属性名 説明 必須 デフォルト値
default trueの場合、設定されている値が初期表示件数として設定されます。 × false

コラム

row-numberの設定の順番に関わらず、表示切替セレクトボックスの表示の順番は小さい順です。

注意

default=”true”のrow-numberが複数ある場合、default=”true”が設定されているrow-numberの中で一番小さい値が初期表示件数として設定されます。
default=”true”のrow-numberが見つからない場合は、row-numberの中で一番小さい値が初期表示件数として設定されます。

クエリ一覧のリスト設定

タグ名 query-list-settings
クエリ一覧の設定をします。
【設定項目】
<viewcreator-config>
  <query-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </query-list-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

クエリ一覧の行番号リスト設定

タグ名 row-number-list
クエリ一覧の表示する行数リストを登録します。
【設定項目】
<viewcreator-config>
  <query-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </query-list-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ query-list-settings

クエリ一覧の行番号設定

タグ名 row-number
データ参照一覧の1ページに表示できる件数を設定します。
【設定項目】
<viewcreator-config>
  <query-list-settings>
    <row-number-list>
      <row-number>10</row-number>
      <row-number>20</row-number>
      <row-number default="true">50</row-number>
    </row-number-list>
  </query-list-settings>
</viewcreator-config>

必須項目 ×
複数設定
設定値・設定する内容 1ページに表示できる件数
単位・型 数値型 (1 - )
省略時のデフォルト値
10,20,50が設定されて、初期表示件数は50が設定されます。
親タグ row-number-list

【属性】

属性名 説明 必須 デフォルト値
default trueの場合、設定されている値が初期表示件数として設定されます。 × false

コラム

row-numberの設定の順番に関わらず、表示切替セレクトボックスの表示の順番は小さい順です。

注意

default=”true”のrow-numberが複数ある場合、default=”true”が設定されているrow-numberの中で一番小さい値が初期表示件数として設定されます。
default=”true”のrow-numberが見つからない場合は、row-numberの中で一番小さい値が初期表示件数として設定されます。

画面表示のタイムゾーン設定

タグ名 applicable-dsp-time-zone
データ参照一覧の画面表示に使用するタイムゾーンを設定します。
【設定項目】
<viewcreator-config>
  <applicable-dsp-time-zone>Asia/Tokyo</applicable-dsp-time-zone>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 タイムゾーンマスタ設定ファイルで定義されているタイムゾーンIDまたは”user”(ログインユーザのタイムゾーンを使用する場合)
単位・型 文字列
省略時のデフォルト値
なし
親タグ viewcreator-config

CSV出力のタイムゾーン設定

タグ名 applicable-csv-time-zone
データ参照一覧のCSV出力に使用するタイムゾーンを設定します。
【設定項目】
<viewcreator-config>
  <applicable-csv-time-zone>UTC</applicable-csv-time-zone>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 タイムゾーンマスタ設定ファイルで定義されているタイムゾーンIDまたは”user”(ログインユーザのタイムゾーンを使用する場合)
単位・型 文字列
省略時のデフォルト値
なし
親タグ viewcreator-config

検索設定

タグ名 search-settings
データ参照の検索に関連する設定をします。
【設定項目】
<viewcreator-config>
  <search-settings>
    <option-item-max-number>500</option-item-max-number>
  </search-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

選択肢一覧の最大表示件数設定

タグ名 option-item-max-number
「検索条件値・選択肢リスト」で「データ参照を利用」を選択したときに、該当データ参照から取得する最大レコード数を設定します。
【設定項目】
<viewcreator-config>
  <search-settings>
    <option-item-max-number>500</option-item-max-number>
  </search-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 データ参照から取得する最大レコード数(0の場合は無制限で取得します)
単位・型 数値型 (0 - )
省略時のデフォルト値 500
親タグ search-settings

コラム

以下のどちらかに該当する場合、option-item-max-number で指定された件数のレコードを取得した後、重複項目の除外を行います。

  • 「表示値」または「送信値」で指定されたカラムが計算式カラムである場合
  • 外部データソースのクエリを利用したデータ参照である場合

そのため、選択肢として表示される項目数と option-item-max-number で指定された件数が一致しない場合があります。

バイナリ型カラムの利用

タグ名 invalid-binary-type
バイナリ型カラムの利用が無効かどうかを設定します。
【設定項目】
<viewcreator-config>
  <invalid-binary-type>false</invalid-binary-type>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
true: バイナリ型のカラムからデータ取得を行いません。
false:バイナリ型のカラムからデータ取得を行います。
単位・型 真偽値
省略時のデフォルト値 false
親タグ viewcreator-config

クロス集計設定

タグ名 cross-dataview-settings
データ参照のクロス集計に関連する設定をします。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <fetch-size>1000</fetch-size>
    <max-col-length>100</max-col-length>
    <max-row-length>100</max-row-length>
    <max-col-column-length>5</max-col-column-length>
    <max-row-column-length>5</max-row-column-length>
    <max-val-column-length>2</max-val-column-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ viewcreator-config

クロス集計のフェッチサイズ

タグ名 fetch-size
クロス集計用のデータ取得時に適用されるフェッチサイズ(1度のフェッチで取得するレコード数)の参考値を設定します。
設定値を大きくするとデータベースサーバとの通信回数が減少し、パフォーマンスの向上が期待できますがメモリの使用量が大きくなります。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <fetch-size>1000</fetch-size>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計用のデータ取得時に適用されるフェッチサイズの参考値。
単位・型 数値型 (0 - )
省略時のデフォルト値 1000
親タグ cross-dataview-settings

コラム

「クロス集計のフェッチサイズ」は、データベースを利用するクエリの場合のみ適用されます。

クロス集計表の最大縦列数

タグ名 max-col-length
クロス集計表の縦列数の最大値を設定します。
設定値よりも多い列数となるクロス集計表の生成が行われようとした場合、エラーとして処理されます。
設定値を大きくすると大きな列数となるクロス集計表を生成できますが、メモリの使用量も大きくなります。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <max-col-length>100</max-col-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計表の最大縦列数
単位・型 数値型 (0 - )
省略時のデフォルト値 100
親タグ cross-dataview-settings

クロス集計表の最大横列数

タグ名 max-row-length
クロス集計表の横列数(行数)の最大値を設定します。
設定値よりも多い行数となるクロス集計表の生成が行われようとした場合、エラーとして処理されます。
設定値を大きくすると大きな行数となるクロス集計表を生成できますが、メモリの使用量も大きくなります。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <max-row-length>100</max-row-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計表の最大横列数
単位・型 数値型 (0 - )
省略時のデフォルト値 100
親タグ cross-dataview-settings

クロス集計の列カラム最大数

タグ名 max-col-column-length
クロス集計の「列見出し」に設定可能な最大カラム数を設定します。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <max-col-column-length>5</max-col-column-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計の列カラム最大数
単位・型 数値型 (0 - )
省略時のデフォルト値 5
親タグ cross-dataview-settings

クロス集計の行カラム最大数

タグ名 max-row-column-length
クロス集計の「行見出し」に設定可能な最大カラム数を設定します。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <max-row-column-length>5</max-row-column-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計の行カラム最大数
単位・型 数値型 (0 - )
省略時のデフォルト値 5
親タグ cross-dataview-settings

クロス集計の値カラム最大数

タグ名 max-val-column-length
クロス集計の「値」に設定可能な最大カラム数を設定します。
【設定項目】
<viewcreator-config>
  <cross-dataview-settings>
    <max-val-column-length>2</max-val-column-length>
  </cross-dataview-settings>
</viewcreator-config>

必須項目
複数設定 ×
設定値・設定する内容 クロス集計の値カラム最大数
単位・型 数値型 (0 - )
省略時のデフォルト値 2
親タグ cross-dataview-settings