Documentation
API
Q&A
Read
AnnouncementsArticlesWebsite tips
Learn
Getting StartedManagerMaestroAnalyticsExchangeWorkspaces
Resources
VideosDownloadsExchange PackagesRelease Notes
Contact
Platform
Manager
Maestro
Exchange
Workspaces
Analytics
Springboard

Component Options

   MaestroThe UI design product.  |    Form Builder  |  All versions This feature is related to all versions.

Journey Maestro allows you to identify and extend functionality of custom and shared components using the Component Options, as shown below.

You can add the following options to a component from the Maestro editor:

Note

You cannot change the Component Options of core components.

Properties Options

Maestro provides fine control of various component options and Properties options. You can use these options to configure different component attributes, including branding and help text.

To configure Properties options for a component:

  1. Open a project in your organization.
  2. Select the component in the Component folder from the Maestro Dashboard.
  3. Click Edit Version.
  4. Click Component Options and select Properties.

  5. Click New Property and edit the details of a new property.

  6. Property Label is visible on the component. This is the mandatory field.
  7. Property Name is the unique identifier of the property, which is automatically generated based on the label name.
  8. Category: Options, Input Fields, Background services, etc.
  9. Select a property type from the Type dropdown list that can be one of the followings: a Boolean, Options, Field Ref Map, Help Text, etc. The functionality of the property will differ depending on its type.
  10. Default Value identifies whether the property should be configured with a default value, which is true.
  11. Help Text is the text that is displayed when a cursor hovers over the component, for example 'Controls whether to attempt a background check on a driver's license holder'.
  12. Click Done.
  13. Check the recently created property in the Component Properties window. You can also create another property if required.

  14. Click Save.

Rule Helper Options

Maestro provides fine control of various component options, including Rule Helper options. You can use these options to add methods to a component right-click event in the rule editor, so a Rule Helper will appear as a selectable option when users right-click the component in the rule editor tree.

To configure Rule Helper options for a component:

  1. Open a project in your organization.
  2. Select the component in the Component folder from the Maestro Dashboard.
  3. Click Edit Version.
  4. Click Component Options and select Rule Helpers.

  5. Click New Rule Helper.

  6. Type a name for a Label to identify the rule helper when a user right-clicks the component in the editor tree and click Create Script.

  7. Enter a JavaScript for the new rule helper.

    8. A JavaScript can follow this pattern: Form.fireRule ("name of the Component Template", Form.items.component_ID, data), as shown in the example below:

    
Form.fireRule("testRule", Form.items.componentRuleTestID, data);

    In this example, testRule is the name of the Component Template and componentRuleTest is the component ID of the component that the Rule helper is associated with. When a user right-clicks the component with the component ID componentRuleTestID, the configured Rule Helper is available as a selectable option.

    Note

    You can use insert-item keyword to reference the item selected from the tree.

  8. Click Done and then click Save.

Rule Template Options

Journey Maestro provides you with the fine control of various component options, including Rule Template options. You can use these options to add custom rule types to a component. Once a rule is configured, you can run its JavaScript from another location of your form.

To configure Rule Templates options for a component:

  1. Open a project in your organization.
  2. Select the component in the Component folder from the Maestro Dashboard.
  3. Click Edit Version.
  4. Click Component Options and select Rule Templates.

  5. Click New Rule Template.

  6. Enter the Name for the rule template, which automatically prefills the Type of this rule file and the code required to execute it, for example: Form.fireRule("test1", item, data)

    7. Note

    It is recommended to save this code for your further reference as you will need it for an executable command later.

  7. Click Create Default Script to edit a rule script.

  8. Click Done.

Next, check our best practices.