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

Navigation: Settings → Catalogs → Form Builder

The system provides a visual form creation interface for building custom data collection forms:

Form creation interface in the Catalogs section

Form Builder Components

The Form Builder provides a visual interface for creating forms that collect data during workflow warning resolution. These forms are specifically designed for collecting profile attribute data.

Available Form Components:

Component	Purpose
Number	Numeric values (income, amounts, counts)
Select (Dropdown)	Predefined value lists from catalogs or custom options

Note: Form Builder components are limited to Number and Select because these forms are specifically designed for profile attribute collection. For more complex form requirements, SDK-level form development is required.

Validation Options:

• Required field validation

• Custom validations with dependencies between fields

• Conditional field visibility (show/hide based on other field values)

Drag-and-drop form builder showing available components

Creating Forms

Configuring custom fields within the form

Step 1: Create Form

1. Navigate to: Settings → Catalogs → Form Builder

2. Click Add

3. Fill in:

   • Form Code: e.g., income_verification (⚠️ This code will be used in Workflow Tool in the Form Scheme field)

   • Description: Purpose of the form

Step 2: Add Fields (Drag & Drop)

Available field types:

• Number

• Select (Dropdown)

Example for Income Verification Form:

• Field: Monthly Income

• Type: Number

• Property Name: monthlyIncome

⚠️ Important: Property Name must exactly match the profile attribute name:

• If attribute exists in Save to Profile node → use the same name

• If new attribute → system will automatically create this name

Step 3: Configure Form and Test

Explore available tabs:

• Display: Field display order

• Data: Content definition for Select field type

• Validation: Validation rules, conditional field visibility

• API: Field positioning, grouping

Verify form correctness by filling in fields on the form creation page.

Step 4: Save

1. Click Save

2. Copy form code (e.g., income_verification)

Step 5: Link to Workflow Tool

1. Open workflow (e.g., SoftHit)

2. Add Save Warning Fact node

3. Configure fields:

   • Name: Income Verification Required (for Workflow Tool)

   • Fact: Income Verification Required (for Application and Participant)

   • Decision Department: Select from catalog (e.g., Underwriting)

   • Form Scheme: income_verification

⚠️ Note: Form Scheme field is optional in the Save Warning Fact node

Step 6: Save and Export Workflow

1. Save workflow

2. Mark workflow as ready for export

3. Import workflow at the Admin Panel level

Critical Configuration: Attribute Mapping

Mapping form fields to client profile attributes

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.

Attribute Naming Strategy:

Scenario	Approach
Existing Profile Attribute	Use the attribute name specified in the Save to Profile node's Field Name field
New Profile Attribute	System automatically populates the Property Name when creating the form. This name must be used by the offer calculation script.

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:

1. In the workflow designer, add a "Save Warning Fact" task

2. Select the appropriate form scheme

3. Assign to the responsible department

4. Configure the warning trigger conditions

Runtime Behavior

When a workflow cannot determine a value:

1. System creates a Warning Fact

2. Warning includes the linked form scheme

3. Warning routes to designated department

4. Reviewer must complete form to approve warning

5. Form data saves to participant/asset profile

Example Implementation

Participant with warnings requiring form completion

In this example:

• Workflow cannot determine participant's profile

• Warning created for Underwriting department

• Form completion required for approval

Form displayed during warning resolution

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

Form Lifecycle

Action	Available	Notes
Create	✓	Click Add in Form Builder
Edit	✓	Updates overwrite existing form
Delete	✗	Forms cannot be deleted
Deactivate	✓	Use Deactivate action to disable form
Version Control	✗	No versioning - edits update the form directly

⚠️ Important: When deactivating a form, you must also edit the Save Warning Fact node that referenced the deactivated form scheme.

Validation in Form Builder

Form Builder validation provides:

Available Validations:

• Required field validations

• Custom validations with dependencies between fields

• Conditional field visibility (show/hide based on other field values)

Limitations:

• Forms cannot reference current application data

• Complex validations require SDK-level development

Form Builder Data Flow

When a workflow warning requires data collection:

1. User accesses warning in Launchpad

2. Form Builder form displays based on configured schema

3. User completes form with required data

4. Data validates according to Form Builder rules

5. Approved data updates participant/asset profile

6. 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

1. Workflow identifies missing data

2. Warning Fact created with form

3. Launchpad displays to user

4. Form completion updates profile

5. 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

Form Builder Capabilities Summary

Capability	Available	Notes
Create forms	✓	Settings → Catalogs → Form Builder
Number field	✓	For numeric profile attributes
Select (dropdown) field	✓	For enumerated profile attributes
Other field types	✗	Use SDK forms for complex requirements
Required validation	✓	Mark fields as required
Custom validation	✓	Dependencies between fields
Conditional visibility	✓	Show/hide based on other fields
Reference application data	✗	Forms cannot access current application
Delete forms	✗	Only deactivate
Form versioning	✗	Edits overwrite existing form
Link to warnings	✓	Via Form Scheme field in Save Warning Fact

Related Operations

Once configured, see how forms are used in operations:

• Manual Decisions (OPS) - Launchpad queue management and Warning Fact resolution with forms

Next Steps

With forms configured, explore:

• Catalogs - Reference data management

• Warning & Alert Configuration - Configuring warnings that use forms

• Workflow Fundamentals - Form integration in workflows

---

For additional Form Builder support, consult your implementation team or system documentation.