Role required: admin. |
Configuring form layouts allows administrators to change the form views for the various business tasks. Creating separate form views with sets of fields and widgets is useful for different processes or user roles.
Use form layouts to create and configure the view of the tables. Use Client Scripts to change form field visibility dynamically dependent on user roles, fields state or form state (inserting/updating). |
Form view displays the elements in the order below:
widget instances
Refer to the Add widgets to a form article to learn more. |
The Default section is displayed first. |
Every SimpleOne system table has a Default form view that administrators can configure using the form layout features.
To change a form layout, follow the steps below:
To configure the Related Lists displayed on the form, in the hamburger menu |
In SimpleOne, you can create separate form views with sets of fields for different processes or user roles. The system stores all the list and form views created along with their layout elements as table records. See List and form elements to learn more. |
To create a separate view, please complete the steps below:
If you leave the configure menu without clicking the Save button, then the pop-up window will appear. Click OK to save changes or click Cancel to discard them. |
Please note that when a new form view is created, it is empty by default.
Also, please note that the Preview view name is reserved for the record preview form. This form looks like this:
Refer to the Customizing portal and agent views article to learn how to change the set of displayed fields. |
Example
You have created a Preview form for the Timezone table and added some fields like shown in the screenshot above (these are the Title, Name, UTC Offset, Active, and Updated at fields). And by clicking on the field referenced to the Timezone table on other forms (for example, User, Employee, Schedule, and so on), the timezone record Preview form appears.
Sections are needed for separating the fields in a sensible and visual way.
The Default section displays the table fields grouped on the main area of the form (in the Section menu, this option is always on top of the sections list). Custom sections display a set of fields in separate tabs in the bottom of the form above the Related Lists.
The Available layout area contains all the table fields that can be embedded in the form by adding them to the Selected layout area. Move elements by drag-and-dropping or using the
|
To create a new section and fill it with fields, follow the steps below:
If you leave the configure menu without clicking the Save button, then the pop-up window will appear. Click OK to save changes or click Cancel to discard them. |
Your newly created section is displayed on the form.
You can change sections order by drag-and-dropping them in the Section menu or clicking |
You can configure how fields and widgets are placed on the form
Refer to the Add widgets to a form article to learn more. |
. By default, they go from top to bottom in one col umn. Begin split and End split are not necessary for a form layout organized in one column. If you need to rearrange them in two or more columns, you can use splitters for this.
To split the fields into columns, follow the steps below:
Click Begin split to add the |-begin-split-| element to the Selected layout area. Move this element to specify where the split area starts.
Click Split to add the |-split-| element to the Selected layout area. Move this element between |-begin-split-| and |-end-split-| to set the place where a column ends.
If you leave the configure menu without clicking the Save button, then the pop-up window will appear. Click OK to save changes or click Cancel to discard them. |
If you omit the |-begin-split-| element, all fields above the |-split-| element will be considered the rightmost column in the Selected layout area (as if there is a |-begin-split-| element above them). Please note that the |-begin-split-| element is obligatory for nested splittings. |
The splitters appear at the bottom of the Selected layout area if no fields are highlighted. If a field is highlighted, the split element appears right after it. Drag-and-drop or using the |
In the example below, the form is divided into two columns:
Within the second column there is an nested splitting with two columns:
In the following example, we examine a case of creating a complex form layout. Dashed lines in the screenshots below represent the |-split-| element.
Basic layout structure is the following:
|
It is easier to grasp the idea if you imagine every separate block of columns as boxes which sides are the |-begin_split-| and the |-end_split-| elements. So, basically you put boxes inside other boxes. |
You can create unlimited number of columns or divide columns within other columns as in the picture below. A complex form layout is broken into component parts. You can use this scheme to create your own complex layout.
The form consists of 4 field groups: Blue, Red, Green, and Purple. The Blue group divides the form layout into 2 general columns. This is the basis of our form layout. To recreate this form, perform the following steps:
|
Field 1
Field 2
Field 5
Field 8
Field 9
Field 11
Field 13
|
Related lists appear at the bottom of the forms and show records in tables that have relationships with the current record. For example, on the change User form, related lists can display approval User Role lists; on the Task form, they can display SLA indicators with the relevant values, and so on, depending on the business needs.
To configure related lists, complete the steps below:
You can add or remove related lists the same way as the fields.
|
In SimpleOne, apart from regular related lists, there are also scripted relationships implemented too. Unlike the related lists, scripted relationships use scripts to query to the related tables.
To learn more about how to configure a scripted relationship, please refer to the Scripted Related Lists article.
The VCS record form aggregates all the elements of the form related to it: UI form element (sys_ui_form_element), Form section (sys_ui_form_section), Related list (sys_ui_related_list), and Related list element (sys_ui_related_list_element). They are stored in the JSON (Copy) field.
See a scheme content of a VCS record below:
VCS Record
|
A JSON (copy) field stores the data about all the related elements in the following way:
|