Difference between revisions of "Custom Buttons"

From Hornbill
Jump to navigation Jump to search
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
{{bluebanner|[[Main Page|Home]] > [[Collaboration]] > Custom Buttons|[[:Category:Collaboration|Index]]}}
−
__NOTOC__[[Main Page|Home]] > [[Collaboration]] > Custom Buttons
 
−
</div>
 
 
{|style="width: 100%"
 
{|style="width: 100%"
 
|- valign="top"
 
|- valign="top"
Line 7: Line 5:
 
==Introduction==
 
==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
 
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
−
* Launch URL's
+
* Open URL  
−
* Invoke a specific iBridge Operation
+
* Invoke a specific iBridge Operation '''(deprecated - please use Auto Tasks)'''
 
* Run an Auto Task Process
 
* 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.  
 
Custom Buttons can be personalised with descriptions, icons, tooltips, and optionally be set to only display on views if configurable conditions are met.  
Line 23: Line 21:
 
* [[Documents]]
 
* [[Documents]]
 
|}
 
|}
 +
  
 
==Configuring Custom Buttons==
 
==Configuring Custom Buttons==
−
[[File:custom_button_configuration.png|400px|right]]
+
[[File:Custom_Button_Auto_Task2.png|400px|right]]
−
You will need the appropriate right in order to be able to configure and manage custom buttons.  
+
 
 +
===Roles===
 +
 
 +
{{bullet1|Form Designer|A user will need this role to be able to configure and manage custom buttons. }}
 +
{{bullet1|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)}}
 +
{{bullet1|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===
 
===Creating a Custom Button===
Line 32: Line 36:
 
Click on the '''Cog''' Icon to add a new custom button
 
Click on the '''Cog''' Icon to add a new custom button
  
−
* Label - Provide a label for the new custom button
+
{{bullet1|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
+
{{bullet1|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
+
{{bullet1|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
+
{{bullet1|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===
 
===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.   
 
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  
+
* 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.
  
−
===Open URL or iBridge Method===
+
===Condition Values===
  
−
By default you can add a URL which you wish to launch from the custom button, and include variables from the entity in the URL.
+
'''Service Manager'''
  
−
Clicking on the '''iBridge''' text, will switch the custom button from the standard '''Open URL''' and will allow for the invoking of an '''iBridge Method''' when the custom Button is selected by a user.
+
'''* Request Entity'''
  
−
[[File:Information.png|14px|text-top|Information]] You will need the '''MANAGEKEYSAFE''' in group C in order to configure iBridge methods
+
:* '''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
  
−
[[File:Information.png|14px|text-top|Information]] You will need an iBridge subscription to utilise '''Premium''' iBridge methods
+
==Custom Button Actions==
  
−
'''Click Method''' to display the list of available iBridge Methods
+
Each custom button can be configured to be one of the following:
  
−
* Choose the cloud service you wish to call
+
* Open URL
−
* Drill down into the method you wish to use
+
* Invoke a specific iBridge operation
−
:* If required select the '''Keysafe'''from the drop down list for the chosen method, the '''Keysafe''' credentials which will be used when the custom button is used and the iBridge Method is invoked. If none have been configured you can follow the link to set these up before proceeding further.
+
* Run an Auto Task process
−
:* Complete the '''Context''' input values for the chosen method
+
 
−
::* Optionally inject variables from the entity into the input values for the chosen method
+
 
 +
==Open URL==
 +
 
 +
* Add a URL which you wish to launch from the custom button.
 +
:* Include variables from the entity in the URL.
 +
 
 +
 
 +
==Auto Task==
 +
[[File:Auto_Task_Pop_Up.png|right|300px]]
 +
* 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'''
 
'''Response'''
  
−
* Tick if you wish the user to be presented with a pop-up and response from the service you have integrated with once the custom button is clicked
+
* '''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
−
* Tick if you would like a post to be written to the entity timeline when the custom button is clicked
+
* '''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
−
:* Configure the text which will be displayed in the message and optionally include any output values from the integration with the 3rd party service and chosen method.
+
 
  
 
==Manage Custom Buttons==
 
==Manage Custom Buttons==
Line 77: Line 93:
  
  
−
[[Category: Service Manager]][[Category: Collaboration]]
+
[[Category: Collaboration]]

Latest revision as of 21:27, 21 March 2024

Home > Collaboration > Custom Buttons Index

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.

Related Articles


Configuring Custom Buttons

Custom Button Auto Task2.png

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

Auto Task Pop Up.png
  • 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

Entity custom buttons.png

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.

Retrieved from "https://wiki.hornbill.com/index.php?title=Custom_Buttons&oldid=32068"