Metadata Components

Text

{
     id :  promoSlogan ,
     type :  Text ,
     outputProperty :  Slogan ,
     required : true,
     label :  Slogan ,
     maxLength : 80,
     defaultValue :  {! _input_.Slogan } 
}

Expression Value

When referenced on an expression, this component returns the current text value of the input.

Result Value

When generating the result, this component sets the value of the text input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object.

Number

This component displays a numeric field.

{
     id :  promoPrice ,
     type :  Number ,
     outputProperty :  Price ,
     required : true,
     label :  Price ,
     max : 1000000,
     min : 0,
     decimalPlaces : 2,
     autoAdjust : true
}

Expression Value

When referenced on an Expression, this component returns the current numeric value of the input.

Result Value

When generating the result, this component sets the value of the numeric input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object.

Label

This component displays a non-editable text.

{
     id :  myLabel ,
     type :  Label ,
     color :  red ,
     visible : {
         left :  {! promoTemplate.Name } ,
         operator :  equal ,
         right  :  Customer Promotion 
    },
     message :  Selected Customer Promotion! 
}

Expression Value

When referenced on an Expression, this component returns an empty value.

Result Value

This component doesn’t push any value to the result structure.

Empty

This component doesn’t display any input. It takes the space any other input would take.

{
     id :  myEmptyBlock ,
     type :  Empty ,
     visible : {
         left :  {! promoTemplate.Name } ,
         operator :  equal ,
         right  :  Customer Promotion 
    }
}

Expression Value

When referenced on an Expression, this component returns an empty value.

Result Value

This component doesn’t push any value to the result structure.

Date

This component displays a Date Picker field. The Date Picker date value is displayed according to the user's locale.

{
     id :  promoDateFrom ,
     type :  Date ,
     outputProperty :  DateFrom ,
     required : true,
     label :  Date From ,
     defaultValue :  2020-01-01 
}

Expression Value

When referenced on an Expression, this component returns the current date of the control as a string with the format YYYY-MM-DD .

Result Value

When generating the result, this component sets the value of the date input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a String with the format YYYY-MM-DD .

Duration

This component displays a control with 2 inputs. A numeric field and a picklist field. On the numeric field, the user can input a number. On the picklist field, the user can select Days, Weeks, or Months. This control is used to calculate a second date based on another reference date by adding a number of weeks or months to it.

{
     metric :  week ,
     quantity : 1
}

{
     id :  promoDuration ,
     type :  Duration ,
     outputProperty :  DateThru ,
     required : true,
     label :  Duration ,
     referenceDate :  {! DateFrom } 
}

Expression Value

When referenced on an Expression, this component returns the computed date of the control as a string with the format YYYY-MM-DD .

Result Value

When generating the result, this component sets the value of the computed date on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a String with the format YYYY-MM-DD .

Checkbox

This component displays a checkbox field.

{
     id :  promoCheckbox ,
     type :  Checkbox ,
     outputProperty :  myCheckbox ,
     label :  Promotion Checkbox ,
     defaultValue : true
}

Expression Value

When referenced on an Expression, this component returns the current value of the control as a Boolean.

Result Value

When generating the result, this component sets the value of the control on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a Boolean.

Picklist

This component displays a picklist field.

Picklist Source

The list of available values for the picklist can be defined in 2 different ways.

It's important to note that the object records that are part of the dataset for a picklist field can have as many properties as needed. These properties can be accessed through Expressions in other components, as seen on the examples.

Note

...
 source : [
    {
         Id :  myFirstValue ,
         Name :  My First Value ,
         MyAdditionalField :  MyAdditionalFieldForFirstItem 
    },
    {
         Id :  mySecondValue ,
         Name :  My Second Value ,
         MyAdditionalField :  MyAdditionalFieldForSecondItem 
    }
],
 itemLabelField :  Name ,
 itemValueField :  Id 
...

APEX Provided List of Values

You can retrieve the list of possible values for a picklist. The APEX callable classes are called to retrieve the values. In the WizardComponentmetadata, specify from which APEX callable class and method we want to get the values from.

...
 source : {
     class :  MyPicklistValues ,
     method :  getPicklistValues ,
     cache : true,
     params : {
         myFirstParameter :  firstParameterValue ,
         mySecondParameter :  {! promoTemplate.Id } 
    }
},
 itemLabelField :  Name ,
 itemValueField :  Id 
...

Example Callable Class

public with sharing class MyPicklistValues implements System.Callable {
    public class MyPicklistValuesException extends Exception {};
  
    public Object call(String method, Map<String, Object> params) {
          
        // Check that the provided method is the expected method
        // It is possible to have multiple methods in the same class
        if (method !== 'getPicklistValues') {
            throw new MyPicklistValuesException('Invalid Method!');
        }
 
        // we can extract call parameters from the  params  property
        String myFirstParameter = (String) params.get('myFirstParameter');
        String mySecondParameter = (String) params.get('mySecondParameter');
  
        return new List<Map<String, String>> {
            new Map<String, String> {
                'Id' => 'myFirstValue',
                'Name' => 'My First Value',
                'MyAdditionalField' => 'MyAdditionalFieldForFirstItem'
            },
            new Map<String, String> {
                'Id' => 'mySecondValue',
                'Name' => 'My Second Value',
                'MyAdditionalField' => 'MyAdditionalFieldForSecondItem'
            }
        };
    }
  
}

Example

{
     id :  promoExamplePicklist ,
     type :  Picklist ,
     required : true,
     outputProperty :  ExamplePicklist ,
     source : {
         class :  MyPicklistValues ,
         method :  getPicklistValues ,
         cache : true,
         params : {
             myFirstParameter :  firstParameterValue ,
             mySecondParameter :  {! promoTemplate.Id } 
        }
    },    
     label :  ExamplePicklist ,
     autoSelectFirstItem : true
}

Expression Value

Depending if the field is multiselect or single select, the value that is accessible from expressions is different:

singles elect

When referenced on an Expression, this component returns the current dataset object that is selected on the picklist. For example, taking into account the above examples:

// if the first item is selected (Id =  myFirstValue )
{
     Id :  myFirstValue ,
     Name :  My First Value ,
     MyAdditionalField :  MyAdditionalFieldForFirstItem 
}
 
// if the second item is selected
{
     Id :  mySecondValue ,
     Name :  My Second Value ,
     MyAdditionalField :  MyAdditionalFieldForSecondItem 
}

Since the picklist exposes an object as an expression value, Properties of these dataset records can be used on expressions using dot notation:

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

multiselect

When referenced on an Expression, this component returns the list of current dataset objects that are selected on the picklist.

// if the first item is selected (Id =  myFirstValue )
[
    {
         Id :  myFirstValue ,
         Name :  My First Value ,
         MyAdditionalField :  MyAdditionalFieldForFirstItem 
    }
]
 
// if both the first item and second items are selected
[
    {
         Id :  myFirstValue ,
         Name :  My First Value ,
         MyAdditionalField :  MyAdditionalFieldForFirstItem 
    },
    {
         Id :  mySecondValue ,
         Name :  My Second Value ,
         MyAdditionalField :  MyAdditionalFieldForSecondItem 
    }
]

Since the picklist exposes an array as an expression value, items on the array can be accessed using square bracket notation [0] . Also, Properties of these dataset records can be used on expressions using dot notation:

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

Result Value

single select

// if the first item is selected (Id =  myFirstValue )
{
     ExamplePicklist :  myFirstValue        // since  itemValueField  is  Id , we set the  Id  property of the selected record
}
 
// if the first item is selected (Id =  mySecondValue )
{
     ExamplePicklist :  mySecondValue       // since  itemValueField  is  Id , we set the  Id  property of the selected record
}

multiselect

// if the first item is selected (Id =  myFirstValue )
{
     ExamplePicklist : [ myFirstValue ]     // since  itemValueField  is  Id , we set the  Id  property of the selected record
}
 
// if the bot items are selected
{
     ExamplePicklist : [ myFirstValue ,  mySecondValue ]        // since  itemValueField  is  Id , we set the  Id  property of the selected record
}

ListController

{
   id :  TacticController ,
   type :  ListController ,
   label :  Tactics ,
   outputProperty :  Tactics ,
   maxItems : 10,
   active :  {! promoTemplate.HasTacticTemplates } ,
   defaultItems : 2,
   components : [
    {
       id :  tacticTemplate ,
       type :  Picklist ,
       required : true,
       outputProperty :  TacticTemplate ,
       source : {
         class :  NewPromotionWizardCallable ,
         method :  getTacticTemplates ,
         params : {
           promoTemplate :  {! promoTemplate.Id } 
        },
         cache : true
      },
       label :  Tactic Template ,
       defaultValueIndex :  {! _idx_ } ,
       autoSelectFirstItem : true
    }
  ]
}

Expression Value

Metadata configuration example

components : [
    {
         id :  promoSlogan ,                // A wizard component for the promotion slogan input
         type :  Text ,
         label :  Slogan 
    },
    {
         id :  promoSampleText ,            // A wizard component for a text
         type :  Text ,
         label :  SampleText 
    },
    {
         id :  TacticController ,           // A wizard component for the Tactics list
         type :  ListController ,
         label  :  Tactics ,
         components : [                     // This List of wizard components will create a new scope for the items below!
            {
                 id :  tacticName ,
                 type :  Text ,                     // For each tactic, we will have a name field
                 label :  MyTacticName 
            },
            {
                 id :  tacticSampleText ,
                 type :  Text ,                     // For each tactic, we will have a text field
                 label :  MyTacticSampleText 
            }
        ]
    }
]

Expression scope

// Context for expressions on the  promoSlogan  component
{
     promoSlogan :  slogan value ,                  // provided by itself
     promoSampleText :  sample text                 // provided by the  promoSampleText  component in the same level
}
  
// Context for expressions on the  tacticName  component
{
     promoSlogan :  slogan value ,                  // provided by  promoSlogan , accessible since it's above in the hierarchy
     promoSampleText :  sample text ,               // provided by  promoSampleText , accessible since it's above in the hierarchy
     _idx_ : 1,                                     // provided by the ListController component, Item index on the array
     tacticName :  tactic 1's name ,                // provided by itself
     tacticSampleText :  tactic 1's sample text     // provided by the  tacticSampleText  component in the same level
}

Result Value

When generating the result, this component sets the array of generated items on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object.