Search Views

The search view displays data in a table with functions for adding, editing, deleting and filtering.

The search views can be used only for displaying data (read-only) or for displaying and modifying data.  For more details about the visual representation of a search view the The Search View page in the User Interface chapter.

Functions of the search view

  1. Displaying the data as a table
  2. Filtering the data
  3. Selection: one by one, all visible rows, all rows that match a filter
  4. Add rows
  5. Edit, Delete and Custom actions on selected rows
  6. Paginating rows
  7. Execute global custom actions
  8. Auto-refresh when data changes (only monitors locally initialized changes)

How to use

In order to create (or edit) Search Views, in the Develop app, click on main menu and select Search Views. In the page that opens click the Add button or select and existing one and click the Edit button.

Designer

Fields in the sidebar:

Title (in ui)

The title for the search view, as viewed by the user in the tab bar button. 

Usually the title is the entity for which the search view is defined in plural form with the first letter in upper case. No restrictions are imposed on the title as it can contain spaces or any other special characters.

Eg.: the search view for the entity “product” should have the title “Products”

List name (in url)

The list name is part of the URL for the search view. 

The URL scheme for the search view is:

https://[instance-name]/[menu-name]/#search$[list-name]

Accessing the search view is done by entering the above URL in your browser. Another way to access the search view is by adding it to the menus.

Key name (in results)

The key name is the column name in the result set (of the FETCH query) that contains the key for each row. The search view uses the value of this column to create the identity of each row, which in turn is used to know the selected rows.

This field is optional but omitting it will disable the selection function on the search view.

Edit view

The related edit view for the search view. It is used by the search view to handle the add, edit and delete functions. 

This field is optional but omitting it will disable the add, edit and delete functions.

If the edit view is already defined it can be selected from the drop-down, if not it can be created by clicking the Navigate link. 

Module The module to which the search view is part of. This field is optional.
Exportable

It is used for the possibility of exporting the results in an Excel file.

The field is optional, but it must be filled with the value “1”, for displaying the section Export with the button Excel.

UUID

The unique global identifier for the search view.

This field is automatically generated by the Link system module. This field is optional but omitting it will make the search view unsendable to another server.

The following diagram describes the entity used by this designer:

erDiagram
    ui_view_search {
        string title "Title (in ui)"
        string name "List name (in url)"
        string key_name "Key name (in results)"
        string uuid "UUID"
        string31 fetch "Fetch"
        string31 config "Config"
        integer exportable "Exportable"
        integer id_ui_module FK "Module"
    }
    ui_view_search many--one ui_module : ui_module_ui_view_search

FETCH tab

The fetch tab is used for writing the FETCH query that will extract the information that will be displayed in the search view.

After writing the FETCH query, click the Execute button, located above the query, to test the query. The result should appear under the query.

FILTERS tab

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

Fields for filters:

  1. Title - The title of the input field displayed to the user.
  2. Argument name - The name of the argument defined in the fetch.
  3. Input type - The input type displayed to the user.
  4. Catalog - The catalog. Used only for the FixedList and DynamicList input types.
  5. Operator - The filter operator.
  6. Property name - The property on which the operator is applied.
  7. Default value - The initial default value.
  8. Rank - The rank (order) to display the filters in order.

The following diagram describes the entities used by this tab:

erDiagram
    ui_view_search_filter {
      string title "Title"
      string argument_name "Argument Name"
      string property_name "Property name"
      string default_value "Default value"
      string uuid "hidden"
      integer rank "Rank"
      integer id_ui_filter_operator FK "Operator"
      integer id_ui_catalog FK "Catalog"
      integer id_input_type FK "Input type"
      integer id_ui_view_search FK ""
    }
    ui_view_search_filter many--one ui_input_type : ui_input_type_ui_view_search_filter
    ui_view_search_filter many--one ui_catalog : ui_catalog_ui_view_search_filter
    ui_view_search_filter many--one ui_filter_operator : ui_filter_operator_ui_view_search_filter
    ui_view_search many--one ui_view_search_filter : ui_view_search_ui_view_search_filter

COLUMNS tab

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

Fields for columns:

  1. Display name - The title of the column displayed to the user.
  2. Column name - The name of the column as defined in fetch.
  3. View type - The view type.
  4. Navigate edit view - The edit view for navigating.
  5. Width (px) - The width, in pixels.
  6. Rank - The rank (order) of the column.

The following diagram describes the entities used by this tab:

erDiagram
    ui_view_search many--one ui_view_search_column : ui_view_search_ui_view_search_column
    ui_view_search_column many--one ui_view_type : ui_view_search_column_ui_view_type
    ui_view_search_column many--one ui_view_edit : ui_view_search_column_ui_view_edit

    ui_view_search_column {
      string display_name "Display name"
      string column_name "Column name"
      string uuid "hidden"
      integer rank "Rank"
      integer width "Width"
      integer id_ui_view_edit FK "Navigate edit view"
      integer id_ui_view_type FK "View type"
      integer id_ui_view_search FK ""
    }

ACTIONS tab

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

Fields for actions:

  1. Action - The action. See actions for details.

The following diagram describes the entities used by this tab:

erDiagram
    ui_view_search many--one ui_view_search_action : ui_view_search_ui_view_search_action
    ui_view_search_action {
      string uuid "hidden"
      integer id_ui_action FK "Action"
    }
    ui_view_search_action many--one ui_action : ui_view_search_action_ui_action

CONFIG tab

The configuration tab is a JSON input in which you can enable or disable additional configuration options for the search view.

{
  "sidebar.visible": true,
  "sidebar.actions.visible": true, //Since 1.7.2
  "table.buttons.add.visible": true, //Since 1.7.2
  "table.buttons.delete.visible": true, //Since 1.7.2
  "table.actions.visible": false //Since 1.7.2
}
  1. sidebar.visible property is used for displaying the left column of the search view.
  2. sidebar.actions.visible property is used for displaying the actions in the left column of the search view.
  3. table.buttons.add.visible property is used for displaying the Add button.
  4. table.buttons.delete.visible property is used for displaying the Delete button when one or multiple rows are selected.
  5. table.actions.visible property is used for displaying the actions when one or multiple rows are selected.
← Edit View tabs
Audit journal →