Edit Views

The edit view displays one entity in a form, allowing the user to view or change the properties.

Functions of the edit view:

  1. Displaying one entity with all the properties and all the children.
  2. Editing the property values on the main entity or child properties.
  3. Presentation of the data on multiple tabs. Each tab can contain columns of values or grids of values.
  4. Displaying related entities.
  5. Generating a printable format for the entity.

How to use

In order to create (or edit) Edit Views, in the Develop app, click on main menu and select Edit 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:

Name (in url)

The edit view name is part of the URL for the edit view. 

The URL scheme for the edit view is:

https://[instance name]/[app name]/#edit$[edit view name]

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

Entity name The name of the entity.
Title new

The title for the edit view, as viewed by the user in the tab bar button when the entity is being added. 

Usually the title defined as a concatenation of “New” and the entity name. No restrictions are imposed on the title as it can contain spaces or any other special characters.

Eg.: the entity “product” should have the title new “New Product”

Title edit

The title for the edit view, as viewed by the user in the tab bar button when the entity is being edited. 

Usually the title defined as a concatenation of the entity name and a descriptive property of the entity. The descriptive property can be injected as environment variable.

Eg.: the entity “product” should have the title edit “Product ${name}”. This will display to the user a title that includes the name property value of the edited entity.

Title edit section The title of the edit section.
Print view

The related print view for the edit view. It is used by the edit view to handle the print function. 

This field is optional but omitting it will disable the print function.

It the print 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 edit view is part of.

This field is optional.

UUID

The unique global identifier for the edit view.

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

The following diagram describes the entity used by this designer:

erDiagram
ui_view_edit {
  string title_new "Title new"
  string title_edit "Title edit"
  string title_edit_section "Title edit section"
  string entity_name "Entity name"
  string name "Name (in url)"
  string uuid "UUID"
  string31 config "CONFIGURATION tab"
  integer id_ui_module FK "Module"
  integer id_ui_view_print FK "Print view"
}

INPUTS tab

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

Fields for inputs:

  1. Title - The title of the input field displayed to the user.
  2. Property name - The property name on the entity for the input 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. Navigate edit view - The edit view for navigating.
  6. Rank - The rank (order) of the input field.
  7. Read only - If the field is read-only.
  8. Default value - The default value to display in the UI.

The following diagram describes the entities used by this tab:

erDiagram
ui_view_edit_input {
  string title "Title"
  string property_name "Property name"
  string default_value "Default value"
  string uuid "hidden"
  integer rank "Rank"
  integer is_read_only "Read only"
  integer id_ui_catalog FK "Catalog"
  integer id_input_type FK "Input type"
  integer id_ui_view_edit FK
  integer id_ui_view_edit_nav FK "Navigate edit view"
}
ui_view_edit_input many--one ui_view_edit : ui_view_edit_ui_view_edit_input_nav
ui_view_edit_input many--one ui_catalog : ui_view_edit_input_ui_catalog
ui_view_edit_input many--one ui_input_type : ui_view_edit_input_ui_input_type
ui_view_edit_input many--one ui_view_edit : ui_view_edit_ui_view_edit_input

TABS tab

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

Fields for tabs:

  1. Title - The title of the tab displayed to the user.
  2. Relationship name - The name of the property or relationship to which the input tab is associated.
  3. Input tab - The input tab, if the tab displays input fields.
  4. Child entity name - The name of the child entity.
  5. Search view - The search view, if the tab displays an one-to-many relation.
  6. Rank - The rank (order) of the tab field.

Displaying the one-to-many relationship in an edit view

Select the Tabs tab, click the Add button and fill the following:

  • Title = title of the tab

Click the navigate arrow next to the Search view field.

Create the search view for the related entity (for the many part of the relationship).

The search view requires to have a filter to relate the parent entity with the entity in the one to many relationship. After configuring the filter on the search view, it has to be used in the fetch tab.

The following diagram describes the entities used by this tab:

erDiagram
ui_view_edit_tab {
  string property_name "Relationship name"
  string child_entity_name "Child entity name"
  string title "Title"
  string ui_view_search_rel_column "hidden"
  string ui_view_search_rel_filter "hidden"
  string uuid "hidden"
  integer rank "Rank"
  integer id_ui_input_tab FK "Input tab"
  integer id_ui_view_search FK "Search view"
}
ui_view_edit_tab many--one ui_view_search : ui_view_edit_tab_ui_view_search
ui_view_edit_tab many--one ui_input_tab : ui_view_edit_tab_ui_input_tab
ui_view_edit_tab many--one ui_view_edit : ui_view_edit_ui_view_edit_tab

ACTION tab

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

Fields for actions:

  1. Action - The entity action. See entity actions for details.
  2. Rank - The rank (order) of the action field.

The following diagram describes the entities used by this tab:

erDiagram
ui_view_edit_action {
  string rank "Rank"
  string uuid "hidden"
  integer id_ui_entity_action FK "Action"
}
ui_view_edit_action many--one ui_entity_action : ui_view_edit_action_ui_entity_action
ui_view_edit_action many--one ui_view_edit : ui_view_edit_ui_view_edit_action

CONFIGURATION tab

The Edit View can be customised by setting the following properties.

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

{
  "expanded": false,
  "timestamp.visible": true,
  "buttons.delete.visible": true,
  "buttons.saveAsCopy.visible": true,
  "options.visible": true,
  "options.expanded": false
  "options.sharing.visible": true,
  "options.ownership.visible": true,
  "options.actions.visible": true
}

The properties can be set individually, the properties not set will have their default values as above.

  1. expanded
  • Determines whether the view is initially expanded when loaded.
  • Default Value: false
  1. timestamp.visible
  • Description: Controls the visibility of the date_created and date_updated fields of the current entity presented in the view.
  • Default Value: true
  1. buttons.delete.visible
  • Description: Toggles the visibility of the “Delete” button. This button allows users to delete the current entity presented in the view.
  • Default Value: true
  1. buttons.saveAsCopy.visible
  • Description: Determines whether the “Save as Copy” button is shown. This button allows users to create a duplicate of the current entity presented in the view.
  • Default Value: true
  1. options.visible
  • Description: Introduced in version 1.7.2, this controls whether the options sidebar is visible. The options sidebar contains the Actions, Ownership and Sharing sections.
  • Default Value: true
  1. options.expanded
  • Description: Added in version 1.7.2, this determines if the options sidebar is expanded by default.
  • Default Value: false
  1. options.sharing.visible
  • Description: Introduced in version 1.7.2, this controls whether the “Sharing” option is visible in the options sidebar.
  • Default Value: true
  1. options.ownership.visible
  • Description: Added in version 1.7.2, this toggles the visibility of the “Ownership” option in the options sidebar.
  • Default Value: true
  1. options.actions.visible
  • Type: Boolean
  • Description: Introduced in version 1.7.2, this specifies whether the “Actions” option is displayed in the options sidebar.
← Customization sets
Entities →