Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Custom Buttons

Custom Buttons can be added to the user interface on several entities, such as contact and company records. Installed applications may also include the option to add custom buttons to entities.

Custom buttons can be configured to allow one of three options.

  • Open a URL.
  • Open a pop-up.
  • Run an Auto Task Process.

Custom Buttons can be personalized with descriptions, icons, tooltips, and can optionally be set to only display if configured rules are met.

Before you begin

To work with custom buttons the following roles need to be considered.

  • Form Designer. A user will need this role to be able to configure and manage custom buttons.
  • Business Process Manager. A user will need this role to be able to link an Auto Task process to a custom button.

Configuring Custom Buttons

Creating a Custom Button

Entities that support a custom button will include a cog icon on the left-hand side of the title bar. Click on this cog to add a new custom button.

  • Label. Provide a label for the new custom button.
  • Icon. Optionally choose an icon to represent and sit alongside the custom button label on the entity form.
  • Color. Choose a background color for the custom button.
  • Tooltip. Optionally provide a more detailed explanation for the custom button. This will be displayed when a user hovers over the custom button.

Show button if…

By default, the custom button will appear on all forms used by the entity. Rules can be added to the The Show button if option to control when the button is displayed.

  • The available rules will be relevant to the entity against which you are adding the custom button.
  • When multiple rules are used, all rules must be met for the button to be displayed.

Action

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

  • Open URL
  • Popup
  • Run an Auto Task process

Open URL

  • Add a URL that you wish to launch from the custom button.
  • Include variables from the entity to help construct the URL.
  • The URL will open a new browser tab to display the page.

Popup

  • Add a URL that contains embeddable content.
  • A popup (iframe) containing the content will be displayed, keeping the user on the page from where it was opened.

Tip

3rd party websites are available to test if a URL can be embedded in an iframe.

Auto Task

  • Select the Auto Task Process that you wish to be invoked and executed when the custom button is selected.

Response

  • Display Autotask progress in timeline. Select this option if you want a post to be added to the entity’s timeline to audit the running of the Auto Task process and its progress and success.
  • Open popup with Autotask progress. Select this option if you want a popup to display when the custom button is selected, and to show the user the progress of the executed Auto Task process.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document