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:
- Displaying one entity with all the properties and all the children.
- Editing the property values on the main entity or child properties.
- Presentation of the data on multiple tabs. Each tab can contain columns of values or grids of values.
- Displaying related entities.
- Generating a printable format for the entity.
For more information on edit views see Documentation → The user interface → The Edit view.
How to use
To open the Edit Views view, navigate to Develop ➔ Edit Views.
Designer
Fields in the sidebar:
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.
The name of the entity.
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"
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.
The title of the edit section.
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.
The module to which the edit view is part of.
This field is optional.
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.
Entity diagram:
INPUTS tab
Fields in the inputs table:
- Title - The title of the input field displayed to the user.
- Property name - The property name on the entity for the input field.
- Input type - The input type displayed to the user.
- Catalog - Represents a dropdown or searchable list input that lets users select options from a predefined set of choices.
- Navigate edit view - The edit view for navigating.
- Rank - The rank (order) of the input field.
- Read only - If the field is read-only.
- Default value - The default value to display in the UI.
Tab entity diagram:
TABS tab
Fields in the tabs table:
- Title - The title of the tab displayed to the user.
- Relationship name - The name of the property or relationship to which the input tab is associated.
- Input tab - The input tab, if the tab displays input fields.
- Child entity name - The name of the child entity.
- Search view - The search view, if the tab displays an one-to-many relation.
- Rank - The rank (order) of the tab field.
Displaying the one-to-many relationship in an edit view
Navigate to Tabs
Select the Tabs tab, click the Add button, and specify:
- Title = title of the tab
Select Search View
Click the navigate arrow next to the Search view field.
Create Related Search View
Create the search view for the related entity (representing the "Many" part of the relationship).
Configure Relation Filter
The search view requires a filter to relate the parent entity with the child entity. After configuring this filter on the search view, specify it in the Fetch tab.
Tab entity diagram:
ACTION tab
Fields in the actions table:
- Action - The entity action. See entity actions for details.
- Rank - The rank (order) of the action field.
Tab entity diagram:
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.
expanded
- Determines whether the view is initially expanded when loaded.
- Default Value:
false
timestamp.visible
- Description: Controls the visibility of the
date_createdanddate_updatedfields of the current entity presented in the view. - Default Value:
true
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
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
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
options.expanded
- Description: Added in version 1.7.2, this determines if the options sidebar is expanded by default.
- Default Value:
false
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
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
options.actions.visible
- Type: Boolean
- Description: Introduced in version 1.7.2, this specifies whether the "Actions" option is displayed in the options sidebar.