Form Options

   MaestroPreviously known as Transact Maestro.  |   Form Builder |   21.11 This feature was updated in 21.11.

Maestro allows you to configure component's properties differently for each form in your template using the Form Options functionality.

Note

Compare this to brand's Item Properties where you can set component's properties differently for each brand.

To explain how it works, let's imagine you need to remove the navigator from forms that only contain one or two pages. Since the navigator is configured in the template by the Template Designer, you are not able to customize its appearance or properties, but you are able to hide it from the form.

When the Template Designer locks down a form by setting extension points at the template level, it is likely that they will still give the Form Builder access to basic form option configuration, such as hiding the navigator or save button. The Form Builder selects these options through the Form Options.

To add a component's property to Form Options in a template:

  1. Open a template in the Maestro editor.
  2. Select a component in the Design mode and click the Properties tab.
  3. Right click on a non-rules property you want to add, for example, Label or Hide Section Header, and select Add to Form Options. For rules properties, right click on the Create Rule button and select Add to Form Options.
    Note

    You also have a choice of adding a component's property to brands. However, if you've already added the property to Form Options, you can't add it to brands. You must remove it from Form Options first.

  4. Maestro Editor add an item property to a brand

  5. Select how you want to add a property from the Add as a radio button group:
    • New Option to add as a new property. You can use this option in most cases.
    • Linked Item to Existing Option to add as linked to an existing property and then select an existing property from the Select Existing Option dropdown list. You can use this option if the property you are adding needs to be linked to another property that has already been added, for example, an image component used to show the logo in the form might have the Image property linked to other instances of the image component used to show the logo on modal pages. This allows you to create 1 form option which will update the property of multiple components.
  6. Select a category to use for the property from the Category radio button group:
    • New Category to create a new category for the new property and type a category name in the field.
    • Existing Category to add a new property to the already existing category and then select an existing category from the dropdown list.
    • Note

      Adding categories help you group and navigate properties, especially, when there are many of them.

  7. Type a name for the property in the Label field
  8. Click Save. The property is added to Form Options, where you can edit it.
  9. Click Save in the Maestro toolbar to save the template.
  10. Click Publish to make the template changes to be available to forms that use it.
    Note

    The template changes may not be available to a forms depending on where the extension points are in the template - anything that's inside the extension point (that can be changed in the form) can't be updated by the template

To configure a form using the Form Options:

  1. Open the form in the Maestro editor and select Design.
  2. Click Form Options to view all available options.
  3. Maestro form options window.

    The categories displayed in the Form Options depend on your access rights, which are set by the Template Designer in the template, and the template requirements.

  4. Expand the relevant category and select the option you want to view and update. The most common options are:
    Note

    If an option that you require is not available, speak to your Template Designer to add it to your template.

  5. Click Save.
Note

We recommend building and rendering a form to see how your changes are displayed to form users.

To remove a property from Form Options:

  1. Open a template in the Maestro editor.
  2. Select a component in the Design mode and click the Properties tab.
  3. Right click on Label and select Remove from Form Options. The property is removed from Form Options in the template.

Here are some notes on working with form options:

  • If you create a form option in the template, the form will have the ability to override the template, which can lead to inconsistencies between forms
  • If you remove a form option, this may or may not remove the property override from the form. Ideally you would want it to remove the override from the form, but the JSON may remain in the form and this required some manual updates.
  • You can not and should not add form options to components that exist within extension points - the form developer will already have a local copy of these components and will be able to make all the changes they need.

Next, learn how to change a form name.