Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

UI action inheritance and override


In SimpleOne you can inherit the UI actions and then override their logic, order, name or any other feature.

Info

The system provides Ui Actions inheritance with the Inherits option. When a UI action has a Table specified, and the Inherits option is defined with TRUE, the system applies this UI action to all children tables of the one specified before. 

To child UI actions, the reference Parent option defines an ancestor UI action which functionality options may be overriden if you need it.


Tip
titleInheritance rules:
  1. The following UI actions are applied to forms and lists:
    • Ui actions inherited and not overrided by the Overides by option on the current level of inheritance.
    • The overrided on the current level functionality of the UI actions inherited.
    • UI actions specified on the current level.
  2. A UI action inherited on the 1st level with the override functionality specified on the 2nd level cannot be applied on the 3rd level of inheritance. An inherited UI action specified on the 2nd level may be applied to the 3rd one.
  3. A UI action inherited on the 1st level with the override functionality specified on the 3rd level cannot be overrided on the 2nd level. In this case, the system warns of active override option and requires for its deactivation.

To inherite a UI action, complete the steps below:

  1. Make a UI action parent by set the Inherits checkbox active, and clicking Save.
  2. Make a UI action child by specifying the Parent field with the UI action you want, then customizing the record. Click Save to apply changes.

To override a UI action, complete the steps below:

  1. Open the child UI Action form.
  2. In the Overrides by field, specify a parent UI Action that should be override.


Note

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.

Embed a UI Action

UI action functionality allows creating embedded items for burger menu within forms and lists. multi-level submenu options

Note

This option is only available for UI actions of the Form context menu and List burger menu types.

To embed a UI action, follow the steps below:

  1. Create a parent UI action specifying its type with the Form context menu or List burger menu checkboxes on 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 Ui action created before.
  4. (Optional) Set the Inherits option active.
  5. Click Save to apply changes.

Display condition configuration

Use logical operators &&, || for making the condition expressions.

A UI Action form description

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.
CommentsUI action brief description.
ActiveMark this checkbox to display the UI-action is displayed on form (list, context menu).
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.
Overrides byThis field is specifying UI action which will be overridden by current UI action.
OrderThe displaying order. If there are over one UI-actions of the same type, then they will be arranged in ascending order.
ParentSpecify the context menu item to be a parent for the current UI action (applicable for the Form context menu UI action type).
Conditions and Actions
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.
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.
ClientWhen set to TRUE, client-side API is available in the Script field; otherwise, server-side API is available.
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.
Position and Style
Form style

Button style on the form:

  • Primary;
  • Destructive;
  • Unstyled;
  • Approve.
Form bottom buttonButton at the bottom of the form.
Form buttonButton in the form header on the right.
Form context menuContext menu item on the form.
Form header buttonButton in the form header on the left.
Form linkLink on the form.
Form field label context menuAn item of the context menu for the fields on the form.
List styleList button style defining (similar to Form style).
List banner buttonButton in the list header on the left.
List bottom buttonButton at the bottom of the list.
List burger menuA burger menu item on the list.
List choiceMenu item for actions applicable to list entries.
List header right buttonButton in the list header on the right.
List linkLink on the bottom of the list.
List table header context menuA context menu item for the elements of the list.
List context menuContext menu item on the list.
Button context menuA context menu item for UI actions of the button type.
Dependency map context menuMenu item on the service model form.


Table of Contents
absoluteUrltrue
classfixedPosition