Custom Buttons

Introduction

Custom Buttons can be added to entity views such as documents, requests, organizations and assets in Hornbill, they can be configured to allow one of three options

Open URL
Invoke a specific iBridge Operation (deprecated - please use Auto Tasks)
Run an Auto Task Process

Custom Buttons can be personalised with descriptions, icons, tooltips, and optionally be set to only display on views if configurable conditions are met.

Configuring Custom Buttons

Roles

Form Designer

A user will need this role to be able to configure and manage custom buttons.

Admin Role

A user will need this role to be able to link an iBridge Operation to a Custom Button (not needed for Auto Task Processes)

Business Process Manager

A user will need this role to be able to link an Auto Task Process to a Custom Button

Creating a Custom Button

Click on the Cog Icon to add a new custom button

Label

Provide a label for the new custom button

Icon

Optional choose an icon to represent and sit alongside the custom button label on the entity form

Colour

Choose a background colour for the custom button

Tooltip

Optionally provide a more detailed explanation for the purpose of the custom button. This will be displayed when a user hovers over the custom button

Conditions

By default the custom button will appear on all forms used by the entity - i.e all Request type forms, all asset type forms. However if you use the Conditions option you can configure the conditions which must be met in order for the custom button to be visible to users when viewing the relevant entity form.

The available conditions will be relevant to the entity against which you are adding the custom button
Having multiple conditions will be treated as AND conditions, so all conditions will need to be met for the custom button to be displayed.

Condition Values

Service Manager

* Request Entity

Request Status: Values need to entered in the following format: status.new, status.open, status.closed etc
Request Type: Values need to be entered in lower case so incident instead of Incident for example

Custom Button Actions

Each custom button can be configured to be one of the following:

Open URL
Invoke a specific iBridge operation
Run an Auto Task process

Open URL

Add a URL which you wish to launch from the custom button.

Include variables from the entity in the URL.

Auto Task

A Custom Button Administrator will also need the Business Process Manager role, in order to be able to link an Auto Task Process to a Custom Button
Select the Auto Task Process which you wish to be invoked and executed when the custom button is selected

Response

Display Autotask progress in timeline - tick this option if you want a post to be added to the entity timeline to audit the running of the Auto Task process and it's progress and success
Open popup with Autotask progress - tick this option if you want a pop up to display when the custom buttons is selected, and to show the user the progress of the executed Auto Task process

Manage Custom Buttons

Click on the edit option next to a custom button in order to edit it's attributes
Click on the Trash Can icon next to a custom button in order to delete it

Using Custom Buttons

Once a custom button has been configured, users will be able to use the custom button from the entity view it has been configured against. Visibility of the custom button will also depend on any conditions which may have been set when configuring the button.