intra-mart Accel Kaiden! GadgetBuilder 設定ガイド 第6版 2020-04-01

5.3. 補完処理

GadgetBuilder定義の「補完設定」で設定可能な補完処理について説明します。

5.3.1. intra-mart Accel Kaiden!標準の補完処理

本項では、intra-mart Accel Kaiden!で提供している補完処理と設定方法を説明します。

5.3.1.1. 固定値補完 [ type : fixed ]

概要
対象フィールドに固定値を補完します。
引数
キー 設定値
value 固定値
設定方法(例)
「targetField」フィールドに固定値「1」を補完
<completion name="targetField" position="1" type="fixed" args="{'value':'1'}"/>

5.3.1.2. 変数値補完 [ type : variable ]

概要
対象フィールドに変数値(フィールドの値)を補完します。
引数
キー 設定値
field 補完値を保持するフィールド名
設定方法(例)
「targetField」フィールドに「variableField」フィールドの値を補完
<completion name="targetField" position="1" type="variable" args="{'field':'variableField'}"/>

5.3.1.3. 計算値補完 [ type : calc ]

概要
対象フィールドに計算値(加算・減算・乗算・除算)を補完します。
引数
キー 設定値
field1 計算値を保持するフィールド名1
field2 計算値を保持するフィールド名2
calc
計算方法
  • ADD : field1 + field2
  • SUB : field1 - field2
  • MUL : field1 * field2
  • DIV : field1 / field2
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
brank
計算が正しく行われなかった時に結果を空白にするか
未指定時:false
  • true : 結果を空白にする
  • false : 結果を「0」にする
設定方法(例)
「targetField」フィールドに「calcField1」フィールド値と「calcField2」フィールド値の計算結果(加算)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calc" args="{'field1':'calcField1','field2':'calcField2','calc':'ADD','round':'4','digits':'0','scale':'10','blank':'true'}"/>

5.3.1.4. 計算値(加算)補完 [ type : calcAdd ]

概要
対象フィールドに計算値(加算)を補完します。
引数
キー 設定値
field1 計算値を保持するフィールド名1
field2 計算値を保持するフィールド名2
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
brank
計算が正しく行われなかった時に結果を空白にするか
未指定時:false
  • true : 結果を空白にする
  • false : 結果を「0」にする
設定方法例
「targetField」フィールドに「calcField1」フィールド値と「calcField2」フィールド値の計算結果(加算)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calcAdd" args="{'field1':'calcField1','field2':'calcField2','round':'4','digits':'0','scale':'10','blank':'true'}"/>

5.3.1.5. 計算値(減算)補完 [ type : calcSub ]

概要
対象フィールドに計算値(減算)を補完します。
引数
キー 設定値
field1 計算値を保持するフィールド名1
field2 計算値を保持するフィールド名2
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
brank
計算が正しく行われなかった時に結果を空白にするか
未指定時:false
  • true : 結果を空白にする
  • false : 結果を「0」にする
設定方法(例)
「targetField」フィールドに「calcField1」フィールド値と「calcField2」フィールド値の計算結果(減算)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calcSub" args="{'field1':'calcField1','field2':'calcField2','round':'4','digits':'0','scale':10,'blank':'true'}"/>

5.3.1.6. 計算値(乗算)補完 [ type : calcMul ]

概要
対象フィールドに計算値(乗算)を補完します。
引数
キー 設定値
field1 計算値を保持するフィールド名1
field2 計算値を保持するフィールド名2
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
brank
計算が正しく行われなかった時に結果を空白にするか
未指定時:false
  • true : 結果を空白にする
  • false : 結果を「0」にする
設定方法(例)
「targetField」フィールドに「calcField1」フィールド値と「calcField2」フィールド値の計算結果(乗算)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calcMul" args="{'field1':'calcField1','field2':'calcField2','round':'4','digits':'0','scale':'10','blank':'true'}"/>

5.3.1.7. 計算値(除算)補完 [ type : calcDiv ]

概要
対象フィールドに計算値(除算)を補完します。
引数
キー 設定値
field1 計算値を保持するフィールド名1
field2 計算値を保持するフィールド名2
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
brank
計算が正しく行われなかった時に結果を空白にするか
未指定時:false
  • true : 結果を空白にする
  • false : 結果を「0」にする
設定方法(例)
「targetField」フィールドに「calcField1」フィールド値と「calcField2」フィールド値の計算結果(除算)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calcDiv" args="{'field1':'calcField1','field2':'calcField2','round':'4','digits':'0','scale':'10','blank':'true'}"/>

5.3.1.8. 税額補完 [ type : calcTax ]

概要
対象フィールドに税額を補完します。
引数
キー 設定値
amount 税込金額を保持するフィールド名
taxRate 税率を保持するフィールド名
round
丸めモード(未設定時「4」)
  • 0 : ROUND_UP(切り上げ)
  • 1 : ROUND_DOWN(切り捨て)
  • 2 : ROUND_CEILING(正の無限大に近づくように丸める)
  • 3 : ROUND_FLOOR(負の無限大に近づくように丸める)
  • 4 : ROUND_HALF_UP(四捨五入)
  • 5 : ROUND_HALF_DOWN(五捨六入)
  • 6 : ROUND_HALF_EVEN(末尾が偶数のほうに丸める)
  • 7 : ROUND_UNNECESSARY(丸めなし)
digits 丸め桁数(小数点以下何桁までを有効とするか) 未設定時:0
scale 計算時の桁数(小数点以下何桁までを有効とするか) 未指定時:10
設定方法(例)
「targetField」フィールドに「amountField」フィールド値と「taxRateField」フィールド値の計算結果(税額)を補完
(補完する計算結果は小数点以下0桁まで有効で四捨五入)
<completion name="targetField" position="1" type="calcTax" args="{'amount':'amountField','taxRate':'taxRateField','round':'1','digits':'0','scale':'10'}"/>

5.3.1.9. 値補完(ガジェット間通信) [ type : claimValue ]

概要
対象フィールドにガジェット間通信で取得した値を補完します。
引数
キー 設定値
claim ガジェット間通信名
target

ガジェット間通信の対象(未設定時「0」)

  • 0 : 全ガジェット対象
  • 1 : 自身のガジェットのみ対象
  • 2 : 自身のガジェットを除く全ガジェット対象)
設定方法(例)
「targetField」フィールドに全ガジェット分のガジェット間通信(claimValue)結果を補完(最初に取得できた値)
<completion name="targetField" position="1" type="claimValue" args="{'claim':'claimValue','target':'0'}"/>

5.3.1.10. 値補完(ガジェット間通信)(初期表示時) [ type : claimValueOnInit ]

概要
初期表示時のみ、対象フィールドにガジェット間通信で取得した値を補完します。
引数
キー 設定値
claim ガジェット間通信名
target

ガジェット間通信の対象(未設定時「0」)

  • 0 : 全ガジェット対象
  • 1 : 自身のガジェットのみ対象
  • 2 : 自身のガジェットを除く全ガジェット対象)
設定方法(例)
初期表示時、「targetField」フィールドに全ガジェット分のガジェット間通信(claimValue)結果を補完(最初に取得できた値)
<completion name="targetField" position="1" type="claimValueOnInit" args="{'claim':'claimValue','target':'0'}"/>

5.3.1.11. 合計値補完(ガジェット間通信) [ type : claimSummary ]

概要
対象フィールドにガジェット間通信の返却値合計を補完します。
引数
キー 設定値
claim ガジェット間通信名
target

ガジェット間通信の対象(未設定時「0」)

  • 0 : 全ガジェット対象
  • 1 : 自身のガジェットのみ対象
  • 2 : 自身のガジェットを除く全ガジェット対象)
設定方法(例)
「targetField」フィールドに全ガジェット分のガジェット間通信(claimSummary)結果の合計値を補完
<completion name="targetField" position="1" type="claimSummary" args="{'claim':'claimSummary','target':'0'}"/>

5.3.1.12. 合計値補完(ガジェット間通信)(クリック時) [ type : claimSummaryOnClick ]

概要
設定フィールドのクリック時のみ、対象フィールドにガジェット間通信の返却値合計を補完します。
引数
キー 設定値
claim ガジェット間通信名
target

ガジェット間通信の対象(未設定時「0」)

  • 0 : 全ガジェット対象
  • 1 : 自身のガジェットのみ対象
  • 2 : 自身のガジェットを除く全ガジェット対象)
field 当補完を実行するonClickフィールド名(未設定の場合は補完しません)
設定方法(例)
「onClickField」フィールドのクリックイベントで「targetField」フィールドに全ガジェット分のガジェット間通信(claimSummary)結果の合計値を補完
<completion name="targetField" position="1" type="claimSummary" args="{'claim':'claimSummary','target':'0','field':'onClickField'}"/>

5.3.1.13. サーフィス補完(ガジェット間通信) [ type : claimSurface ]

概要
対象フィールドのサーフィスにガジェット間通信で取得した値を補完します。
引数
キー 設定値
claim ガジェット間通信名
target

ガジェット間通信の対象(未設定時「0」)

  • 0 : 全ガジェット対象
  • 1 : 自身のガジェットのみ対象
  • 2 : 自身のガジェットを除く全ガジェット対象)
設定方法(例)
「targetField」フィールドのサーフィスに全ガジェット分のガジェット間通信(claimSurface)結果を補完(最初に取得できた値)
<completion name="targetField" position="1" type="claimSurface" args="{'claim':'claimSurface','target':'0'}"/>

5.3.1.14. 会社通貨コード補完 [ type : companyCurrencyCode ]

概要
対象フィールドに会社通貨コードを補完します。
引数
キー 設定値
field 会社コードを保持するフィールド名
設定方法(例)
「targetField」フィールドに会社通貨コードを補完
<completion name="targetField" position="1" type="companyCurrencyCode" args="{'field':'companyCodeField'}"/>

5.3.1.15. DetailBlock変数値補完 [ type : variableForDetailBlock ]

概要
対象フィールドに「DetailBlock」の変数値(フィールドの値)を補完します。
本補完処理は「NormalBlock」のみ使用可能です。(取得する変数値は1行目となります。)
引数
キー 設定値
block 補完値を保持するフィールドのブロック名(DetailBlock)
field 補完値を保持するフィールド名
設定方法(例)
「targetField」フィールドに「DetailBlock」ブロックの「variableField」フィールドの値を補完(1行目)
<completion name="targetField" position="1" type="variableForDetailBlock" args="{'block':'DetailBlock','field':'variableField'}"/>

5.3.1.16. NormalBlock変数値補完 [ type : variableForNormalBlock ]

概要
対象フィールドに「NormalBlock」の変数値(フィールドの値)を補完します。
本補完処理は「DetailBlock」のみ使用可能です。
引数
キー 設定値
block 補完値を保持するフィールドのブロック名(NormalBlock)
field 補完値を保持するフィールド名
設定方法(例)
「targetField」フィールドに「NormalBlock」ブロックの「variableField」フィールドの値を補完
<completion name="targetField" position="1" type="variableForNormalBlock" args="{'block':'NormalBlock','field':'variableField'}"/>