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.
Creating an Area
Follow these steps to set up a new logical workspace for your project:
- Navigate 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.
- Ensure the Status toggle is enabled.
- Click Save Changes.
Area Configuration
Define the fundamental properties and access rules for the area.
View all settings
| Setting | Description |
|---|---|
| Name | The display name of the area. This appears in the navigation and workspace selectors. |
| Auth Collections | The collections that serve as authentication sources for this area (e.g., 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 | A toggle to enable or disable the entire area. Disabled areas are inaccessible to all users. |
Collections Management
The Collections Management table allows you to control exactly which data models are available within this specific Area.
Including Collections
Toggle the checkbox next to any collection name to include it in the Area. Included collections will be 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 tool 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 interface is divided into:
- List View: Configure 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.