Form basics

Create user-facing forms, such as the app settings forms, from a YAML definition. You define the fields, buttons, drop-down lists, rules for when to display or hide certain fields, field validation, and so on, and Optimizely Connect Platform (OCP) generates and displays the form to app users.

App settings forms are divided into sections, where users view and complete one section at a time, but can switch between the sections as desired.

The first section expands by default, while each subsequent section remains collapsed. When users expand a section, the other sections automatically collapse. Use sections to organize your configuration options and use the visible option to control when to show or hide the section from the user. For example

This form only displays the Import Lists section after the user has completed the Login and the app has set the login.successful property to true. You can use visibility to enforce a workflow much like a wizard.

Sections contain one or more form elements or input fields. Each field has the following required properties:

Apps need a settings form, whether to display instructions to the user or to collect information such as credentials and configuration options. Your settings form is defined in the src/forms/settings.yml file. If you initialized your app using the OCP CLI, you have a placeholder form.

A simple authentication form might look like the following:

This example form displays an Account text box for account entry, a Secret password field for the secret entry, and an Authenticate button that the user clicks to submit the form data.

The form definition can automate data validation. The simplest way to ensure the user enters valid data into your form is to add regular expression (regex) validations. All fields support a list of regex validations, so you can add one or more validations, each with its own error message.

In this case, if the user leaves the account ID field blank, when they attempt to save the form, a message indicating the field is required is displayed following the field (required: true). If the entered value does not look like regex: "^a\\d+$|^.+@.+\\..{2,}$", then a message explaining what the account ID should look like is displayed. You can define multiple validations which are evaluated in order, and all failing validation messages are displayed.

Validations can be more complicated and reference data in other sections of the form. For more advanced use cases, see Form Validation.

You can display or hide any form element, including fields and buttons, using the disabled or visible properties. This lets you manage the user flow of setting up the integration with your app. For example, the following form has a Login text field and two different secret fields, depending on what type of authentication the user needs:

If the user completes the Login field with an account ID, such as a012345, the API Secret field becomes visible as soon as the regex matches an account ID (it does not wait for the user to submit the form).

Alternatively, if the user enters their email address for the Login field, the Passcode field becomes visible.

Finally, the Authenticate button to submit the form is disabled until the user types anything into the Login field. This way, the user can type an invalid login value, submit the form, and receive errors directing them to enter a valid account ID or email.

For more information, see Advanced predicates.

In addition to dynamically showing and hiding sections and elements, you can insert dynamic values into certain visible attributes of your form elements using the Mustache templating language. This means you can display a code or change a URL in the content you display to the user depending on what form data they have submitted or dynamic properties set by your app.

The following form element attributes support Mustache templating: label, help, text, and href.