UI Actions

User interface (UI) actions are buttons, links, and context menu items on forms and lists. They allow you to customize the UI to be more interactive, adjustable, and comfortable for working.

UI action types

1. On forms:
   • Header left
   • Header right
   • Burger menu
   • Field label context menu
   • Link
   • Bottom
2. On lists:
   • Header left
   • Header right
   • Burger menu
   • Column header context menu
   • Row context menu
   • Link
   • Bottom
3. Other:
   • Button context menu
   • Dependency map context menu

UI actions on form

UI actions on list

Customize UI actions

You can create new or customize existing UI actions.

To do so, complete the following steps:

1. Navigate to System Definitions → UI Actions.
2. Click New or select an existing UI-action.
3. Customize UI-action using the form provided.
4. Click Save or Save and exit to apply the changes.

UI Action form fields

Global UI actions

You can make a UI action displayed on all tables.

To do that, follow the steps below:

1. Open the UI action record desired.
2. On the form, specify the Global table in the Table field.
3. Click Save or Save and exit to apply the changes.

Embed a UI action

The UI action functionality allows you to create multi-level submenu options by embedding items to the burger menu within the forms and lists. 

To embed a UI action, follow the steps below:

1. Create a parent UI action, specify its type with the Burger menu checkbox in the Form style or List style area of the Position and Style tab.
2. Click Save and exit to leave the form.
3. Create a child UI action of the same type specifying its Parent option with the UI action created before.
4. (optional) Select the Inherits checkbox to enable the UI action on the child tables.
5. Click Save to apply the changes.

Display condition configuration

The condition option defines the situations when UI actions displayed. By default, this field supports the server-side API. Select the Client checkbox to switch the available API to the client-side API. In the Condition field, use the current object of the certain record to access a UI action. This object can only be used for the UI actions that are displayed on forms. 

Use logical operators && (AND) and || (OR) to compose the complex conditions.

Use conditions to call the created Script Include on the server-side. In the example below, the function wfContextExists() of Script Include with the same name gets current.sys_id and current.getTableName as recordID and tableName arguments.

This UI action is a reference to the record with the ID of the getTableName table. If a record exists, the function returns true, and it returns false when there is no record found. Depending on the value returned, the function displays the UI action or not.

function wfContextExists(recordID, tableName){
  const table = new SimpleRecord('sys_db_table');
  table.get('name', tableName);
  const wfContext = new SimpleRecord('wf_context');
  wfContext.addQuery('related_record_id', ss.getDocIdByIds(table.sys_id, recordID));
  wfContext.selectAttributes('sys_id');
  wfContext.query();
  return (wfContext.getRowCount() > 0)
}

Define a UI action behavior with a script

The Script field defines the UI action behavior. By default, this field supports the server-side API. Select the Client checkbox to switch the available API to the client-side API.

For example, this UI action adds an informational message with the Description field content:

ss.addInfoMessage(current.description);