In this guide we will cover:
– What is a Custom Button?
– Creating an Asset Custom Button
– Restricting Visibility (v2.182.1+)
Admin Guides:
Related Guides:
What is a Custom Button?
Custom buttons are a way of adding your own functionality into areas of Halo. They can be used to open a URL link or start a runbook, and will appear along the top row of the entity they are added to. The open URL could be used to quickly view the documentation/instructional manual or the supplier's website for support for instance. Runbooks have many use cases, but an example here might be to open a variable endpoint for that specific asset to a remote support application.
Creating an Asset Custom Button
In Configuration > Custom Objects > Custom Buttons, first change the entity in the top left to "Asset" by clicking on the arrow and then selecting it from the dropdown.
Now click the "New" button in the top right to create a button.
Fig 1. Selecting the asset entity.
You will then see the following screen.
- Button Name – Description of the button. This can be anything you choose and is purely used to identify the button in the config list.
- Button Label – Text that will appear on the button itself.
- Button Icon – Icon that will appear next to the text on the button.
- Button Use – Selecting whether the button will open a link or start a runbook.
- Sequence in lists – Defines the order of the buttons both in the list and the order they appear in the entity.
- URL – URL that the button will open.
- Open in New Tab – Defines whether clicking the button opens the URL on in the same browser window, or in a new tab.
- Integration Runbook – Selecting which runbook to run.
In this example, the button will open the Halo website in a new tab.
Fig 2. Custom button configuration.
Upon saving, the button will appear on assets. Despite the sequence, the system buttons will remain in their designated places either side.
Fig 3. Custom button on an asset.
Restricting Visibility (v2.182.1+)
Visibility of custom action buttons can be restricted with agent permissions. In the agent profile > Permissions tab > Custom Button Restrictions, there is a table to add buttons to. Adding a custom button here will restrict the button from being seen, even if the agent is an administrator.
Fig 4. Restricting a custom button.
Upon refresh, the button is now hidden on the same asset we previously showed.
Fig 5. Custom button no longer showing.
