Editing the initial data to be loaded into the form - window.InitFormData
Category: Form Builder - Script Editor Section: System Event Triggers Last Updated: 2023-11-01
Modify the initial data loaded into a form, useful for setting dynamic defaults based on external data.
Syntax
javascript
window.InitFormData = function(formdata) {
// Modify formdata here
return formdata;
};REQUIRED
You must return formdata for data to load into the form.
When It Runs
- Form layout loads
- Existing record data loads (if any)
window.InitFormDataruns- Form displays to user
Avoid Overwriting User Data
Check if fields are undefined before setting defaults:
javascript
window.InitFormData = function(formdata) {
// Only set if user hasn't already entered data
if (formdata.Field_Name_txt === undefined) {
formdata.Field_Name_txt = getExternalData();
}
return formdata;
};Complete Example
javascript
window.InitFormData = function(formdata) {
// Get data from external source
var userData = fetchUserProfile();
// Set defaults only if empty
if (formdata.Email_txt === undefined) {
formdata.Email_txt = userData.email;
}
if (formdata.Name_txt === undefined) {
formdata.Name_txt = userData.name;
}
return formdata;
};Use Cases
| Scenario | Implementation |
|---|---|
| SSO integration | Pre-fill from authenticated user |
| External API | Load data from external database |
| Dynamic defaults | Calculate defaults based on context |
TIP
Since InitFormData only runs once, you can also use it to trigger one-time setup functions.