Introduction
Form Menu allows one to directly enter/view form data, without being part of a process flow.
Form Menu Properties
Configure Form
Figure 1: Form UI Menu Properties
| Name | Description |
|---|---|
| Label | The UI menu label. |
Menu ID | Item link slug. Optional field. Ensure that value defined here is unique to other UI menus in the app, since the first matching/conflicting ID will take precedence in page loading. |
| Form | Target form to load. |
Show in Popup Dialog? | If checked, user will be presented in a popup dialog. |
Readonly? | If checked, all the fields in the target form will be rendered as read-only. |
Display Field as Label When Readonly? | Fields set to read-only will be rendered as label/text, instead of being shown in its original input element. |
Add Edit Button In Form | Edit Button In Form Only appears when Readonly is checked. |
Figure 2: Sample Form UI Menu in runtime
Redirection
Figure 3: Redirection Properties
| Name | Description |
|---|---|
Message Shown After Form Submission | Message Shown After Form Submission. |
| Action to Perform After Form Saved | Action to Perform After Form Saved.
|
| Reload Target | Available options:
Only appears when Action to Perform After Form Saved is set to Reload Window. |
| URL Redirect After Form Submission | URL Redirect After Form Submission. Only appears when Action to Perform After Form Saved is set to Redirection. |
| Redirect Target on Form Submission | Available options:
Only appears when Action to Perform After Form Saved is set to Redirection. |
Field ID For URL Redirect Value Passover | Field ID from the preceding form to retrieve the value from. Only appears when Action to Perform After Form Saved is set to Redirection. |
Field Value Passover Method | Available options:
|
Request Parameter Name | Parameter name to hold the value retrieved via "Field ID For URL Redirect Value Passover" field specified above. Only appears when Action to Perform After Form Saved is set to Redirection. |
| Action to Perform on Cancel | Available options:
|
| URL Redirect on Cancellation | URL Redirect on Cancellation. When this value is set, the Cancel button will appear at the bottom of the form. Only appears when Action to Perform on Cancel is set to Redirection. |
| Redirect Target on Cancellation | Available options:
Only appears when Action to Perform on Cancel is set to Redirection. |
UI
Figure 4: UI Properties
| Name | Description |
|---|---|
| Submit Button Label | Submit Button Label. Default Value: Save |
Cancel Button Label | Cancel Button Label. Default Value: Cancel The Cancel button will only appear when "URL Redirect on Cancellation" field is configured. |
Custom Header | Custom Header in HTML. |
Custom Footer | Custom Footer in HTML. |
Advanced
Figure 5: Advanced Properties
| Name | Description |
|---|---|
UI Key Name | When set to point to a corresponding form field ID, the UI key value will be set into the particular field. See UI Key for more info. Example UI Key Value: sample UI Key Name: title See Figure 6. |
Load Data Using UI Key? | When checked, record row will be loaded into the form using the UI key value. The "UI Key Name" field expects an "id" value, to facilitate record seeking using the primary key. |
Figure 6: Sample UI key used in runtime
Performance & Offline
Figure 7: Cache Settings
Name | Description |
|---|---|
| Scope | Caching options are:
|
| Duration (s) | Duration in seconds to cache content, defaults to 20 seconds if applicable. |
Read more at Performance Improvement with UI Caching.
Figure 8: PWA Offline Settings
Note: PWA Offline support is dependent on the theme used.
Name | Description |
|---|---|
| Enable cache for offline support | Enable caching for offline support, usually set for use on mobile browsers. |
Read Progressive Web Application (PWA) for more information.