intra-mart Accel Kaiden! MasterBuilder 設定ガイド 第12版 2023-12-22

4.1. MasterBuilder定義

本項では、MasterBuilderの設定ファイル(以降、MasterBuilder定義)の作成方法を説明します。

4.1.1. 概要

4.1.1.1. MasterBuilder定義

MasterBuilder定義は、XML形式で次の設定を行います。
設定名 概要
基本設定 マスタの基本となる設定です。(ID、名称など)
項目設定 マスタの項目設定です。本設定を使用して各機能別設定の簡略化を実現しています。
拡張設定 マスタを拡張する場合の設定です。(設定だけでは実現できない場合などに使用します。)
サーフィス設定 マスタ名や項目名などの設定です。
マスタメンテナンス設定 マスタメンテナンス機能の個別設定です。
検索設定 検索部品・セレクトボックス機能の個別設定です。
インポート設定 インポート機能の個別設定です。
エクスポート設定 エクスポート機能の個別設定です。

コラム

MasterBuilder定義の全体イメージは「Sample」を参照してください。

4.1.1.2. MasterBuilder定義の配置先

MasterBuilder定義は次のパスに配置します。
「%ストレージパス%/kaiden/generic/master/%マスタID%.xml」

ストレージはシステムストレージ、パブリックストレージのどちらでも配置可能で、パブリックストレージが優先的に読み込まれます。
intra-mart Accel Kaiden!のMasterBuilder定義は、システムストレージに配置されます。
上記の読み込み順を使用して、独自のMasterBuilder定義を優先的に読み込ませることが可能です。
(テナント別にMasterBuilder定義を作成したい場合も、パブリックストレージを使用してください。)

また、マスタ拡張IDを使用することで、使用箇所別のカスタマイズも可能です。
マスタ拡張IDを使用する場合は、MasterBuilder定義ファイルの名称が「%マスタID%_%マスタ拡張ID%.xml」となる様に設定します。
例)経費区分マスタメンテナンスで使用する、勘定科目マスタ検索部品の検索結果に予備項目Aを追加
  • intra-mart Accel Kaiden!の勘定科目マスタ設定の配置先
    「%システムストレージパス%/kaiden/generic/master/account.xml」
  • カスタマイズの勘定科目マスタ設定の配置先(予備項目Aを表示するように設定変更)
    「%パブリックストレージパス%/kaiden/generic/master/account_exp_type.xml」

コラム

マスタIDとは、構築対象のマスタを一意に判定するためのIDです。
マスタ拡張IDとは、構築したマスタ機能の拡張を行う場合に使用するIDです。
詳細は、「マスタ拡張IDの利用」を参照してください。

4.1.1.3. マスタ特性

MasterBuilderでは、基本設定で設定するサービスクラスに関連するEntityに保持する項目を参照し、各マスタの特性を判断します。
判断した特性に合わせて、様々な処理を行います。
特性 判定方法 主な利用用途
会社化 Entityに会社コード(companyCd)が存在 会社認可判定、ジョブの処理単位
期間化 Entityに期間コード(termCd)が存在 期間一覧表示、期間処理(有効無効)
国際化 EntityにロケールID(localeId)が存在 ロケール分割

コラム

マスタの特性に応じて、設定が必須なカラムがあります。
詳細は、「テーブル定義」を参照してください。

4.1.2. 基本設定

基本設定では、MasterBuilder定義の基本となる値を設定します。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  <masterId>account</masterId>
  <surfaceKey>master_name</surfaceKey>
  <service>k30mAccountService</service>
  <resources>service://kaiden/master/account</resources>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • マスタID(genericMasterSettings / masterId):必須
    定義を行うマスタのIDを設定します。(MasterBuilder定義のファイル名と必ず同一の値を設定します。)
    未設定の場合、MasterBuilder定義読み込み時に読み込みエラーが発生します。
  • サーフィスキー(genericMasterSettings / surfaceKey):必須
    定義を行うマスタの名称(サーフィスキー)を設定します。(実際のサーフィスは、後述のサーフィス定義で設定します。)
    未設定の場合、MasterBuilder定義読み込み時に読み込みエラーが発生します。
  • サービスクラス(genericMasterSettings / service):任意
    定義を行うマスタのサービスクラス(コンポーネント名)を設定します。
    標準設定のまま各機能を使用する場合は設定必須です。(各機能の呼出し時にエラーが発生します。)

    コラム

    APIを使用した検索
    検索部品やセレクトボックス、バリデート機能のみを使用し、APIによる検索を行う場合はサービスクラスの設定は不要です。
    後述する拡張設定でLogicクラスを拡張し、APIを使用した検索処理を追加してください。
  • 認可リソース(genericMasterSettings / resources):任意
    定義を行うマスタの認可リソース(URL)を設定します。
    マスタメンテナンスの各処理時に使用しますので、マスタメンテナンス機能を使用しない場合は設定不要です。

    コラム

    認可判定
    MasterBuilderの認可判定は次の2段階で実行されます。
    1. 「MasterBuilder:service://kaiden/generic/master」に対する認可有無
    2. 設定された認可リソース(URL)に対する認可有無
    会社認可の判定は本設定の有無に限らず、マスタ特性が会社化のマスタ(Entityに「companyCd」を含む)の場合に実行されます。
    (表示等の処理の場合は参照権限、登録・更新・削除等の処理の場合は編集権限)

4.1.3. 項目設定

項目設定では、各マスタ関連機能で使用する項目定義を行います。
本項目に共通的に項目設定を行うことで、各機能設定では設定の簡略化を実現しています。

項目設定は、「genericMasterSettings / items / item」階層に設定を行います。
「genericMasterSettings / items / item」階層は、1件以上の複数設定が可能です。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <items>
    
    <!-- 略 -->
    
    <!-- 勘定科目コード -->
    <item name="accountCd" surfaceKey="account_code" type="TEXT_CODE" primary="true">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="100"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'kaidenId'}"/>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'100'}"/>
      </validates>
    </item>
    <!-- 勘定科目名 -->
    <item name="accountName" surfaceKey="account_name" type="TEXT_LOCALES">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    
    <!-- 略 -->
    
  </items>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • 項目名(genericMasterSettings / items / item @ name):必須
    定義を行う項目の項目名(HTMLのname属性値)を設定します。
    未設定の場合、MasterBuilder定義読み込み時に読み込みエラーが発生します。
  • サーフィスキー(genericMasterSettings / items / item @ surfaceKey):必須
    定義を行う項目の名称(サーフィスキー)を設定します。(実際のサーフィスは、後述のラベル定義で設定します。)
    未設定の場合、MasterBuilder定義読み込み時に読み込みエラーが発生します。
  • プライマリーキー(genericMasterSettings / items / item @ primary):任意
    定義を行う項目がプライマリーキーか否かを設定します。(true:プライマリーキー、false:非プライマリーキー)
  • エレメントタイプ(genericMasterSettings / items / item @ type):任意
    定義を行う項目のエレメントタイプを設定します。
    設定値に応じて、指定可能なエレメント引数が変わります。
    エレメントタイプと設定可能なエレメント属性は「指定可能なエレメントタイプと属性値」を参照してください。
  • エレメント属性(genericMasterSettings / items / item / args / arg):任意
    定義を行う項目のエレメントタイプに合わせた属性値を設定します。
  • エレメント属性キー(genericMasterSettings / items / item / args / arg @ key):必須
    属性値のキーとなる項目です。エレメント引数の値と合わせて設定します。
  • エレメント属性値(genericMasterSettings / items / item / args / arg @ value):任意
    属性値の値となる項目です。エレメント引数のキーと合わせて設定します。
  • バリデート設定(genericMasterSettings / items / item / validates / validate):任意
    定義を行う項目のバリデート方法を設定します。
  • バリデートタイプ(genericMasterSettings / items / item / validates / validate @ type):必須
    定義を行う項目のバリデート実行タイミングを設定します。
    設定可能なバリデートの種類は次の通りです。
    設定値 解説
    DEFAULT デフォルトバリデートです。登録、更新、インポートの各バリデート時に合わせて実行します。
    ENTRY メンテナンス機能で新規登録を行う際に実行されるバリデートです。
    RENEW メンテナンス機能で更新を行う際に実行されるバリデートです。
    DELETE メンテナンス機能で削除を行う際に実行されるバリデートです。
    IMPORT インポート時に実行されるバリデートです。
  • バリデート引数(genericMasterSettings / items / item / validates / validate @ args):必須
    定義を行う項目のバリデート引数をJSON形式で設定します。
    「type」にはバリデーションIDを設定します。
    「args」にはバリデーションの引数を設定します。(MasterBuilderバリデーションの場合のみMap形式となる様に設定します。)
    設定可能なバリデートは、『intra-mart Accel Kaiden! GadgetBuilder 設定ガイド』-「リファレンス」-「バリデート処理」を参照してください。

    例)必須チェック
    <validate type="DEFAULT" args="{'type':'required'}"/>
    
    例)最大文字数
    <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
    
    例)勘定科目マスタチェック(MasterBuilderバリデーション)
    <validate type="DEFAULT" args="{'type':'masterBuilderExists', 'args':{'masterId':'tax_type', 'extensionId':'exp_type', 'searchCriteriaCompany':'searchCriteriaCompany', 'searchCriteriaDate':'searchCriteriaDate', 'taxTypeCd':'taxTypeCd', 'includeDisabled':'true'}}"/>
    
  • コンバート設定(genericMasterSettings / items / item / convert):任意
    画面とロジックの間で行う値のコンバート形式を設定します。
    コンバート内容の詳細は「項目値のコンバート」を参照してください。
  • HTMLコンバート(genericMasterSettings / items / item / convert @ display):必須
    Javaのロジックで取得した値(DBから取得した値)から画面で使用するための値にコンバートする方法を設定します。
  • Javaコンバート(genericMasterSettings / items / item / convert @ process):必須
    画面からのリクエストデータをJavaのロジックで使用するための値(DB登録・更新するための値)にコンバートする方法を設定します。

4.1.4. 拡張設定

拡張設定では、MasterBuilderの標準機能を拡張(カスタマイズ)する場合の拡張先の設定を行います。
拡張(カスタマイズ)を行わない場合は設定不要です。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <extension>
    <logic>jp.co.slcs.kaiden.v2.base.feature.logic.kaiden.generic.LimitationMasterSearchLogic</logic>
  </extension>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • Logicクラス(genericMasterSettings / extension / logic):任意
    拡張用のLogicクラスを設定します。
    未設定の場合は「jp.co.slcs.kaiden.v2.base.feature.logic.kaiden.generic.MasterLogic」を使用します。
    マスタ検索、バリデーションのみを使用する場合は、次のLogicクラスを設定します。
    「jp.co.slcs.kaiden.v2.base.feature.logic.kaiden.generic.LimitationMasterSearchLogic」
    指定できる拡張用クラスについて「マスタ検索、バリデーションのみを使用するマスタの作成」を併せて参照してください。
  • Managerクラス(genericMasterSettings / extension / manager):任意
    拡張用のManagerクラスのコンポーネント名を設定します。
    未設定の場合は「masterManager」のコンポーネントを使用します。
  • Converterクラス(genericMasterSettings / extension / converter):任意
    拡張用のConverterクラスを設定します。
    未設定の場合はConverterクラスを使用しません。
    Converterクラスを作成する際は、以下クラスを継承してください。
    「jp.co.slcs.kaiden.v2.base.feature.logic.kaiden.generic.converter.AbstractMasterConverter」
  • 一覧検索用SQL(genericMasterSettings / extension / searchSql):任意
    拡張用の一覧検索用SQLパスを設定します。(マスタメンテナンスの一覧検索で使用するSQL)
    未設定の場合は「META-INF/sql/jp/co/slcs/kaiden/v2/generic/master/%マスタID%.sql」を使用します。
  • 対象検索用SQL(genericMasterSettings / extension / selectSql):任意
    拡張用の対象検索用SQLパスを設定します。(マスタメンテナンスの更新対象検索で使用するSQL)
    未設定の場合は「META-INF/sql/jp/co/slcs/kaiden/v2/generic/master/%マスタID%.sql」を使用します。
  • 期間検索用SQL(genericMasterSettings / extension / termSql):任意
    拡張用の期間検索用SQLパスを設定します。(マスタメンテナンスの期間検索で使用するSQL)
    未設定の場合は「META-INF/sql/jp/co/slcs/kaiden/v2/generic/master/%マスタID%.sql」を使用します。
  • マスタ検索用SQL(genericMasterSettings / extension / masterSql):任意
    拡張用のマスタ検索用SQLパスを設定します。(マスタ検索で使用するSQL)
    未設定の場合は「META-INF/sql/jp/co/slcs/kaiden/v2/generic/master/%マスタID%.sql」を使用します。
  • エクスポート用SQL(genericMasterSettings / extension / exportSql):任意
    拡張用のエクスポート用SQLパスを設定します。(エクスポートの対象抽出で使用するSQL)
    未設定の場合は「META-INF/sql/jp/co/slcs/kaiden/v2/generic/master/%マスタID%.sql」を使用します。
  • マスタメンテナンス画面のJSPパス(genericMasterSettings / extension / mainteJsp):任意
    拡張用のマスタメンテナンス画面のJSPパスを設定します。(マスタメンテナンス画面のメインJSP)
    未設定の場合は「/kaiden/v2/base/generic/master/maintenance.jsp」を使用します。
  • マスタメンテナンス画面(検索部品)のJSPパス(genericMasterSettings / extension / mainteSearchJsp):任意
    拡張用のマスタメンテナンス画面(検索部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceSearch.jsp」を使用します。
  • マスタメンテナンス画面(一覧部品)のJSPパス(genericMasterSettings / extension / mainteListJsp):任意
    拡張用のマスタメンテナンス画面(一覧部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceList.jsp」を使用します。
  • マスタメンテナンス画面(期間部品)のJSPパス(genericMasterSettings / extension / mainteTermJsp):任意
    拡張用のマスタメンテナンス画面(期間部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceTerm.jsp」を使用します。
  • マスタメンテナンス画面(編集部品)のJSPパス(genericMasterSettings / extension / mainteEditJsp):任意
    拡張用のマスタメンテナンス画面(編集部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceEdit.jsp」を使用します。
  • マスタメンテナンス画面(ボタン部品)のJSPパス(genericMasterSettings / extension / mainteButtonJsp):任意
    拡張用のマスタメンテナンス画面(ボタン部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceButton.jsp」を使用します。
  • マスタメンテナンス画面(拡張部品)のJSPパス(genericMasterSettings / extension / mainteExtensionJsp):任意
    拡張用のマスタメンテナンス画面(拡張部品)のJSPパスを設定します。(メインJSPでインクルードして使用します。)
    未設定の場合は「/WEB-INF/views/kaiden/v2/base/generic/master/maintenanceExtension.jsp」を使用します。
  • マスタメンテナンス用の処理URL(genericMasterSettings / extension / mainteUrl):任意
    拡張用のマスタメンテナンス画面からのAjaxパスを設定します。
    未設定の場合は「kaiden/v2/generic/master」を使用します。
  • 検索用の処理URL(genericMasterSettings / extension / searchUrl):任意
    拡張用の検索機能からのAjaxパスを設定します。
    未設定の場合は「kaiden/v2/generic/master/masterSearch」を使用します。
  • 検索結果画面のJSPパス(genericMasterSettings / extension / searchJsp):任意
    拡張用の検索結果画面のJSPパスを設定します。
    未設定の場合は「/kaiden/v2/base/foundation/master_search/genericMasterSearch.jsp」を使用します。
  • セレクトボックス用の処理URL(genericMasterSettings / extension / selectUrl):任意
    拡張用のセレクトボックス機能からのAjaxパスを設定します。
    未設定の場合は「kaiden/v2/generic/master/masterSelect」を使用します。

4.1.5. サーフィス設定

サーフィス設定では、画面やメッセージなどに使用するサーフィスの設定を行います。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <surfaces>
    
    <!-- 略 -->
    
    <surface surfaceKey="account_code" surface="Account Code" >
      <name localeId="ja"      surface="勘定科目コード" />
      <name localeId="en"      surface="Account Code" />
      <name localeId="zh_CN"   surface="帐户科目代码" />
    </surface>
    <surface surfaceKey="account_name" surface="Account Name" >
      <name localeId="ja"      surface="勘定科目名" />
      <name localeId="en"      surface="Account Name" />
      <name localeId="zh_CN"   surface="帐户科目名" />
    </surface>
    
    <!-- 略 -->
    
  </surfaces>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • サーフィスキー(genericMasterSettings / surfaces / surface @ surfaceKey)::必須
    サーフィスキーを設定します。
  • サーフィス(genericMasterSettings / surfaces / surface @ surface):必須
    デフォルトのサーフィスを設定します。(後述の言語設定に対象のロケールが存在しない場合に使用します。)
  • 言語設定(genericMasterSettings / surfaces / surface / name):任意
    各言語(ロケール)に合わせた設定を行います。
  • 言語設定・ロケール(genericMasterSettings / surfaces / surface / name @ localeId):必須
    言語設定を行うロケールを設定します。
  • 言語設定・サーフィス(genericMasterSettings / surfaces / surface / name @ surface):必須
    各言語(ロケール)に合わせたサーフィスを設定します。

4.1.6. メンテナンス設定

メンテナンス設定ではマスタメンテナンス機能で使用する項目の設定を行います。
マスタメンテナンス機能を使用しない場合は設定不要です。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <mainte>
    <listItems>
      <item name="accountCd" width="250px"/>
      <item name="accountName"/>
    </listItems>
    <editItems>
      <item name="accountCd"/>
      <item name="accountName"/>
    </editItems>
  </mainte>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • メンテナンス(一覧)項目設定(genericMasterSettings / mainte / listItems / item):任意
    一覧画面の項目を設定します。
  • メンテナンス(一覧)項目設定・項目名(genericMasterSettings / mainte / listItems / item @ name):必須
    一覧画面に表示する項目名(項目設定で設定した項目名)を設定します。
  • メンテナンス(一覧)項目設定・表示幅(genericMasterSettings / mainte / listItems / item @ width):任意
    一覧画面に表示した際の表示幅を設定します。
    未設定の場合は、表示幅の指定を行いません。
  • メンテナンス(一覧)項目設定・表示位置(genericMasterSettings / mainte / listItems / item @ align):任意
    一覧画面に表示した際の表示位置(left,center,right)を設定します。
    未設定の場合は、左寄せ(left)を設定します。
  • メンテナンス(一覧)項目設定・ソート有無(genericMasterSettings / mainte / listItems / item @ sort):任意
    一覧画面でのソート有無(true,false)を設定します。
    未設定の場合は、ソート有(true)を設定します。
  • メンテナンス(一覧)項目設定・ソート方法(genericMasterSettings / mainte / listItems / item @ order):任意
    一覧画面での初期ソート方法(asc,desc)を設定します。
    未設定の場合は、昇順(asc)を設定します。
  • メンテナンス(編集)項目設定(genericMasterSettings / mainte / editItems / item):任意
    編集画面の項目を設定します。
  • メンテナンス(編集)項目設定・項目名(genericMasterSettings / mainte / editItems / item @ name):必須
    編集画面に表示する項目名(項目設定で設定した項目名)を設定します。
  • メンテナンス(編集)項目設定・結合(genericMasterSettings / mainte / editItems / item @ join):任意
    編集画面に表示する項目のうち、結合を行う場合の結合キーを設定します。
    未設定の場合は、項目の結合を行いません。

    コラム

    結合キーとは
    結合設定を行わない場合は、各項目がそれぞれの行として表示されます。
    結合を行う項目に同じ結合キーを設定することで、複数項目を一つの行として表示されます。
    この時、項目名として表示されるサーフィスは、設定順で一番初めに設定された項目のサーフィスが使用されます。

    例)予備項目A、予備項目Bの結合
    結合キー(extension)を設定した場合
    ../../../_images/join_001.png
    結合キーを設定しない場合
    ../../../_images/join_002.png
  • マスタメンテナンス画面(一覧部品)の表示件数(genericMasterSettings / mainte / limit):任意
    一覧画面の表示件数を設定します。
    未設定の場合は、20件を設定します。
  • マスタメンテナンス画面の登録・更新後の一覧画面遷移有無(genericMasterSettings / mainte / truns):任意
    登録・更新処理後の一覧画面遷移有無(true,false)を設定します。
    未設定の場合は、遷移しない(false)を設定します。
  • マスタメンテナンス画面の一覧画面遷移時の再検索有無(genericMasterSettings / mainte / reload):任意
    登録・更新処理後、一覧画面に遷移した際の再検索有無(true,false)を設定します。
    未設定の場合は、再検索する(true)を設定します。

4.1.8. インポート設定

インポート設定では、インポートジョブで使用する項目の設定を行います。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <importJob>
    <items>
      <item name="companyCd" />
      <item name="accountCd" />
      <item name="startDate" />
      <item name="endDate" />
      <item name="deleteFlag" />
      <item name="localeId" />
      <item name="accountName" />
    </items>
  </importJob>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • インポートジョブ項目設定(genericMasterSettings / importJob / items / item):任意
    インポートジョブで使用する項目を設定します。
  • インポートジョブ項目設定・項目名(genericMasterSettings / importJob / items / item @ name):任意
    インポートジョブで使用する項目名(項目設定で設定した項目名)を設定します。
    設定順に応じてインポートファイルのカラム順が変動します。
    詳細は、「インポートファイルのカラム判定について」を参照してください。
  • インポートジョブパラメータ(genericMasterSettings / importJob / parameters / parameter):任意
    ジョブパラメータを設定します。
    詳細は、「指定可能なジョブパラメータ」を参照してください。
  • インポートジョブパラメータキー(genericMasterSettings / importJob / parameters / parameter @ key):任意
    ジョブパラメータのキーを設定します。
  • インポートジョブパラメータ値(genericMasterSettings / importJob / parameters / parameter @ value):任意
    ジョブパラメータの値を設定します。

4.1.9. エクスポート設定

エクスポート設定では、エクスポートジョブで使用する項目の設定を行います。

設定
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  
  <!-- 略 -->
  
  <exportJob>
    <items>
      <item name="companyCd"   />
      <item name="accountCd"   />
      <item name="startDate"   />
      <item name="endDate"     />
      <item name="deleteFlag"  />
      <item name="localeId"    />
      <item name="accountName" />
    </items>
  </exportJob>
  
  <!-- 略 -->
  
</genericMasterSettings>
解説
  • エクスポートジョブ項目設定(genericMasterSettings / exportJob / items / item):任意
    エクスポートジョブで使用する項目を設定します。
  • エクスポートジョブ項目設定・項目名(genericMasterSettings / exportJob / items / item @ name):任意
    エクスポートジョブで使用する項目名(項目設定で設定した項目名)を設定します。
    設定順でエクスポートファイルのカラム順とします。
  • エクスポートジョブ項目設定・ソート有無(genericMasterSettings / exportJob / items / item @ sort):任意
    エクスポートデータのソート有無(true,false)を設定します。
    未設定の場合は、ソート有(true)を設定します。
  • エクスポートジョブ項目設定・ソート方法(genericMasterSettings / exportJob / items / item @ order):任意
    エクスポートデータのソート方法(asc,desc)を設定します。
    未設定の場合は、昇順(asc)を設定します。
  • エクスポートジョブパラメータ(genericMasterSettings / exportJob / parameters / parameter):任意
    ジョブパラメータを設定します。
    詳細は、「指定可能なジョブパラメータ」を参照してください。
  • エクスポートジョブパラメータキー(genericMasterSettings / exportJob / parameters / parameter @ key):任意
    ジョブパラメータのキーを設定します。
  • エクスポートジョブパラメータ値(genericMasterSettings / exportJob / parameters / parameter @ value):任意
    ジョブパラメータの値を設定します。

4.1.10. Sample

次のMasterBuilder定義は勘定科目マスタの設定を行った場合のサンプルです。
<?xml version="1.0" encoding="UTF-8"?>
<genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings">
  <!-- 勘定科目 -->
  <masterId>account</masterId>
  <surfaceKey>master_name</surfaceKey>
  <service>k30mAccountService</service>
  <resources>service://kaiden/master/account</resources>
  
  <!-- 項目設定 -->
  <items>
    <!-- 会社コード -->
    <item name="companyCd" surfaceKey="company_code" primary="true">
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'companyExists', 'args':['companyCd','searchCriteriaDate','true']}"/>
      </validates>
    </item>
    <!-- 会社名 -->
    <item name="companyName" surfaceKey="company_name"/>
    <!-- 期間コード -->
    <item name="termCd" surfaceKey="term_code" primary="true"/>
    <!-- 開始日 -->
    <item name="startDate" surfaceKey="start_date">
      <convert display="STRING_DATE" process="TIMESTAMP"/>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'date'}"/>
      </validates>
    </item>
    <!-- 終了日 -->
    <item name="endDate" surfaceKey="end_date">
      <convert display="STRING_DATE" process="TIMESTAMP_SHIFT"/>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'date'}"/>
        <validate type="DEFAULT" args="{'type':'dateMin', 'args':'startDate'}"/>
      </validates>
    </item>
    <!-- 削除フラグ -->
    <item name="deleteFlag" surfaceKey="delete_flag">
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'flag'}"/>
      </validates>
    </item>
    <!-- ロケールID -->
    <item name="localeId" surfaceKey="locale_id" primary="true">
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'locale'}"/>
      </validates>
    </item>
    
    <!-- 勘定科目コード -->
    <item name="accountCd" surfaceKey="account_code" type="TEXT_CODE" primary="true">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="100"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'kaidenId'}"/>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'100'}"/>
      </validates>
    </item>
    <!-- 勘定科目名 -->
    <item name="accountName" surfaceKey="account_name" type="TEXT_LOCALES">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'required'}"/>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    
    <!-- 予備項目A -->
    <item name="extensionA" surfaceKey="extension_a" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目B -->
    <item name="extensionB" surfaceKey="extension_b" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目C -->
    <item name="extensionC" surfaceKey="extension_c" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目D -->
    <item name="extensionD" surfaceKey="extension_d" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目E -->
    <item name="extensionE" surfaceKey="extension_e" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目F -->
    <item name="extensionF" surfaceKey="extension_f" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目G -->
    <item name="extensionG" surfaceKey="extension_g" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目H -->
    <item name="extensionH" surfaceKey="extension_h" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目I -->
    <item name="extensionI" surfaceKey="extension_i" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 予備項目J -->
    <item name="extensionJ" surfaceKey="extension_j" type="TEXT">
      <args>
        <arg key="style"     value="width:300px;"/>
        <arg key="maxlength" value="250"/>
        <arg key="imeMode"   value="on"/>
      </args>
      <validates>
        <validate type="DEFAULT" args="{'type':'maxLength', 'args':'250'}"/>
      </validates>
    </item>
    <!-- 登録日 -->
    <item name="entryTs" surfaceKey="entry_ts"><convert display="STRING_TIMESTAMP" process="TIMESTAMP"/></item>
    <!-- 登録者 -->
    <item name="entryUserCd" surfaceKey="entry_user_cd"/>
    <!-- 更新カウント -->
    <item name="renewCnt" surfaceKey="renew_cnt"><convert display="STRING" process="LONG"/></item>
    <!-- 更新日 -->
    <item name="renewTs" surfaceKey="renew_ts"><convert display="STRING_TIMESTAMP" process="TIMESTAMP"/></item>
    <!-- 更新者 -->
    <item name="renewUserCd" surfaceKey="renew_user_cd"/>
  </items>
  
  <!-- メンテナンス設定 -->
  <mainte>
    <listItems>
      <item name="accountCd" width="250px"/>
      <item name="accountName"/>
    </listItems>
    <editItems>
      <item name="accountCd"/>
      <item name="accountName"/>
    </editItems>
    <truns>true</truns>
    <reload>true</reload>
  </mainte>
  
  <!-- 検索設定 -->
  <search type="SEARCH">
    <items>
      <item name="accountCd"   type="CODE"/>
      <item name="accountName" type="NAME" width="250px"/>
    </items>
  </search>
  
  <!-- インポート設定 -->
  <importJob>
    <items>
      <item name="companyCd" />
      <item name="accountCd" />
      <item name="localeId" />
      <item name="startDate" />
      <item name="endDate" />
      <item name="accountName" />
      <item name="deleteFlag" />
    </items>
  </importJob>
  
  <!-- エクスポート設定 -->
  <exportJob>
    <items>
      <item name="companyCd" />
      <item name="accountCd" />
      <item name="localeId" />
      <item name="startDate" />
      <item name="endDate" />
      <item name="accountName" />
      <item name="deleteFlag" />
    </items>
  </exportJob>
  
  <!-- ラベル設定 -->
  <surfaces>
    <surface surfaceKey="master_name" surface="Account">
      <name localeId="ja"    surface="勘定科目" />
      <name localeId="en"    surface="Account" />
      <name localeId="zh_CN" surface="帐户科目" />
    </surface>
    
    <surface surfaceKey="company_code" surface="Company Code">
      <name localeId="ja"    surface="会社コード" />
      <name localeId="en"    surface="Company Code" />
      <name localeId="zh_CN" surface="公司代码" />
    </surface>
    <surface surfaceKey="company_name" surface="Company Name">
      <name localeId="ja"    surface="会社名" />
      <name localeId="en"    surface="Company Name" />
      <name localeId="zh_CN" surface="公司名" />
    </surface>
    <surface surfaceKey="term_code" surface="Term Code">
      <name localeId="ja"    surface="期間コード" />
      <name localeId="en"    surface="Term Code" />
      <name localeId="zh_CN" surface="期间代码" />
    </surface>
    <surface surfaceKey="start_date" surface="Start date">
      <name localeId="ja"    surface="開始日" />
      <name localeId="en"    surface="Start date" />
      <name localeId="zh_CN" surface="开始日" />
    </surface>
    <surface surfaceKey="end_date" surface="End Date">
      <name localeId="ja"    surface="終了日" />
      <name localeId="en"    surface="End Date" />
      <name localeId="zh_CN" surface="结束日" />
    </surface>
    <surface surfaceKey="delete_flag" surface="Delete Flag">
      <name localeId="ja"    surface="削除フラグ" />
      <name localeId="en"    surface="Delete Flag" />
      <name localeId="zh_CN" surface="删除标志" />
    </surface>
    <surface surfaceKey="locale_id" surface="Locale ID">
      <name localeId="ja"    surface="ロケールID" />
      <name localeId="en"    surface="Locale ID" />
      <name localeId="zh_CN" surface="区域ID" />
    </surface>
    
    <surface surfaceKey="account_code" surface="Account Code">
      <name localeId="ja"    surface="勘定科目コード" />
      <name localeId="en"    surface="Account Code" />
      <name localeId="zh_CN" surface="帐户科目代码" />
    </surface>
    <surface surfaceKey="account_name" surface="Account Name">
      <name localeId="ja"    surface="勘定科目名" />
      <name localeId="en"    surface="Account Name" />
      <name localeId="zh_CN" surface="帐户科目名" />
    </surface>
    
    <surface surfaceKey="extension_a" surface="Preliminary Item A">
      <name localeId="ja"    surface="予備項目A" />
      <name localeId="en"    surface="Preliminary Item A" />
      <name localeId="zh_CN" surface="预备项目A" />
    </surface>
    <surface surfaceKey="extension_b" surface="Preliminary Item B">
      <name localeId="ja"    surface="予備項目B" />
      <name localeId="en"    surface="Preliminary Item B" />
      <name localeId="zh_CN" surface="预备项目B" />
    </surface>
    <surface surfaceKey="extension_c" surface="Preliminary Item C">
      <name localeId="ja"    surface="予備項目C" />
      <name localeId="en"    surface="Preliminary Item C" />
      <name localeId="zh_CN" surface="预备项目C" />
    </surface>
    <surface surfaceKey="extension_d" surface="Preliminary Item D">
      <name localeId="ja"    surface="予備項目D" />
      <name localeId="en"    surface="Preliminary Item D" />
      <name localeId="zh_CN" surface="预备项目D" />
    </surface>
    <surface surfaceKey="extension_e" surface="Preliminary Item E">
      <name localeId="ja"    surface="予備項目E" />
      <name localeId="en"    surface="Preliminary Item E" />
      <name localeId="zh_CN" surface="预备项目E" />
    </surface>
    <surface surfaceKey="extension_f" surface="Preliminary Item F">
      <name localeId="ja"    surface="予備項目F" />
      <name localeId="en"    surface="Preliminary Item F" />
      <name localeId="zh_CN" surface="预备项目F" />
    </surface>
    <surface surfaceKey="extension_g" surface="Preliminary Item G">
      <name localeId="ja"    surface="予備項目G" />
      <name localeId="en"    surface="Preliminary Item G" />
      <name localeId="zh_CN" surface="预备项目G" />
    </surface>
    <surface surfaceKey="extension_h" surface="Preliminary Item H">
      <name localeId="ja"    surface="予備項目H" />
      <name localeId="en"    surface="Preliminary Item H" />
      <name localeId="zh_CN" surface="预备项目H" />
    </surface>
    <surface surfaceKey="extension_i" surface="Preliminary Item I">
      <name localeId="ja"    surface="予備項目I" />
      <name localeId="en"    surface="Preliminary Item I" />
      <name localeId="zh_CN" surface="预备项目I" />
    </surface>
    <surface surfaceKey="extension_j" surface="Preliminary Item J">
      <name localeId="ja"    surface="予備項目J" />
      <name localeId="en"    surface="Preliminary Item J" />
      <name localeId="zh_CN" surface="预备项目J" />
    </surface>
    <surface surfaceKey="entry_ts" surface="Entry Date">
      <name localeId="ja"    surface="登録日"/>
      <name localeId="en"    surface="Entry Date"/>
      <name localeId="zh_CN" surface="注册日"/>
    </surface>
    <surface surfaceKey="entry_user_cd" surface="Entry User">
      <name localeId="ja"    surface="登録者"/>
      <name localeId="en"    surface="Entry User"/>
      <name localeId="zh_CN" surface="注册者"/>
    </surface>
    <surface surfaceKey="renew_cnt" surface="Renew Count">
      <name localeId="ja"    surface="更新カウント"/>
      <name localeId="en"    surface="Renew Count"/>
      <name localeId="zh_CN" surface="更新计数"/>
    </surface>
    <surface surfaceKey="renew_ts" surface="Renew Date">
      <name localeId="ja"    surface="更新日"/>
      <name localeId="en"    surface="Renew Date"/>
      <name localeId="zh_CN" surface="更新日"/>
    </surface>
    <surface surfaceKey="renew_user_cd" surface="Renew User">
      <name localeId="ja"    surface="更新者"/>
      <name localeId="en"    surface="Renew User"/>
      <name localeId="zh_CN" surface="更新者"/>
    </surface>
  </surfaces>
</genericMasterSettings>