4.1. MasterBuilder定義¶
本項では、MasterBuilderの設定ファイル（以降、MasterBuilder定義）の作成方法を説明します。
4.1.1. 概要¶
4.1.1.1. MasterBuilder定義¶
MasterBuilder定義は、XML形式で次の設定を行います。
設定名 概要 基本設定 マスタの基本となる設定です。（ID、名称など） 項目設定 マスタの項目設定です。本設定を使用して各機能別設定の簡略化を実現しています。 拡張設定 マスタを拡張する場合の設定です。（設定だけでは実現できない場合などに使用します。） サーフィス設定 マスタ名や項目名などの設定です。 マスタメンテナンス設定 マスタメンテナンス機能の個別設定です。 検索設定 検索部品・セレクトボックス機能の個別設定です。 インポート設定 インポート機能の個別設定です。 エクスポート設定 エクスポート機能の個別設定です。 コラム
MasterBuilder定義の全体イメージは「Sample」を参照してください。コラム
Ver2.0.16で、MasterBuilder定義の編集・検証が可能な機能を追加しました。詳細は『intra-mart Accel Kaiden! 経費旅費 / 管理者操作ガイド』-「運用時の操作」-「Builder編集」を参照してください。
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を追加
コラム
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>解説
コラム
APIを使用した検索検索部品やセレクトボックス、バリデート機能のみを使用し、APIによる検索を行う場合はサービスクラスの設定は不要です。後述する拡張設定でLogicクラスを拡張し、APIを使用した検索処理を追加してください。コラム
認可判定MasterBuilderの認可判定は次の2段階で実行されます。
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>解説
設定値 解説 DEFAULT デフォルトバリデートです。登録、更新、インポートの各バリデート時に合わせて実行します。 ENTRY メンテナンス機能で新規登録を行う際に実行されるバリデートです。 RENEW メンテナンス機能で更新を行う際に実行されるバリデートです。 DELETE メンテナンス機能で削除を行う際に実行されるバリデートです。 IMPORT インポート時に実行されるバリデートです。
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>解説
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>解説
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>解説
コラム
結合キーとは結合設定を行わない場合は、各項目がそれぞれの行として表示されます。結合を行う項目に同じ結合キーを設定することで、複数項目を一つの行として表示されます。この時、項目名として表示されるサーフィスは、設定順で一番初めに設定された項目のサーフィスが使用されます。例）予備項目A、予備項目Bの結合結合キー（extension）を設定した場合
結合キーを設定しない場合
4.1.7. 検索設定¶
検索設定では、検索部品やセレクトボックスで使用する項目の設定を行います。設定<?xml version="1.0" encoding="UTF-8"?> <genericMasterSettings xmlns="http://kaiden.slcs.co.jp/xmlschema/genericMasterSettings"> <!-- 略 --> <search type="SELECT"> <items> <item name="accountCd" type="CODE"/> <item name="accountName" type="NAME" width="250px"/> </items> </search> <!-- 略 --> </genericMasterSettings>解説
コラム
検索結果の表示件数についてMasterBuilderで定義されている全マスタの表示件数を変更したい場合『intra-mart Accel Kaiden! プログラミングガイド』-「応用」-「その他」-「機能説明」を参照して定数ファイルの「マスタ検索部品（PC版）の表示上限件数」と「マスタ検索部品（SP版）の表示上限件数」を変更してください。PC版検索結果の表示件数は以下の優先順位で設定します。
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>解説
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>解説
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>