schema - forms best practices

  • Updated

This article outlines some Forms' recommended best practices for designing and configuring forms. These guidelines help ensure they are reliable, easy to maintain, and consistent across environments, while supporting clean data collection and predictable behavior.
 

form design best practices

Each form should collect only the data required for the intended business process. Avoid overloading forms with unnecessary fields, as this increases user friction and data quality issues.

Use clear and consistent field naming that aligns with the underlying Data tool objects and fields. This ensures traceability between the form, the data model, and downstream processes such as reporting or automation.

Group related fields logically and keep layouts simple. A well-structured form improves usability and reduces errors during data entry.
 

logic and rules best practices

Form logic should be intentional and minimal. Use rules to support business requirements, such as conditionally showing fields, enforcing validations, or controlling form behavior. Also avoid overly complex rule chains.

Whenever possible, reuse consistent logic patterns across forms. This improves maintainability and reduces the risk of unexpected behavior.

Before publishing changes, review rules for dependencies and conflicts. Complex logic increases the likelihood of errors, especially when multiple conditions and actions interact.
 

JSON configuration best practices

The JSON tab reflects the technical configuration of the form and its logic. This is a read-only tab; it cannot be modified.

Always validate JSON changes before saving. Incorrect or incomplete JSON can cause forms to behave unexpectedly or fail to load.

To import JSON, ensure it matches the target environment’s data structure, including object names, fields, and relationships. Export and store JSON versions as backups when making significant changes.
 

preview and testing best practices

Use Preview to validate form behavior before making it available to end users. This testing should include checking field visibility, validations, default values, and logic execution.

Test forms with realistic data scenarios, including edge cases. This helps identify issues that may not be visible during basic testing.

Any change to form logic or structure should be previewed again, even if the update seems minor.
 

governance and maintenance best practices

Establish ownership for forms. Each form should have a clear owner responsible for updates, validation, and lifecycle management.

Document the purpose of each form and any non-obvious logic decisions. This is especially important for forms with advanced rules or JSON customizations.

Periodically review existing forms to ensure they are still aligned with current data models and business processes. Retire or archive forms that are no longer in use to reduce clutter and risk.
 

consistency across the system

Forms should be consistent with the Data tool configuration, including object definitions, field types, and relationships. Misalignment between forms and data structures can lead to data integrity issues.

Use standardized terminology across forms, documentation, and configurations. Consistency improves collaboration between teams and reduces onboarding time for new users.


 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.