Entity actions

The entity action is shown on an edit view screen, enabling the user to execute code with a simple button click.

How to use

In order to create an entity action for a search view, in the Develop app, click on main menu and select Entity Action. In the page that opens click the Add button and then follow the workflow:

flowchart LR
    A((Start))
    B[Create the action]
    C[Create the workflow]
    D[Add to edit view]
    E((End))

    A-->B
    B-->C
    C-->D
    D-->E

In order to update an entity action, in the Develop app, click on main menu and select Entity Action. In the page that opens select the entity action to update and then follow the workflow:

flowchart LR
    A((Start))
    B[Update the action]
    C{Inputs changed?}
    D[Update the workflow]
    E((End))
    A-->B
    B-->C
    C-->|No| E
    C-->|Yes| D
    D-->E

Designer

Fields in the sidebar:

  1. UUID - Is the unique identifier of the row in the table (read-only).
  2. Module - Specify if the entity action is contained in a module.

The following diagram describes the entity used by this designer:

erDiagram
  ui_entity_action {
      string name "Name"
      string uuid "UUID"
      integer allow_multiple "Allow multiple"
      integer id_ui_module FK "Module"
      integer id_entity FK "Entity"
      integer id_wf FK "Start workflow"
  }
  ui_entity_action many--one entity : ui_entity_action_entity
  ui_entity_action many--one ui_module : ui_module_ui_entity_action
  ui_entity_action many--one wf : ui_entity_action_wf

ENTITY ACTION tab

  1. Name - The name of the entity action displayed to the user.
  2. Entity - The name of the entity.
  3. Allow multiple - If the entity action is allowed to be used on a multiple selection.
  4. Start workflow - The workflow of the entity action to execute.

INPUTS tab

Click the Add button to add inputs and the Delete button to remove inputs.

Fields for inputs:

  1. Title - The name of the input field displayed to the user.
  2. Argument Name - The variable that holds the user’s input for that specific field.
  3. Input type - The variable that holds the user’s input for that specific field.
  4. Is List - Determines whether the argument is a type of list or not.
  5. Catalog - Represents a dropdown or searchable list input that lets users select options from a predefined set of choices.
  6. Default value - The default value to display in the UI.
  7. Is Optional - If the input field is optional or not.
  8. Rank - The rank (order) of the input field.

The following diagram describes the entities used by this tab:

erDiagram
    ui_entity_action_item {
      string title "Title"
      string argument_name "Argument Name"
      string default_value "Default value"
      string uuid "hidden"
      integer rank "Rank"
      integer is_list "Is list"
      integer is_optional "Is optional"
      integer id_ui_entity_action FK "Parent"
      integer id_ui_catalog FK "Catalog"
      integer id_input_type FK "Input type"
    }
    ui_entity_action one--many ui_entity_action_item : ui_entity_action_ui_entity_action_item

    ui_entity_action_item many--one ui_catalog : ui_entity_action_item_ui_catalog
    ui_entity_action_item many--one ui_input_type : ui_entity_action_item_ui_input_type
← Entities
Entity security →