Understanding Custom Actions
Custom Actions lets application builders add named action buttons to widgets or any module/model. Users can trigger workflows, update fields, navigate to related records, execute device commands, or open URLs directly from device views. There are two main categories based on which the button placement is done; Dashboard and Modules. And each button is linked to one of four action types.
Let's see in detail about the categories, actions types that can be configured for the action buttons, and their placement.
Categories
Dashboard
Select the Dashboard category to display a custom action button on a dashboard. After creating the button, add it to the dashboard using the Custom Button widget while creating or editing the dashboard. Each button can perform one of the following actions:
- Open a URL
- Open a module page, such as a data visualization module (Maps, Reports, etc.) or a list view (like Assets)
Sample Use case:
A facility manager wants a quick way to jump from the dashboard to the live Map view of all connected assets, instead of navigating through menus. A custom action of the Dashboard category type lets you add a button widget that opens the Map module directly from the dashboard.
A facility manager wants a quick way to jump from the dashboard to the live Map view of all connected assets, instead of navigating through menus. A custom action of the Dashboard category type lets you add a button widget that opens the Map module directly from the dashboard.
For this, you need to create a custom action with category as Dashboard and module as Maps to invoke a live asset map. Learn More
Module
Module custom buttons appear in multiple slots on the respective module or model page. Each button can do one of the following:
- Open a URL
- Open a module page, such as a data visualization module (Maps, Reports, etc.) or an Assets view (any tab)
- Trigger a workflow
Sample Use Case 1:
A technician viewing an Asset record wants to quickly trigger a maintenance workflow without leaving the page. A custom action of the Module category type lets you add a button on the Asset module page that triggers this workflow directly.
For this, you need to create a custom action with category as module and asset, and workflow as action type. Learn More
A technician viewing an Asset record wants to quickly trigger a maintenance workflow without leaving the page. A custom action of the Module category type lets you add a button on the Asset module page that triggers this workflow directly.
For this, you need to create a custom action with category as module and asset, and workflow as action type. Learn More
Sample Use Case 2:
A building operator viewing an Energy Meter record wants to quickly check its consumption trends without manually searching in Reports. A custom action of the Module category type, created for the Energy Meter model, lets you add a button that opens the relevant Report directly from the Energy Meter page.
For this, you need to create a custom action with category as module and action type as module and reports. Learn More
A building operator viewing an Energy Meter record wants to quickly check its consumption trends without manually searching in Reports. A custom action of the Module category type, created for the Energy Meter model, lets you add a button that opens the relevant Report directly from the Energy Meter page.
For this, you need to create a custom action with category as module and action type as module and reports. Learn More
Action Types
Each custom action button is bound to one of the following action types. The action type determines what happens when the user clicks the configured action button.
Open Module Page
Navigates the user to a specified module or model page within the end application. Use this action to link related records or guide users to relevant sections.
Open Sigma Extension
Triggers a Sigma extension when the button is clicked. This action is useful for launching custom functionalities built by developers.
Open URL
Opens an external or internal URL when the button is clicked. This action is useful for linking to dashboards, documentation, or third-party tools.
Execute Workflow
Triggers a predefined workflow associated with the record. This action type is available on Standard plans and above.
Note
- Execute Workflow is restricted to Standard plans and above.
- Ensure the workflow is published and active before assigning it to a custom action button.
Action Button Placement Slots
Custom action buttons can be placed in six different locations within the end application. Each placement slot determines where and when the button is visible to the user.
List View — Utility Bar
Top-right of the list view. Applies to all rows.
List View — Column Action
In the Actions column for each individual row in the list view.
Single Record — On Select
In the record header toolbar when viewing a single device record.
Multiple Records — On Select
In the selection toolbar when two or more records are checked.
Single Record — Details Page
In the action area of the record's Details tab
Confirmation Dialog
Confirmation dialog can be configured for any custom action button. When enabled, users see a prompt before the action is executed. This helps prevent accidental triggers.
See Also
Working with Custom Actions