Skip to main content
Skip table of contents

Layouts

What are Layouts?

Layouts is a feature that allows users to define and customize the arrangement of elements visible on a page.

Let's understand the benefits of layouts with an example.

Maria is a member of the Admissions team. As Admissions, it is crucial for Maria to see and access all the personal details for the students including medical conditions, pre-entry tests. students' contacts etc. However, Luis, a member of the Marketing team, will find most of this information irrelevant and distracting. Luis does not need to see every single field from the student personal details, but Maria does. So, how can you display the student details in a different way to two different type of users/audience? Yes, with Layouts. You can create one layout for Admissions with all the fields for the students, and another Layout for Marketing with a significant reduced amount of fields. 

Each object has default Layout that is created by the system, and it cannot be modified/deleted.

Custom layouts depend on the object and not all objects allow custom layouts. Also, custom layouts is a feature that is not included in all subscription plans. Contact your system administrator for details.

Create a Layout

Permissions Required
  • Utilities > Objects Manager > View Objects

  • Utilities > Objects Manager > Edit Objects

The number of layouts that can be created depends on your subscription plan.

  1. From the Utilities menu, go to Object Manager.

  2. Click on the object that you intend to create a layout for.

  3. Click Layouts.

  4. Click New Layout at the top right.

  5. Enter the details and then click Create.

Layout Builder

Permissions Required
  • Utilities > Objects Manager > View Objects

  • Utilities > Objects Manager > Edit Objects

A layout is made up of multiple elements. These elements determine how the page will look like and what fields and components it will have. Be aware that the fields and components are based on the object that the layout is for.

The elements that make up a layout are:

  • Containers - Containers serve as literal containers to wrap the fields. There are different types:

    • Sections: A section is a container for rows. Each section can have a title and will display as a group of rows on the layout.

    • Rows: A row is literally a row of fields. It determines how many fields can be on a row. A row must be inserted within a section.

  • Fields – These are the fields that you can insert into inputs within a row. The * indicates that a value is required for the field (if present in the layout) to create a record. The blue circle indicates that the field must be present in the layout.

  • Elements – An element refers to any non-data field item that can be added to a layout, such as static text. It is useful for displaying simple elements like short consent wordings or other similar components on the user interface, regardless of the data fields.

  • Components – Components consist of pre-made, specialised elements that can be used within the context of a particular object. These components have special logic and elements such as tables.

A component requires a full row with one input space

Follow these steps to customise a layout.

  1. From the layout details page, click on Layout Builder at the top right.

  2. You must declare sections and rows for fields first. Click containers and drag and drop a section to the canvas.

  3. Enter a title for the section.

  4. Now, drag and drop Rows in the section you just created. Select the row type according to the number of fields you need in the row.

  5. Now, you can insert fields to the layout. Drag and drop Fields, Elements or Components to the inputs. The red asterisk indicates the field is required when creating or updating a record. The blue circle indicates that it must be inserted in the layout.

  6. To see the preview of the layout, click on Preview.

  7. When it’s ready, Click Save to finish.

Assign Layouts 

Permissions Required
  • Utilities > Objects Manager > View Objects

  • Utilities > Objects Manager > Edit Objects

For users to benefit from custom layouts, it is required that the layouts are assigned to the profiles for the users. By doing so, each profile can be tailored to view and interact with the relevant fields needed for specific tasks.

Before Assigning a layout to a profile, you need to create a Profile. See this article: Users: Profiles.

  1. From the layout detail page, click on Layout Assignment.

  2. Locate the profile that you intend to assign to a layout to.

  3. Select the layout you want to assign. If no layout is selected, the default layout will be displayed to the respective profile.

  4. Click Save to apply.

Update Layouts 

Permissions Required
  • Utilities > Objects Manager > View Objects

  • Utilities > Objects Manager > Edit Objects

  • Updating the layout schema.

    1. From the layout detail, click Layout Builder.

    2. Follow the steps for the Layout Builder above.

  • Updating the layout details.

    1. From the layout details page, click Edit.

    2. Update the details as you need.

    3. Click Save to finish.

Delete Layouts 

Permissions Required
  • Utilities > Objects Manager > View Objects

  • Utilities > Objects Manager > Edit Objects

Once a layout is deleted, the profile associated with that layout will automatically revert to the Default layout.

  1. From the layout detail, click Delete.

  2. Confirm.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.