Overview
Automation Buttons let users start an automation directly from a record details page. Admins place buttons on the record layout and configure which automation runs when the button is pressed. Users see a clear running state, success or failure message, and can provide required inputs via a form when the automation needs them. Key Capabilities:- Buttons on Record Layout - Admins add buttons to the record details layout with a label, button text, and icon
- Run Any Automation - Each button runs a chosen automation; the automation can be from the same aspect or a different one
- Optional Conditions and Inputs - Configure when the button can be pressed (e.g. based on record data) and which inputs are required; a form is presented to gather inputs before the automation runs
- Clear Feedback - Success and failure messages when the automation completes; running status is shown while the automation is in progress
- One Run at a Time - The user cannot trigger the same automation again until the current run finishes
Adding and Configuring Buttons (Admin)
Admins configure automation buttons in the record details layout. Buttons are placed on the layout and then configured with appearance and behavior. To access: Navigate to your app’s Configuration and open the Record Details Layout (or equivalent layout builder). See Layout Builder for how to work with layouts.Button Appearance
When adding an automation button to the layout, you can set:| Property | Description |
|---|---|
| Label | Administrative label for the button (e.g. for layout organization) |
| Button Text | Text shown on the button to users |
| Icon | Optional icon displayed with the button |
Choosing the Automation
Select the automation that runs when the button is pressed. You can choose an automation associated with the current aspect (app or element) or an automation from a different aspect. The automation runs in the context of the current record when the user clicks the button.When the Button Can Be Pressed
The button can be available at any time, or you can configure visibility or eligibility based on record data (e.g. only when a status field has a certain value). When the automation requires input values, those can be marked as required; the user will see a form to provide them before the automation runs.User Experience
When a user opens a record that has an automation button:- Click the button - The button appears on the record details page where the admin placed it.
- Provide inputs (if required) - If the automation needs inputs, a form is presented. The user fills the required fields and submits.
- Running state - While the automation runs, a running status is shown. The user cannot trigger the automation again until the run completes.
- Completion - When the automation finishes, a success message is shown on success or a failure message on failure.
Only one run can be in progress at a time for a given button invocation. The button becomes available again after the automation completes (success or failure).
Behavior
- Single run per invocation - Until the current run completes, the user cannot start another run from the same button. This avoids duplicate submissions and keeps feedback clear.
Best Practices
- Use short, clear button text so users understand the action
- Choose automations that make sense in the context of the record (e.g. “Send for approval”, “Generate report”)
- Configure required inputs only when the automation needs them; avoid unnecessary form steps
- Test the button as an end user to confirm the form, running state, and success or failure messages behave as expected
Setup Guide
Prerequisites
Before setting up automation buttons, ensure you have:- App Admin access (or equivalent) to edit the app and its record details layout
- An automation to run from the button (from this app or another aspect). See Automation System to create automations
- Familiarity with the Layout Builder for placing the button on the layout
Step-by-Step Configuration
Open the Record Details Layout
- Navigate to your app
- Open Configuration (or App settings)
- Open the Record Details Layout (or the layout where you want the button to appear)
Add an Automation Button to the Layout
- In the layout builder, go to the area where you can add buttons or components
- Add an Automation (or Run automation) button to the layout
- Place it in the section where you want it to appear for users
Set Button Label, Text, and Icon
- Open the button configuration
- Enter a Label (for your reference in the layout)
- Set the Button Text that users will see (e.g. “Send for approval”, “Generate report”)
- Optionally select an Icon for the button
Select the Automation
- In the button configuration, choose the Automation that runs when the button is pressed
- You can select an automation from the current aspect or from a different aspect (e.g. another app or element)
- The automation will run in the context of the record when the user clicks the button
Configure When the Button Is Available and Required Inputs
- If needed, configure when the button can be pressed (e.g. based on record data such as status)
- If the automation requires inputs, configure required inputs; a form will be shown to the user to collect these before the automation runs
- Save the button configuration
Troubleshooting
Button does not appear on the record
Button does not appear on the record
Automation does not run when the button is clicked
Automation does not run when the button is clicked
Form not shown or wrong inputs requested
Form not shown or wrong inputs requested
Check:
- The button configuration specifies which inputs are required for the automation
- The automation trigger or steps expect the inputs you configured
- If you need to change required inputs, edit the button configuration in the layout and update the automation if needed