UI actions are buttons, links, and context menu items on forms and lists. They allow customizing the UI to be more interactive, adjustable, and comfortable for working.

Role required: admin.

UI actions types

  1. Form button;
  2. Form header button;
  3. Form bottom button;
  4. Form context menu;
  5. Form link;
  6. List banner button;
  7. List bottom button;
  8. List context menu;
  9. List choice;
  10. Dependency map context menu.

UI actions on form

UI actions on list

UI actions customizing

You can create new or customize existing UI actions.

To do this. please complete the following steps:

  1. Navigate to System Definitions -> UI Actions;
  2. Click New or select existing UI-action;
  3. Customize UI-action using the form provided;
  4. Click Save.


FieldDescription
NameUI action name. It specifies a text displayed on the button, link or as a context menu item.
TableA table to display UI action on. A form or a list or a context menu should be used.
OrderThe displaying order. If there are over one UI-actions of the same type, then they will be arranged in ascending order.
ActiveMark this checkbox to display the UI-action is displayed on form (list, context menu).
ClientWhen set to TRUE, client-side API is available in the Script field; otherwise, server-side API is available.
Show insertWhen set to TRUE, this UI action is displayed on a new record insert form; otherwise, it is not displayed.
Show updateWhen set to TRUE, this UI action is displayed on an existing record form; otherwise, it is not displayed.
InheritsWhen set to TRUE, this UI action is propagated to all the tables that are a child for the table specified in the table field.
Sys overridesThis field is specifying UI action which will be overridden by current UI action.
Wait server responseWhen set to TRUE, the system will wait for the server response after clicking the button. The button will be disabled until the server responds.
UI action display type
Form header buttonButton in the form header on the left.
Form buttonButton in the form header on the right.
Form bottom buttonButton at the bottom of the form.
Form context menuContext menu item on the form.
Form linkLink on the form.
Form style

Button style on the form:

  • Primary;
  • Destructive;
  • Unstyled;
  • Approve.
List banner buttonButton in the list header on the left.
List header right buttonButton in the list header on the right.
List bottom buttonButton at the bottom of the list.
List context menuContext menu item on the list.
List choiceMenu item for actions applicable to list entries.
List linkLink on the bottom of the list.
List styleList button style defining (similar to Form style).
Dependency map context menuMenu item on the service model form.
CommentsUI action brief description.
ConditionA condition written using server-side API; if this condition will be met then the Script will be executed.
ScriptThe script that will be executed by clicking the UI action.
URL

This URL will be followed after clicking the UI action. You can use variables listed below there:

  • {CURRENT_TABLE} - the name of the current table on the record of which the UI action is located;
  • {CURRENT_ID} - ID of the current record on which the UI action was called;
  • {CURRENT_FORM_VIEW} - the form view name on which the UI action was called;
  • {CURRENT_RELATED_LIST_VIEW} - the related list view name on which the UI action was called;
  • {CURRENT_TABLE_ID} - ID of the table which is the current on for the UI action;
  • {CURRENT_LIST_VIEW} - the list view name for the list on which the UI action was called.
ParentSpecify the context menu item to be a parent for the current UI action (applicable for the Form context menu UI action type).