Working with Custom Actions

Working with Custom Actions


Custom Actions lets application builders add named action buttons to any module/model or dashboard. Users can trigger workflows, update fields, navigate to related records, execute device commands, or open URLs directly from device views and dashboards.

Refer to the Understanding Custom Action document for more details on categories, action types, and placement slots.

Availability

All Custom Action operations require necessary permissions. Refer to Users and Profiles document for more details.

Check Feature Availability and Limits


Prerequisites

  1. If you plan to use the Execute Workflow action type, ensure that the workflow is created and active.
  2. If you plan to use Sigma extensions, ensure the extension are integrated in the application.
  3. If you plan to invoke Reports, Maps, etc. ensure that they are created and available.
  4. Ensure you have the required profile permissions to create custom actions.
 

Adding a Custom Action

Custom actions can be added to dashboards or modules in the application.

To add a custom action,
  1. In the end application,
    1. Click the Setup icon.
    2. In the Customization section, click Custom Actions
      (or)

In the developer application,
a. Click the Model tab > Devices.
b. Click on the model name for which you want to add the custom action.
c. Click Manage Actions > All Custom Actions tab,.



2. Click Add Custom Action in the top-right corner of the screen. The Add Custom Action panel is displayed.


 
3. In the Category field, select Modules or Dashboard.

 
 For Dashboard

a. Select Dashboard as category.
b. Enter a name for the action in the Custom Action Name field. 
          c. Enter a Description for the action (optional).

For Modules

a. Select Modules as category.
b. Choose the specific model from the Model/Module dropdown.


 
b. Enter a name for the action in the Custom Action Name field. 
c. Enter a Description for the action (optional). 

4. Select a Placement Slot.

In the Placement field, select the locations where the action button should appear. You can select multiple slots. At least one slot must be selected.

 
The following placement slots are available:

Refer to the Placement Slots section of the document for screenshots of the placement.

Placement Slots 
Description
List View — Utility Bar
Appears at the top-right of the list view. Applies to all rows.

Note: This placement is not supported in workflow action.

List View — Column Action
Appears in the Actions column for individual row in the list view.

Single Record — On Select
Appears in the record header toolbar when viewing a single device record.

Multiple Records — On Select
Appears in the selection toolbar when two or more records are checked.

Single Record — Details Page
Appears in the action area of the record's Details tab.

5. Select an Action Type.

In the Action field, select the action type. Each button is bound to one action type, which determines what happens when the user clicks the button.


* Open URL

Opens an external or internal URL when the button is clicked. Enter the URL in the URL field that appears. Select the Navigation mode — New Tab or Same Tab — to control how the URL is opened.


          * Open Sigma Extension

Triggers a Sigma extension when the button is clicked. This action is useful for launching custom functionalities built by developers.

 
* 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.



 
Here, you can select any Data Visualization modules or Modules.



* Execute Workflow

Notes
Note:
  1. The Trigger Workflow action type will not be available for Dashboard category of custom actions.
  2. Triggers a predefined workflow associated with the record. Select the workflow to execute from the dropdown that appears.
  3. Execute Workflow is available on Standard plans and above.
  4. Ensure the workflow is published and active before assigning it to a custom action.
  5. List View - Utility Bar placement is not available for workflow.

 

Configure the Confirmation Dialog

Use the Require Confirmation toggle to control whether a confirmation prompt appears before the action is executed. This helps prevent accidental triggers.
  1. Set the Confirmation toggle to ON or OFF. Available for all action types.
  2. When Require Confirmation is set to ON, the following fields are displayed:
    1. Confirmation Message — Enter the message to display to the user in the confirmation dialog.
    2. Confirm Button Label — Enter the label for the button that proceeds with the action.
    3. Cancel Button Label — Enter the label for the button that dismisses the dialog.

 
Set Profile Permissions

  1. In the Profile Permission field, select the user profiles that can use this custom action.
  2. Set the Status toggle to ON to activate the custom action immediately after saving.
  3. Click Add to save the custom action.
  4. The new custom action is created and appears in the Custom Actions list. It will be available to users in the selected placement slots based on their profile permissions.
  5. Once custom actions are configured, the Manage Actions page shows populated placement slots.
    Users can view, reorder, enable/disable, toggle, edit, and delete actions per placement slot.  

Viewing Custom Actions

To view Custom Actions,
  1. In the end application, click the Setup icon.
  2. In the Customization section, click Custom Actions. The list of custom actions created in the application is displayed in a list view.




Enabling/Disabling Custom Actions

To enable Custom Actions,
  1. In the end application, click the Setup icon.
  2. In the Customization section, click Custom Actions. The list of custom actions created in the application is displayed in a list view with the Status column indicating whether the custom action is active or inactive.
  3. Click on the custom action which you want to disable.
  4. Set the Status toggle to ON/OFF as required.



  5. Click Save. The status of the custom action will now be displayed as Inactive.


 
 

Reordering Custom Actions within a module

The custom action can be enabled/disabled from the Manage Actions page of the model. When there are two or more custom action buttons to be displayed for a model, there may be requirement to reorder the placement of buttons on the top of the list view.
 
For example, the custom action buttons View Details and View Device Location can be swapped.
 

To reorder the custom action buttons,
  1. In the end application, click on the model to which the custom actions to be reordered is associated.



  2. In the details page, click Manage Custom Actions in the left pane. The placement slots configured for the model is displayed.















3. Click on each placement slot to view the custom actions associated in the right pane.

Here, you can click and move the drag handle to rearrange the actions.

          4. Click Save.

Associating Custom Actions within a module

The custom actions available in the application can be associated to a module when required,

To associate a custom action,
  1. In the end application, click on the model to which the custom actions is to be associated.



  2. In the details page, click Manage Actions in the left pane. The placement slots configured for the model is displayed.

 

     4. Click on the placement slot to which you want to associate any custom action.
     5. Click on the Associate Custom Action button in the right pane.
         All custom actions created with the same model and not assigned to the particular placement slot will be displayed.

      6. Select the custom action, and click Associate.

 
The custom action will be associated to the placement slot for the model.
 

Deleting a Custom Action

Any custom action can be removed when it is no longer needed from the model or dashboard.

To delete Custom Actions,
  1. In the end application, click the Setup icon.
  2. In the Customization section, click Custom Actions. The list of custom actions created in the application is displayed in a list view.
  3. Click on the ellipsis next to the custom action you want to delete.


  4. Click the Delete option. The confirmation dialog is displayed.
  5. Click Yes.

See Also