Create buttons, toggles, and more of your Linux device fleet. Custom Actions allow users to bind scripts to components, creating a customizable console experience.
In this article:
Creating a Custom Action
Go to your Profile and select Custom Actions from the dropdown.
The click on Create custom Component.
From the left side panel, drag and drop the component into the main interface.
The component will be placed in the middle and a settings menu will appear on the right side of the screen.
In the properties menu, apply contextual information about the component.
In the script menu, apply the script(s) that will execute through the component.
On the location tab, choose the location for the component.
- Button: Buttons will appear in the device’s Settings tab.
- Toggle: Toggles will appear in the selected blueprint location.
- Dropdown: Dropdowns appear in the selected blueprint location.
- Radio: Radio buttons will appear in the selected blueprint location.
After inputting the information, save the action.
Then, select its activation status.
- Save as Draft: The action will be saved, but won’t yet appear in its desired location.
- Save and Activate: The action will be saved, and it will appear in its desired location. Activated actions are ready to be used.
After it’s saved, you can activate or deactivate it from the custom Actions directory.
You’ll see the custom action in the desired location.
Device Setting
Go to the device in Devices & Groups and click on its Settings tab to see a list of the active custom actions.
Blueprint Settings
Go to a blueprint and go to the desired section’s Linux tab to see a list of active custom actions.
By default, custom actions are disabled and set to ignore, meaning they won’t activate on the device until they are set to a Provision Only or Always Apply setting and the device is converged to the blueprint.
About Components
A component is the UI element associated with the action. For example, a reboot script could be tied to a button. The button would function as the component in this case.
Requirements
Each component has certain properties, script, and location requirements associated with it. This table breaks down each requirement by component type.
| Component | Properties | Script Requirements | Location |
| Button |
Required:
Optional:
|
One script | Device Settings |
| Toggle |
Required:
Optional:
|
Two script blocks
|
Device Settings Blueprints 1. Apps & Configuration 2. Connectivity 3.Device Security 3. Display & Branding 4. Esper Settings 5. Files 6. Hardware Settings 7. Platform Services 8. Sound 9. System Updates 10. Time & Date |
| Dropdown |
Required:
Optional:
|
Minimum: two script blocks Maximum: five script blocks
|
Device Settings Blueprints 1. Apps & Configuration 2. Connectivity 3.Device Security 3. Display & Branding 4. Esper Settings 5. Files 6. Hardware Settings 7. Platform Services 8. Sound 9. System Updates 10. Time & Date |
| Radio |
Required:
Optional:
|
Minimum: two script blocks Maximum: three script blocks
|
Device Settings Blueprints 1. Apps & Configuration 2. Connectivity 3.Device Security 3. Display & Branding 4. Esper Settings 5. Files 6. Hardware Settings 7. Platform Services 8. Sound 9. System Updates 10. Time & Date |
States
Actions have the following states: Active, Deactivated, and Draft.
| Status | Description | Can be edited? |
| Active | When a custom action is active, it can be enabled or activated through a blueprint or device setting. | No |
| Deactivativated | This means the custom action is no longer active. It cannot be enabled through a blueprint or device setting. | Yes |
| Draft | Drafts of custom actions cannot be enabled through a blueprint or device setting. | Yes |
Editing, Deleting, or Renaming a Custom Action
You can rename a custom action by clicking on its ellipsis menu in Custom Actions. Then select Rename.
To edit or delete a custom action, you’ll first need to deactivate it. In Custom Actions, click on the action’s ellipsis (...) and select Deactivate.
After deactivation, the action will no longer appear in a blueprint or on the device’s settings page. The edit and delete options will also become available.
After deletion, you won’t be able to access any scripts associated with the Smart Action. We recommend saving the script(s) before deleting the Custom Action.
Use custom actions to tie repetitive tasks to device or blueprint actions.