General Configuration
General configuration is the primary hub for defining an Area's identity, authentication boundaries, and the data it manages. This is where you determine which roles can access the area and which collections are visible to them.
Go to Areas in the top navigation, then select an Area or click Add... to create one.
Creating an area
Follow these steps to set up a new logical workspace for your project:
- Go to Areas in the top navigation.
- Click the Add... button at the bottom of the left sidebar.
- In the Create a new Area modal, provide a unique Name for the area.
- Select the Auth Collections and authorized Roles.
- Confirm the Status toggle is turned on.
- Click Save Changes.
Area configuration
Define the fundamental properties and access rules for the area.
| Setting | Description |
|---|---|
| Name | The display name of the area. Appears in the navigation and workspace selectors. |
| Auth Collections | The collections that serve as authentication sources for this area (for example, Users or Staff). Supports multiple selections. |
| Roles | The roles authorized to access this area. Available roles depend on the selected Auth Collections. Supports multiple selections. |
| Status | Enable or disable the entire area. Disabled areas are inaccessible to all users. |
Default area
You can set an Area as the default for your project by clicking the Set Default button in the Area Configuration panel. This button is only visible if the area is not already set as the default.
- The default area is marked with a Default badge in the left sidebar list of areas.
- Setting a default area determines where users are directed when they access the project root or after login.
Collections management
The Collections Management table lets you control exactly which data models are available within this specific Area.
Including collections
Select the checkbox next to any collection name to include it in the Area. Included collections are accessible based on the defined permissions.
Relational collections
The Relational Collections tool helps you identify dependencies that must be resolved for a stable deployment.
| Control | Name | Description |
|---|---|---|
| Relational Viewer | Opens a popup showing all collections related via Foreign Keys or associations. |
- Total Count: Shows how many collections are related to the selected item.
- Required: Lists collections that must be included for this collection to function correctly.
If you enable a collection, you must also enable all its related collections and ensure the assigned Roles have at least Select access to them. Failure to resolve these dependencies will result in errors during Generate Code or cause the project to fail during Publish.
Collection configuration
Use the configuration panel to fine-tune how data is presented and interacted with within this Area.
| Control | Name | Description |
|---|---|---|
| Configuration | Opens advanced settings for List View, Forms, Detail View, and Select Data. |
The configuration panel is divided into:
- List View: Set columns, filters, and display settings for tables.
- Forms: Customize create and edit experiences.
- Detail View: Organize how individual records are viewed.
- Select Data: Define data loading and fetching behavior.
See Collection Configuration for detailed settings.
Related
See these pages for related area configuration:
- Areas overview — Overview of all area configuration options
- Roles and permissions — Manage roles used in auth collections