Form Builder
Overview
The Form Builder in timveroOS enables creation of custom forms for structured data collection when automated systems cannot determine required values. This tool integrates with workflows to capture missing information while maintaining process continuity.
Important Distinction: Form Builder vs SDK Forms
Form Builder Forms (This Documentation)
Purpose: Used EXCLUSIVELY within the Workflow Engine for manual data collection
Usage: Only available when workflows create warning facts requiring human input
Access: Through Launchpad warning resolution interface
Configuration: Visual drag-and-drop interface in admin panel
SDK Forms (Developer Documentation)
Purpose: General-purpose forms used throughout the application
Usage: Entity creation, editing, search interfaces, and custom screens
Access: Available anywhere in the application
Configuration: Requires SDK development using Entity-Form-Controller pattern
This documentation covers ONLY Form Builder forms for workflow warnings.
Business Context
Not all data can be retrieved automatically from external sources. The Form Builder addresses scenarios where:
Data source responses are incomplete
Manual verification is required
Business-specific information needs collection
Regulatory compliance requires attestations
Form Builder Interface
The system provides a visual form creation interface for building custom data collection forms:
Form Builder Components
The Form Builder provides a visual interface for creating forms that collect data during workflow warning resolution. These components are specifically designed for the workflow context:
Available Form Components:
Text Input: With validation options (required, email, phone, name format)
Select Dropdown: For predefined value lists and enums
Date Picker: With min/max date constraints
Amount/Currency: For monetary values with currency selection
Checkbox: For boolean values and agreements
Textarea: For longer text entries
Radio Buttons: For exclusive choices
File Upload: For document attachments
Read-only Fields: For displaying non-editable information
Validation Options:
Standard validations: required, email, numeric, positive numbers
Format validations: phone patterns, ID formats, postal codes
Custom validations based on business rules
Conditional validations based on other field values
Integration with Catalogs: Select dropdowns can reference catalog values for dynamic options, ensuring consistency across forms.
Creating Forms
Steps for form creation:
Drag components from the palette
Configure field properties
Set validation rules
Define default values where appropriate
Map fields to system attributes
Critical Configuration: Attribute Mapping
Important: Form field names must match client profile attribute names exactly. This ensures data flows correctly from forms into participant profiles and downstream processes like offer generation.
Workflow Integration
⚠️ Important: Form Builder forms are used ONLY for workflow warnings in the Launchpad. They cannot be used for general data entry or entity creation.
Connecting Forms to Warnings
Forms are linked to warning facts in workflows:
In the workflow designer, add a "Save warning fact" task
Select the appropriate form scheme
Assign to the responsible department
Configure the warning trigger conditions
Runtime Behavior
When a workflow cannot determine a value:
System creates a warning fact
Warning includes the linked form scheme
Warning routes to designated department
Reviewer must complete form to approve warning
Form data saves to participant/asset profile
Example Implementation
In this example:
Workflow cannot determine participant's profile
Warning created for Underwriting department
Form completion required for approval
Form Types
Data Completion Forms
Capture missing information:
Employment details
Income sources
Address information
Business ownership
Verification Forms
Confirm automated findings:
Identity verification
Document authenticity
Transaction explanations
Income confirmation
Compliance Forms
Meet regulatory requirements:
Beneficial ownership
Source of funds
Disclosures
Attestations
Exception Forms
Document manual decisions:
Override rationales
Exception approvals
Alternative valuations
Special terms
Configuration Guidelines
Form Design
Use clear field labels
Provide helpful descriptions
Group related fields
Implement logical flow
Validation Setup
Configure appropriate field types
Set required fields
Add format validation
Include range checks
Performance Considerations
Minimize number of fields
Use conditional logic efficiently
Leverage existing data
Avoid redundant information
Form Builder Technical Details
Validation in Form Builder
Form Builder validation provides:
Standard Validations:
Required field validations (cannot be empty)
Email format validation
Length constraints (min/max characters)
Date validations (past, present, future)
Numeric validations (positive, ranges)
Custom Business Validations: The system supports custom validators for:
Phone number formats by region
ID number formats (SSN, Tax ID, etc.)
Business-specific patterns
Cross-field validations
Validation Execution: Validations run at multiple levels:
Client-side for immediate feedback
Server-side for security
Database constraints for data integrity
Form Builder Data Flow
When a workflow warning requires data collection:
User accesses warning in Launchpad
Form Builder form displays based on configured schema
User completes form with required data
Data validates according to Form Builder rules
Approved data updates participant/asset profile
Workflow continues with collected information
Common Use Cases
Income Verification
When automated income detection fails:
Create form for manual income entry
Include fields for income types
Add validation for reasonable ranges
Map to income profile attributes
Employment Status
For complex employment situations:
Capture employment type
Collect employer details
Document self-employment income
Update employment profile
Collateral Details
When standard valuations unavailable:
Gather asset specifics
Document condition
Capture unique features
Enable manual valuation
Integration Points
System Components
Forms integrate with:
Workflows: Trigger and routing
Launchpad: Display and completion
Profiles: Data storage
Pricing: Recalculation triggers
Process Flow
Workflow identifies missing data
Warning fact created with form
Launchpad displays to user
Form completion updates profile
Process continues with complete data
Best Practices
Naming Conventions
Use consistent field names
Match profile attributes exactly
Document naming standards
Maintain naming dictionary
Testing Protocol
Test forms with sample data
Verify profile updates
Check downstream impacts
Validate all paths
Maintenance
Review form usage regularly
Update for new requirements
Archive obsolete forms
Monitor completion rates
Troubleshooting
Form Not Displaying
Verify form assignment to warning
Check user department access
Confirm form is active
Review workflow configuration
Data Not Saving
Check attribute name matching
Verify data types align
Review validation rules
Examine user permissions
Validation Issues
Test validation patterns
Check required field logic
Review conditional rules
Verify reference data
Next Steps
With forms configured, explore:
Catalogs - Reference data management
Workflow Management - Form integration
Launchpad - Form completion interface
For additional Form Builder support, consult your implementation team or system documentation.
Last updated
Was this helpful?