Custom Buttons

There may be times when you want to update specific table fields in your database or activate actions connected to those fields (like e-mail alerts, etc).

Custom Buttons are a subset of custom actions designed specifically to allow administrators to create buttons that perform 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 a Custom button:

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

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

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

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

Button Label

Specifies the text displayed on the button.

Notes

Enter a custom button description or any explanatory text.

Location

Specifies where the button will be located. The following options are available:

• Hidden: Excludes the button from the user interface but allows it to be called via a Navigate action or a Formula-URL. The button will operate on a specific record.
• Preview Page: Displays the button on a record’s preview page, where it operates on the displayed record.
• Table Views: Displays the button along with the View/Edit/Delete buttons in table views, operating on the specific record in the view.
• Preview Page & Table Views: Displays the button on both the record’s preview page and alongside the View/Edit/Delete buttons in table views. It operates on the specific record.
• Multi-Record: Enables the button to process multiple records. For a Multi-Record Button, the system renders checkboxes to allow users to select multiple records. The button is located in the view’s header and operates on each selected record.
• Preview Page & Multi-Record: Displays the button on both the record’s preview page and in a view’s header.

Icon

This option allows you to select icons for custom buttons. You have a choice of 900+ icons covering various subjects – actions, brands, file types, symbols, animals, and more. The search box above will help you narrow down the list of choices.

Category

Every button will be displayed on a view form. The Category property allows you to group buttons in a drop-down list, making the form less cluttered. If a category is not set, the item is rendered as a push button named after the item. If a category is set for a single item, it is rendered as a push button but named after the category rather than the item. If a category is set and shared between multiple items, they are rendered as a dropdown button named after the category with items forming a menu.

Please note that custom buttons and document buttons are processed separately, and their categories are not shared.

Highlight Color

Select a color to highlight the button on a form and/or in a view. When the button is displayed alone, its background matches the selected color. When the button collapses into a submenu, the menu item’s background uses a desaturated version of the color, similar to active/inactive tabs.

Confirmation Message

In this field, you can write text that will be displayed in the confirmation pop-up window when the button is clicked. For example:

User Input

This property allows you to request user input when executing a custom button. Three options are available:

• None: The record will be updated "silently" according to the rules specified in the assignments section, without requiring user input.
• Edit column(s): This option allows you to select specific columns for user input.
• Edit form: This option lets you use the default edit form instead of selecting individual columns for user input.

The custom button’s assignments section enables you to initialize columns with predefined values if necessary. Additionally, you can use form behavior to control how user input columns appear when the button is executed.

If you want to modify column behavior specifically for a custom button, use the following formula in the form behavior criteria: URLParam(URL(), "b") = "<button_id>". Replace <button_id> with the unique button ID, which can be found in the button’s setup URL.

Roles

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

Views

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

Filter

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