Custom Buttons

There may be times when you want to update certain table fields of your database or activate some actions connected to such fields (like e-mail alerts, etc).

Custom Buttons are the subset of custom actions designed specifically to allow administrators to create buttons performing record updates or actions.

Here you can review some Custom Button examples:

Preview Page Button

Table View Button

Multi-Record Button

Preview Page and Multi-Record Button

Custom Button with Assignments

Custom Button with Actions

Creating New Custom Buttons

To add the Custom button:

Click the Setup link in the top right corner of the window.

Choose a necessary table and click a corresponding tab at the top of the window.

From the menu in the main frame select Rules > Custom Buttons.

Click New at the top of the actions list. The system will open the following form:

Button Label

The Button Label property specifies the text being displayed on the button.


In the Description field enter a custom button description or any explanation text.


The Location property specifies whether the button will be located on a record's preview page or along with the View/Edit/Delete buttons that are selected in the Table View advanced options; or in either places. Furthermore, you can specify that the button should process multiple records. The Multi-record button is similar to the Table View button, but instead of displaying the button for each record, TeamDesk renders checkboxes allowing a user to select many records. In this case the button performing the action will be located in a table view's header.


Every button will be displayed on a view form. The Category property allows to group buttons in a drop list, as a result, the form does not look cluttered.

If category is not set, the item is rendered as a push button named after the item.

If category is set for a single item it is rendered as a push button, but named after category rather than item.

If category is set and shared between multiple items they are rendered as a dropdown button named after category with items forming a menu.

Please note that custom buttons and documents' buttons are processed separately; their categories are not shared.

User Input

This property allows you to ask for a user input. If None of columns are provided, the record will be "silently" updated according to rules specified in the assignment section. In case the Edit column(s) option is chosen, you can select the columns for the user input.

The Edit form option allows you to use a default edit form instead of selected columns for custom button with a user input required. Custom button assignments will allow you to initialize the columns with some values if needed. Furthermore, you can also use a standard form behavior to control the form appearance.


The Roles property allows you to restrict the access to the button to a selected set of roles.


The Views property allows you to restrict the access to the button to a selected set of views.


The Matching section is intended to set the filter criteria for records that will be updated by the custom button.

Next: Preview Page Button