Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The New Form page opens the Form Editor in creation mode at /fw/forms/new. It uses the same FormEditor component as the edit route; when no id query parameter is present the editor creates a new form on save.

​
Overview

The Form Editor at /fw/forms/new provides a visual builder for creating data-capture forms. Tabs include: Builder (field list and metadata), Wizard (multi-step configuration), and — once the form is saved — Portal, PDF Preview, Permissions, and Versions. A live preview panel can be toggled on or off.

​
Who it’s for

Requires fw.forms.create permission (FW_PERMISSIONS.FORMS_CREATE). Users without this permission cannot access this route (enforced by RequirePermission in src/routes/fw.tsx).

​
Before you start

  • An organization must be active. The form is scoped to the current organization.
  • Plan the form name and the fields needed before opening the editor. The editor validates that the name is non-empty and that at least one field exists before allowing a save.
  • Each field requires a field_key, field_type, and label.

​
Steps

  1. Navigate to /fw/forms/new or select “New Form” from the Forms list.
  2. Enter a Form Name (required) and optional Description in the Form Details card.
  3. Optionally toggle Analytics Tracking on or off.
  4. Add fields using Add Field. For each field, configure key, type, label, and any validation rules in the FieldEditorDialog.
  5. Reorder fields by dragging within the DraggableFieldList.
  6. Use Quality Score to evaluate the field configuration, or Suggest with AI to receive AI-generated field suggestions.
  7. Optionally switch to the Wizard tab to configure multi-step wizard behavior.
  8. Select Save Form. On success the editor redirects to /fw/forms/edit?id=<newFormId> where portal, PDF, permissions, and version history tabs become available.
  9. To publish the form for submissions, use the Publish button (available after saving when the form is in draft status).

​
Key concepts

  • Field key — A unique identifier for the field within the form; used in submission_data JSON.
  • Wizard configuration — Enables multi-page wizard mode for the form via WizardConfigPanel. Requires pages to be configured.
  • PDF Preview — A client-side preview of how the form renders as a PDF, using PdfPreviewPanel. Toggleable sample data shows placeholder values per field type.
  • Prefill rules — Shown in the Builder tab when a field is selected, allowing rules to auto-populate field values.
  • Draft vs. published — A form starts as draft. Publishing creates a version and makes the form available for submissions.

Forms & Workflow

Forms & Workflow core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/fw.tsx
  • src/cores/fw/pages/FormEditor.tsx
  • src/platform/forms/useFormDefinition.ts
  • src/platform/forms/useFormMutation.ts
  • src/cores/fw/components/DraggableFieldList.tsx
  • src/cores/fw/components/FieldEditorDialog.tsx