Metadata コンポーネント

Text

1{
2     id :  promoSlogan ,
3     type :  Text ,
4     outputProperty :  Slogan ,
5     required : true,
6     label :  Slogan ,
7     maxLength : 80,
8     defaultValue :  {! _input_.Slogan } 
9}

式の値

式で参照されると、このコンポーネントは入力の現在のテキスト値を返します。

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティにテキスト入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。

Number

このコンポーネントは数値項目を表示します。

1{
2     id :  promoPrice ,
3     type :  Number ,
4     outputProperty :  Price ,
5     required : true,
6     label :  Price ,
7     max : 1000000,
8     min : 0,
9     decimalPlaces : 2,
10     autoAdjust : true
11}

式の値

式で参照されると、このコンポーネントは入力の現在の数値を返します。

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに数値入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。

Label

このコンポーネントは、編集できないテキストを表示します。

1{
2     id :  myLabel ,
3     type :  Label ,
4     color :  red ,
5     visible : {
6         left :  {! promoTemplate.Name } ,
7         operator :  equal ,
8         right  :  Customer Promotion 
9    },
10     message :  Selected Customer Promotion! 
11}

式の値

式で参照されると、このコンポーネントは空の値を返します。

結果の値

このコンポーネントは結果の構造体に値を転送しません。

Empty

このコンポーネントは入力を表示しません。他に入力があれば占有されているスペースを占有します。

1{
2     id :  myEmptyBlock ,
3     type :  Empty ,
4     visible : {
5         left :  {! promoTemplate.Name } ,
6         operator :  equal ,
7         right  :  Customer Promotion 
8    }
9}

式の値

式で参照されると、このコンポーネントは空の値を返します。

結果の値

このコンポーネントは結果の構造体に値を転送しません。

Date

このコンポーネントは Date Picker 項目を表示します。Date Picker の日付値は、ユーザーのロケールに応じて表示されます。

1{
2     id :  promoDateFrom ,
3     type :  Date ,
4     outputProperty :  DateFrom ,
5     required : true,
6     label :  Date From ,
7     defaultValue :  2020-01-01 
8}

式の値

式で参照されると、このコンポーネントは、コントロールの現在の日付を YYYY-MM-DD 形式の文字列として返します。

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに日付入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは、YYYY-MM-DD 形式の文字列として設定されます。

Duration

このコンポーネントは、数値項目と選択リスト項目の 2 つの入力がある。コントロールを表示します。数値項目には数値を入力できます。選択リスト項目では、日、週、月を選択できます。このコントロールは、別の参照日を基準にして、その参照日に週数または月数を追加して 2 番目の日付を計算するために使用されます。

1{
2     metric :  week ,
3     quantity : 1
4}

1{
2     id :  promoDuration ,
3     type :  Duration ,
4     outputProperty :  DateThru ,
5     required : true,
6     label :  Duration ,
7     referenceDate :  {! DateFrom } 
8}

式の値

式で参照されると、このコンポーネントは、コントロールの計算済みの日付を YYYY-MM-DD 形式の文字列として返します。

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに計算済みの日付値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは、YYYY-MM-DD 形式の文字列として設定されます。

Checkbox

このコンポーネントはチェックボックス項目を表示します。

1{
2     id :  promoCheckbox ,
3     type :  Checkbox ,
4     outputProperty :  myCheckbox ,
5     label :  Promotion Checkbox ,
6     defaultValue : true
7}

式の値

式で参照されると、このコンポーネントは、コントロールの現在の値を Boolean として返します。

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティにコントロールの値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは Boolean として設定されます。

Picklist

このコンポーネントは選択リスト項目を表示します。

選択リストのソース

選択リストで選択できる値は、2 つの方法で定義できます。

選択リスト項目のデータセットに含まれるオブジェクトレコードは、プロパティを必要な数だけ持つことができる点に注意することが重要です。例に示すように、これらのプロパティは他のコンポーネントの式を通じてアクセスできます。

メモ

1...
2 source : [
3    {
4         Id :  myFirstValue ,
5         Name :  My First Value ,
6         MyAdditionalField :  MyAdditionalFieldForFirstItem 
7    },
8    {
9         Id :  mySecondValue ,
10         Name :  My Second Value ,
11         MyAdditionalField :  MyAdditionalFieldForSecondItem 
12    }
13],
14 itemLabelField :  Name ,
15 itemValueField :  Id 
16...

APEX が提供する値のリスト

選択リストで使用できる値のリストを取得できます。値を取得するには、APEX のコール可能なクラスをコールします。APEX のどのコール可能なクラスとメソッドから値を取得するかは、WizardComponent メタデータで指定します。

1...
2 source : {
3     class :  MyPicklistValues ,
4     method :  getPicklistValues ,
5     cache : true,
6     params : {
7         myFirstParameter :  firstParameterValue ,
8         mySecondParameter :  {! promoTemplate.Id } 
9    }
10},
11 itemLabelField :  Name ,
12 itemValueField :  Id 
13...

コール可能なクラスの例

1public with sharing class MyPicklistValues implements System.Callable {
2    public class MyPicklistValuesException extends Exception {};
3  
4    public Object call(String method, Map<String, Object> params) {
5          
6        // Check that the provided method is the expected method
7        // It is possible to have multiple methods in the same class
8        if (method !== 'getPicklistValues') {
9            throw new MyPicklistValuesException('Invalid Method!');
10        }
11 
12        // we can extract call parameters from the  params  property
13        String myFirstParameter = (String) params.get('myFirstParameter');
14        String mySecondParameter = (String) params.get('mySecondParameter');
15  
16        return new List<Map<String, String>> {
17            new Map<String, String> {
18                'Id' => 'myFirstValue',
19                'Name' => 'My First Value',
20                'MyAdditionalField' => 'MyAdditionalFieldForFirstItem'
21            },
22            new Map<String, String> {
23                'Id' => 'mySecondValue',
24                'Name' => 'My Second Value',
25                'MyAdditionalField' => 'MyAdditionalFieldForSecondItem'
26            }
27        };
28    }
29  
30}

例

1{
2     id :  promoExamplePicklist ,
3     type :  Picklist ,
4     required : true,
5     outputProperty :  ExamplePicklist ,
6     source : {
7         class :  MyPicklistValues ,
8         method :  getPicklistValues ,
9         cache : true,
10         params : {
11             myFirstParameter :  firstParameterValue ,
12             mySecondParameter :  {! promoTemplate.Id } 
13        }
14    },    
15     label :  ExamplePicklist ,
16     autoSelectFirstItem : true
17}

式の値

項目が複数選択であるのか、単一選択であるのかによって、式からアクセスできる値は異なります。

単一選択

式で参照されると、このコンポーネントは、選択リストで現在選択されているデータセットオブジェクトを返します。たとえば、上記の例を考慮すると次のようになります。

1// if the first item is selected (Id =  myFirstValue )
2{
3     Id :  myFirstValue ,
4     Name :  My First Value ,
5     MyAdditionalField :  MyAdditionalFieldForFirstItem 
6}
7 
8// if the second item is selected
9{
10     Id :  mySecondValue ,
11     Name :  My Second Value ,
12     MyAdditionalField :  MyAdditionalFieldForSecondItem 
13}

選択リストはオブジェクトを式の値として公開するため、これらのデータセットレコードのプロパティは、式でドット表記を用いて使用できます。

1{! promoExamplePicklist.MyAdditionalField }  --> resolves to  MyAdditionalFieldForFirstItem 
2 {! promoExamplePicklist.MyNonExistantField }  --> resolves to undefined, since the field doesn't exist

複数選択

式で参照されると、このコンポーネントは、選択リストで現在選択されているデータセットオブジェクトのリストを返します。

1// if the first item is selected (Id =  myFirstValue )
2[
3    {
4         Id :  myFirstValue ,
5         Name :  My First Value ,
6         MyAdditionalField :  MyAdditionalFieldForFirstItem 
7    }
8]
9 
10// if both the first item and second items are selected
11[
12    {
13         Id :  myFirstValue ,
14         Name :  My First Value ,
15         MyAdditionalField :  MyAdditionalFieldForFirstItem 
16    },
17    {
18         Id :  mySecondValue ,
19         Name :  My Second Value ,
20         MyAdditionalField :  MyAdditionalFieldForSecondItem 
21    }
22]

選択リストは配列を式の値として公開するため、配列の項目は、角括弧表記 [0] を使用してアクセスできます。また、これらのデータセットレコードのプロパティは、式でドット表記を用いて使用することもできます。

1{! promoExamplePicklist[0].MyAdditionalField }  --> resolves to  MyAdditionalFieldForFirstItem 
2 {! promoExamplePicklist[1].MyAdditionalField }  --> resolves to  MyAdditionalFieldForSecondItem 
3 
4 {! promoExamplePicklist[99].MyAdditionalField }  --> resolves to undefined, since the element does not exist.

結果の値

単一選択

1// if the first item is selected (Id =  myFirstValue )
2{
3     ExamplePicklist :  myFirstValue        // since  itemValueField  is  Id , we set the  Id  property of the selected record
4}
5 
6// if the first item is selected (Id =  mySecondValue )
7{
8     ExamplePicklist :  mySecondValue       // since  itemValueField  is  Id , we set the  Id  property of the selected record
9}

複数選択

1// if the first item is selected (Id =  myFirstValue )
2{
3     ExamplePicklist : [ myFirstValue ]     // since  itemValueField  is  Id , we set the  Id  property of the selected record
4}
5 
6// if the bot items are selected
7{
8     ExamplePicklist : [ myFirstValue ,  mySecondValue ]        // since  itemValueField  is  Id , we set the  Id  property of the selected record
9}

ListController

1{
2   id :  TacticController ,
3   type :  ListController ,
4   label :  Tactics ,
5   outputProperty :  Tactics ,
6   maxItems : 10,
7   active :  {! promoTemplate.HasTacticTemplates } ,
8   defaultItems : 2,
9   components : [
10    {
11       id :  tacticTemplate ,
12       type :  Picklist ,
13       required : true,
14       outputProperty :  TacticTemplate ,
15       source : {
16         class :  NewPromotionWizardCallable ,
17         method :  getTacticTemplates ,
18         params : {
19           promoTemplate :  {! promoTemplate.Id } 
20        },
21         cache : true
22      },
23       label :  Tactic Template ,
24       defaultValueIndex :  {! _idx_ } ,
25       autoSelectFirstItem : true
26    }
27  ]
28}

式の値

メタデータの設定の例

1components : [
2    {
3         id :  promoSlogan ,                // A wizard component for the promotion slogan input
4         type :  Text ,
5         label :  Slogan 
6    },
7    {
8         id :  promoSampleText ,            // A wizard component for a text
9         type :  Text ,
10         label :  SampleText 
11    },
12    {
13         id :  TacticController ,           // A wizard component for the Tactics list
14         type :  ListController ,
15         label  :  Tactics ,
16         components : [                     // This List of wizard components will create a new scope for the items below!
17            {
18                 id :  tacticName ,
19                 type :  Text ,                     // For each tactic, we will have a name field
20                 label :  MyTacticName 
21            },
22            {
23                 id :  tacticSampleText ,
24                 type :  Text ,                     // For each tactic, we will have a text field
25                 label :  MyTacticSampleText 
26            }
27        ]
28    }
29]

式の範囲

1// Context for expressions on the  promoSlogan  component
2{
3     promoSlogan :  slogan value ,                  // provided by itself
4     promoSampleText :  sample text                 // provided by the  promoSampleText  component in the same level
5}
6  
7// Context for expressions on the  tacticName  component
8{
9     promoSlogan :  slogan value ,                  // provided by  promoSlogan , accessible since it's above in the hierarchy
10     promoSampleText :  sample text ,               // provided by  promoSampleText , accessible since it's above in the hierarchy
11     _idx_ : 1,                                     // provided by the ListController component, Item index on the array
12     tacticName :  tactic 1's name ,                // provided by itself
13     tacticSampleText :  tactic 1's sample text     // provided by the  tacticSampleText  component in the same level
14}

結果の値

結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに、生成された項目の配列を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。