Action Buttons
Action Buttons let you configure custom operations for your collection. You can define button properties, action types, and access control.
Go to Areas → General, click the gear icon on a collection, then open any tab and click Add Actionable Button.
Create an action button
When you click Add Actionable Button, a modal appears where you can configure the button.
Button configuration
| Setting | Description |
|---|---|
| Button Display | How the button is shown (for example, Label & Icon). |
| Button Text | The label displayed on the button. |
| Icon | The icon displayed alongside the text. Click Add Icon to select. |
| Button Type | Visual style (for example, Primary, Secondary, Success, Warning, Danger, Info). |
Action configuration
Action scope
Choose where the button appears:
- Entity Action: Appears on each individual record.
- Bulk Action: Appears when multiple records are selected.
- General Action: Appears in the toolbar or header of the view.
Action type
The available action types depend on the selected Action Scope:
| Action scope | Available action types |
|---|---|
| Entity Action | Update, Delete, Print |
| Bulk Action | Update, Delete, Export, Print |
| General Action | Add, Export, Import, Print |
Endpoint configuration
| Setting | Description |
|---|---|
| Endpoint Name | A unique identifier for the endpoint (for example, create-user). Use lowercase with dashes. |
Confirmation popup
| Setting | Description |
|---|---|
| Customize Confirmation | Turn on to override the default confirmation message with a custom one. |
When enabled, you can configure:
- Popup Title: The title text displayed in the confirmation dialog.
- Popup Description: Additional context shown below the title.
- Accept Button Label: Text for the confirm button. Defaults to "Accept".
- Reject Button Label: Text for the cancel button. Defaults to "Reject".
Access control
Control who can see and use the action button.
| Setting | Description |
|---|---|
| Inherit Access Control | When enabled, the button uses the parent collection's ACL settings. When disabled, you can define custom access rules. |
| Auth Collection | The collection used for authentication. Only shown when Inherit Access Control is disabled. |
| Roles | Select which roles can access this button. Only shown when Inherit Access Control is disabled. Requires selecting an Auth Collection first. |
Button visibility
For Entity Actions, you can conditionally show or hide the button based on record values.
| Setting | Description |
|---|---|
| Conditional Visibility | When disabled, the button is always visible. When enabled, the button only appears when specified conditions are met. |
When Conditional Visibility is enabled, configure visibility conditions:
| Column | Description |
|---|---|
| Conjunction | WHERE for the first condition, AND or OR for additional conditions. |
| Field | The collection field to evaluate. |
| Operator | Comparison operator (Equal, Not Equal, Greater Than, Less Than, etc.). |
| Value | The value to compare against. |
Value input controls
| Control | Name | Description |
|---|---|---|
| Session Field | Use a value from the logged-in user's session data. |
Field mapping
Configure how data is passed to the action endpoint and how fields are displayed.
| Setting | Description |
|---|---|
| Collection | The target collection for the action. |
| Use Current Collection | When enabled, automatically maps to the current collection's fields. |
Click + Add Field to add a new mapping rule.
| Column | Description |
|---|---|
| Field | The field in the target collection. |
| Value | The value to pass to the target field. |
| Required | Toggle whether the field is required for the action. |
| Visible | Toggle whether the field is visible in the action modal. |
Value input controls
Beside the Value input, use these icons to map dynamic values:
- Session Field: Use a value from the logged-in user's session data.
- Collection Field: Map a field from the current collection.
Where clause
Turn on Where Clause to add conditions that filter the related data for the action.
When enabled, a condition table appears:
| Column | Description |
|---|---|
| Conjunction | WHERE for the first condition, AND or OR for additional conditions. |
| Field | The field to evaluate. |
| Operator | Comparison operator (for example, is equal to). |
| Value | The value to compare against. |
Value input controls
Beside the Value input, use these icons to map dynamic values:
- Session Field: Use a value from the logged-in user's session data.
- Collection Field: Map a field from the current collection.
Click Add Condition to add multiple rules.