Create, enable, and delete forms

RoSmith

Page builders can create forms that enable end users to add new list items and their properties to a list. 

 

A form can be enabled for any worksheet that's linked to the model where the list resides. Once enabled, it can be accessed from that worksheet and used to add new list items.

 

For example, if you have a Sales model that includes a Products list, you may want an end user to be able to add a product to that list. As a page builder, you can create a form that enables users to add the new product to the list.

The form can include fields for the list item properties, such as a free-text code field, in which users can enter a code to uniquely identify a list item. For example, a product code or employee number

 

Forms that you create for non-numbered lists will always include a Name field. It's best practice to always add a code field, where possible.

 

You can choose to include a display name field when creating a form for a numbered list, but this is optional.

 

On this page

• Create a form
• Edit the Toolbar label
• Enable or disable a form
• Delete a form

Create a form

Navigate to Form designer

Use Form designer, in Edit Toolbar actions, to create a form. Once created, it can be enabled or disabled for any worksheet in the app.

 

To access the Form designer:

1. Go to the app where you want to create the form.
2. Open a worksheet that is linked to the model where the list resides.  
3. Click the pencil icon in the top right-hand corner to enter designer mode.
4. Click Edit toolbar actions.
5. Go to the Forms tab.
6. Click the Create a form button.
   The Form designer dialog displays. 

Create a Form

When you create a form, you select the list you want to add items to.

 

Lists are organised into hierarchies to enable data from child items to roll up to a parent item. For example, a city is a child of a country, and a country is a child of a region. You have the option of selecting a parent item for the items the form creates, or you can allow the user to select the parent item when they complete the form.

 

Note: If the list is part of a composite list, you can only choose a parent item that is in the parent list of the list the form belongs to. For example, a composite list might combine a Cities list and a Countries list — you can't select a city as a parent for another city; you can only select a parent from the countries list..

 

In Form designer, use the Edit form content menu on the left-hand side to select the input fields to include in your form:

1. Enter a name for the form in the Form title field.
2. Choose the list you want to add items to, from the Choose list dropdown.
   A preview displays.
3. Toggle properties to select the fields you want to display in the form.
   Note: Read-only properties display as properties in Form designer, but they will not display in the form when toggled on.
4. Toggle Allow user to choose a parent to determine whether end users can assign parents to list items:
   a. Toggle on to allow the user to select a parent item when they complete the form.

b. Toggle off to display a dropdown and select a parent item — the parent item will be fixed and the user will not be able to select a different parent item.

If you toggle off Allow user to choose parent, but do not select a parent, any item added using the form is created as an orphan. 

If the list is part of a composite list, all items in the composite list will display in the Parent dropdown. However, you will only be able to create the form if you select an item that is in the parent list of the list the form belongs to.

5. Click Create.

This creates your form and returns you to the Edit toolbar actions dialog. The form is automatically enabled for your page.

 

Publish a form

The form must be enabled on a worksheet to be visible to end users, and then the worksheet must be published.

 

To make the form available for users:

1. Click Apply.
2. Click Publish.
   The form is visible to end users.

 

Edit the Toolbar label

The Toolbar label is the name for the form that users will see when they select it from the toolbar.

 

It is generated automatically from the name that you enter in the Name field when you create the form. However, you can change this to something else, if you want the name and the toolbar label to be different.

 

Be aware, the Toolbar label cannot have any icons or special characters.

 

To edit the Toolbar label for a form:

1. In a worksheet, click Edit toolbar actions.
2. Go to the Forms tab.
3. Locate the Toolbar label field for the form you wish to edit.
4. Amend the text in the Toolbar label field.
5. Click Apply.
6. Click Publish

Enable or disable a form

To make a form available to end users on a specific worksheet, you need to enable it for that page. You can also disable a form to make it invisible on a worksheet without deleting it from the model.

 

A form is automatically enabled for the page on which it is created and disabled for all other pages, but you can change this at any time.

 

To enable or disable a form:

1. Click the pencil icon in the top right-hand corner of the worksheet to enter designer mode.
2. Click Edit toolbar actions.
3. Select the Forms tab.
   All the forms available within that model are displayed.
4. Toggle Enable on or off to enable or disable the form for that page.

4.    Click Apply.

5.    Click Publish.

 

Delete a form

You can delete a form by accessing the Edit toolbar actions dialog in any worksheet of the app that contains the form.

 

Warning: When a form is deleted it is removed from all pages in all apps that link to the model where the list resides. This includes forms that are enabled and in use. If you only want to remove it from a specific worksheet or board, disable the form for those pages instead.

 

To delete a form:

1. Go to the Forms tab.
2. Click the trash can icon next to the name of the form you want to delete.
   A confirmation dialog displays.
3. Click the tick to confirm that you want to delete the form or click the cross to cancel the action.