On Load: Difference between revisions
Marek Rodak (talk | contribs) |
Marek Rodak (talk | contribs) |
||
| Line 29: | Line 29: | ||
=== Caching forms === | === Caching forms === | ||
Form caching is a practice in that | Form caching is a practice in that uses reused forms. Only the data is replaced; tabs that were collapsed stay collapsed, fields that were hidden remain hidden, etc. Problems may occur if you're using (poorly written) business logic that relies on the form being in the initial default state. | ||
* {{Note|Always remember to add Else if condition at the end of the rule, to reset the form to default state.|Warning}} | * {{Note|Always remember to add Else if condition at the end of the rule, to reset the form to default state.|Warning}} | ||
Revision as of 10:42, 31 August 2022
| Rules and examples |
|---|
|
| Warning | Work in progress! We are in the process of updating the information on this page. Subject to change. |
The On Load rules are checked when you open a form or a questionnaire. Rules are client-side scripts that are executed when a user of the mobile app interacts with the app. Rules are no-code business logic, which are managed using the rules editor, usually in Woodford.
On Load rules are available for the following user interface components:
Use On Load for initialization
On Load rules are the best option when it comes to handling initializations. They are designed and should be used for various steps handling actions connected to the initialization of components or form styles. The reason for this is simple – users must wait for the On Load rule to be fully executed before they are able to see the form in the desired format. By setting up only the initialization actions in the On Load rule, its execution time is minimal (unless you are handling a great number of conditions and steps in the rule).
These are the recommended steps in On Load rules:
- Hide/show fields
- Enable/disable fields
- Hide/show form tabs
- Assign styles to fields or to the entire form
- Automatically assign values to fields, e.g. date & time, location, company number, etc.
Do not set up hide/show/enable/disable fields and tabs dynamically. The actions related to changes on a form while working with it are better set up in the On Change rule.
Forms
You can use these rules for example to apply a custom format to certain records.
- Rule execution
- When when you open a form.
Caching forms
Form caching is a practice in that uses reused forms. Only the data is replaced; tabs that were collapsed stay collapsed, fields that were hidden remain hidden, etc. Problems may occur if you're using (poorly written) business logic that relies on the form being in the initial default state.
| Warning | Always remember to add Else if condition at the end of the rule, to reset the form to default state. |
Example: Hide email field
If the field Don’t Allow Emails is set to "Do Not Allow", make Email field not visible on the form.
Example: Change style on Form
If the Rating belongs to category "Hot", assign "HotLead" style, otherwise set "Normal" style.
Questionnaires
On Load rules in questionnaires are often used to automatically fill in certain fields, for example, the name of the inspector or the inspection date.
- Rule execution
- When when you open a questionnaire.
- When a repeatable group is repeated.
Example: Automatically filled fields
You might want that some fields are automatically filled in when a user starts the questionnaire.