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}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Custom Buttons

Custom Buttons can be added to the user interface on several entities, such as contact and company records, to extend the available options and perform unique actions on the entity.

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 optionally can be set to only show if a set of rules is 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 custom buttons will display a cog button Cog Button on the right-hand side of the title bar. This will only be visible to users with the Form Designer role. 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

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

Custom Button Groups

Custom button groups allow you to group together related custom buttons that will appear together in a drop-down.

Custom Button Groups

  • Adding groups. Click on Add Button Group and a new group will be added.
  • Naming a group. Click on the edit icon for the group, modify the name, and press Enter on the keyboard.
  • Moving groups. The order that the groups are displayed can be changed by using the drag and drop option to the left of the group title.
  • Moving buttons. Each button can be moved between groups by using the drag and drop option to the left of the button title.

If the number of buttons and drop-down groups exceed the available space, a single drop-down menu containing all the groups and non-grouped buttons will be used.

Tip

The label Custom Buttons that is displayed when button groups are collapsed into a single drop-down menu or when grouping is not used can be renamed using translations. Changing this will apply to all entities where custom buttons are used. Ideas for naming this button may include Menu, Options, Actions, or Advanced Actions.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document