> For the complete documentation index, see [llms.txt](https://arterm-sedov.gitbook.io/low-code-platform-help-excerpt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arterm-sedov.gitbook.io/low-code-platform-help-excerpt/forms.md).

# Forms

{% hint style="success" %}
**Definition**

A form is a web page designed to enter and display data. You can place fields (associated with attributes), static text, and visual elements on the form.
{% endhint %}

## Use the the Template's Form List

The list of forms is available for the record template, account template, role template, and organizational unit template.

{% hint style="info" %}
**Note**

In the process template, the form list is not available, and the forms are created and configured using the process diagram element properties.
{% endhint %}

1. Open a record template, account template, role template, or organizational unit template.
2. Go to the **Forms** tab.
3. The list of forms in the template opens.
4. Perform the following operations:
   * **Select** — to choose a form, select a checkbox in the first column.
   * **Open** — double-click a form row to [configure ](#configure-the-form)the existing form.
   * **Create** — [configure ](#configure-the-form)a new form.
   * **Delete** — select a form and click **Delete**. Confirm the form deletion.
   * **Set as default** — select a form and click **Default** to display the form by default when opening template records.
   * **Search** — click <img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FJFfpjIIF5cbgyJnDE24d%2Fimage.png?alt=media&amp;token=dc860490-af23-4559-b608-1a56daf3bcdb" alt="" data-size="line"> and enter keywords in the **Search** field. The rows containing the keywords will appear.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FS8j6nSmcMVDSnhjlv5HS%2Fform_list?alt=media" alt="Template form list"><figcaption><p>Template form list</p></figcaption></figure>

## Configure the Form

Use the form designer to configure its layout, properties, and elements.

1. Open the template's [form list](#viewing-the-template-form-list).
2. Click **Create** or double-click a form in the list.
3. The form designer appears with the following items:\
   \
   **(1) Elements pane** — drag the elements from the pane to the form: attributes, buttons, embedded forms, and visual elements. You can also edit and create elements [using the elements pane](#creating-an-attribute).\
   **(2) Form layout** — sets the form appearance.\
   **(3) Properties pane** — view and configure the selected element properties.\
   **(4) Buttons:**

   * **Save** — save the form.
   * **Clear** — remove all elements from the form layout.
   * **Clone** — create a form duplicate.
   * **Configure template** <img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2F6U8AuhO7jj0ZYlqx5q1K%2Fimage.png?alt=media&amp;token=ed8654ff-dd69-46f7-b15a-19858ecf40b9" alt="" data-size="line"> — go to the template **Properties** page.
   * **Relations** <img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FFPlj1IJaYJ1VENQ5MlIw%2F2023-07-16_16h51_08.png?alt=media&amp;token=1eb5ec12-68e8-4d0f-af60-19ab8877ebb0" alt="" data-size="line"> — view a list of application objects that use the form.

   <figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FjDNbfDuoti3kDp2M6HS7%2Fform_designer?alt=media" alt="Form designer"><figcaption></figcaption></figure>
4. To set the form properties, click an empty layout area and configure the properties using the properties pane:
   * **Display name** — a title that appears in the form heading when viewing template records.
   * **System name** — a unique name used to identify the form in scripts, expressions, and scenarios.
   * **Is default** — select this checkbox to display the form by default when opening template records.
   * **Type**:
     * **Public** — select this type to make the form accessible for viewing from the form selection dropdown next to the form title.
     * **Internal** — select this type to make the form visible only if it is embedded in another form, set as a record form, or opened via a direct URL (e.g., for process start, record creation, or dialogues).
5. Use the elements pane to:
   * Drag the [elements](#form-elements) from the elements pane to the form layout.
   * Click <img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FJFfpjIIF5cbgyJnDE24d%2Fimage.png?alt=media&amp;token=dc860490-af23-4559-b608-1a56daf3bcdb" alt="" data-size="line"> to search for elements.
   * Click <img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FGuWZg8zVIEm9NRqiegUf%2Fimage.png?alt=media&amp;token=f4b0bb0a-5e09-447f-a68c-3240efbae7cf" alt="" data-size="line"> to filter the element list by element type.
   * [Create](#creating-an-attribute) or [edit](#editing-an-attribute-button-or-form) attributes, buttons, and forms.
6. To set a form element properties, select it in the layout and configure the properties in the properties pane.
7. **Save** the form.
8. If needed, [configure the form rules](#editing-the-form).

### Form Elements <a href="#form-elements" id="form-elements"></a>

You can place the following elements on the form from the [elements pane](#configure-the-form):

* **Area** — contains all other form elements. Place any elements in an area. The form must have at least one area. There can be several areas on a form.
* **Tabs** — arrange form elements on several tabs.
* **Columns** — arrange elements in several columns.
* **Static text** — displays arbitrary text with HTML formatting.
* **Attribute field** — drag an attribute to the form layout to create a field associated with the attribute. Field properties correspond to the associated attribute type.
* **Embedded form** — drag another form to the form layout to embed it into the current form.
* **Button group** — combines buttons into a dropdown.
* **Button separator** — visually separates buttons within button areas.

{% hint style="info" %}
A **button area** is provided for each form and area. Place any **buttons**, **button groups**, or **button separators** in the button areas and not anywhere else on the form.
{% endhint %}

### Configure an Attribute, Button, or Embedded Form using the Elements Pane <a href="#creating-an-attribute" id="creating-an-attribute"></a>

#### Create an Attribute <a href="#creating-an-attribute" id="creating-an-attribute"></a>

1. In the elements pane:
   * To create an attribute in the current template, hover over the **Attributes** heading, or…
   * To create an attribute in the corresponding template, hover over the template name in the element list.
2. Click the **Add Attribute** button that appears.
3. The attribute properties window appears.
4. Configure and save the attribute.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2F2gxJ0YSviKw9geOd1IuO%2Fform_designer_create_attribute?alt=media" alt="Creating an attribute using the form designer"><figcaption><p>Creating an attribute using the elements pane</p></figcaption></figure>

#### Create a Button <a href="#creating-a-button" id="creating-a-button"></a>

1. In the elements pane, hover over the **Buttons** heading.
2. Click the **Add button** button that appears.
3. The [button designer](/low-code-platform-help-excerpt/buttons.md#opening-the-button-designer) appears.
4. Configure and save the button.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FAKDdouPx2v4ccJDmoSxJ%2Fform_designer_create_button?alt=media" alt="Creating a button in the form designer"><figcaption><p>Creating a button using the elements pane</p></figcaption></figure>

#### Edit an Attribute, Button, or Embedded Form <a href="#editing-an-attribute-button-or-form" id="editing-an-attribute-button-or-form"></a>

1. Hover the mouse pointer over an attribute, button, or form name in the elements pane.
2. Click the **Edit attribute**, **Edit button**, or **Edit form** button that appears.
3. The attribute properties window, button designer, or form designer appears.
4. Configure and save the element.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FoyO7xF2kcIDBU0fuNoIe%2Fform_designer_edit_form?alt=media" alt="Editing a form using the form designer"><figcaption><p>Editing an embedded form using the elements pane</p></figcaption></figure>

## Clone the Form <a href="#cloning-a-form" id="cloning-a-form"></a>

1. In the form designer, click **Clone**.
2. In the form cloning window, enter the form **name** and **system name**.
3. **Save** the cloned form.
4. The new form opens in the form designer.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2Fla5kayH1B3azx1obhfOB%2F2023-07-16_16h52_06.png?alt=media&amp;token=567009bc-8341-4fa9-8fb1-9b7ca67199e9" alt="Form cloning"><figcaption><p>Form cloning</p></figcaption></figure>

## Configure the Form Rules <a href="#editing-the-form-rules" id="editing-the-form-rules"></a>

1. In the form designer, click the selector button next to the form title.
2. Select **Form rules** from the dropdown.
3. The form rule designer opens.
4. Edit the form rules.
5. **Save** the form rules.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2Fw43T41vdLKZvBIeEBxwE%2Fform_designer_goto_form_rules?alt=media" alt="Form rules designer jump menu"><figcaption><p>Going to the form rules designer</p></figcaption></figure>
