Actions

The action is shown on an search view or in the home view, enabling the user to execute the action with a simple button click.

How to use #

In order to create an action for a search view, in the Develop app, click on main menu and select 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 search view]
    E((End))

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

In order to update an action, in the Develop app, click on main menu and select Action. In the page that opens select the 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 action is contained in a module.

erDiagram
ui_action {
    string name "Name"
    string uuid "UUID"
    integer id_ui_module FK "Module"
    integer id_wf FK "Workflow"
}
ui_action many--one wf : ui_action_wf
ui_action many--one ui_module : ui_module_ui_action

ACTION tab #

1. Name - The name of the action displayed to the user.
2. Workflow - The workflow of the action to execute. Click the navigate button to create or update the workflow for the action.

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 input type displayed to the user.
4. Catalog - Represents a dropdown or searchable list input that lets users select options from a predefined set of choices.
5. Default value - The default value to display in the UI.
6. Is Optional - If the input field is optional or not.
7. Rank - The rank (order) of the input field.

The following diagram describes the entities used by this tab:

erDiagram
ui_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_action FK
    integer id_ui_catalog FK "Catalog"
    integer id_input_type FK "Input type"
}
ui_action_item many--one ui_action : ui_action_ui_action_item
ui_action_item many--one ui_input_type : ui_action_item_ui_input_type
ui_action_item many--one ui_catalog : ui_action_item_ui_catalog