# Form.io Documentation

## Getting Started

- [Help.Form.io](https://help.form.io/readme.md)
- [What is Form.io?](https://help.form.io/intro.md): The first stop for users who are new to Form.io or exploring the platform.
- [Platform Adoption Overview](https://help.form.io/platform-adoption-overview.md): The four key milestones on the road to adopting Form.io
- [Platform Architecture](https://help.form.io/platform-architecture.md): A simple overview of the Form.io Platform architecture
- [Form.io Concepts](https://help.form.io/form.io-concepts.md): Defining key concepts and terminology in Form.io
- [Launch a Form](https://help.form.io/launch.md): This section walks you through how to launch a form for the public to submit.
- [Working with Support](https://help.form.io/working-with-support.md)

## Form Building

- [Form Building Guide](https://help.form.io/form-building/readme.md)
- [Form JSON](https://help.form.io/form-building/form-json.md): Form JSON defines the structure, appearance, and functionality of a form.
- [Form Types](https://help.form.io/form-building/form-types.md): Understanding Web forms, Wizards, and PDF forms
- [PDF Forms](https://help.form.io/form-building/pdf-forms.md): PDF-First forms allow users to upload a PDF form and add overlay fields to the form, modernizing the traditional old and clunky PDF form.
- [Dynamic PDF Translation](https://help.form.io/form-building/pdf-forms/dynamic-pdf-translation.md)
- [PDF Basic vs PDF Plus](https://help.form.io/form-building/pdf-forms/pdf-basic-vs-pdf-plus.md)
- [PDF Template Designer](https://help.form.io/form-building/pdf-forms/pdf-template-designer.md)
- [Form Builder](https://help.form.io/form-building/form-builder.md): Understanding the Form Builder UI
- [Form Settings](https://help.form.io/form-building/form-settings.md)
- [Basic Components](https://help.form.io/form-building/basic-components.md): Using and configuring Basic Components in the Form Builder
- [Resource as Select Component Data Source](https://help.form.io/form-building/basic-components/resource-as-select-component-data-source.md): Additional information and design considerations when using a Resource as the Data Source for a Select Component.
- [Advance Components](https://help.form.io/form-building/advance-components.md): Using and configuring Advanced Components in the Form Builder
- [Premium Components](https://help.form.io/form-building/premium-components.md): Using and configuring Premium Components in the Form Builder
- [Data Components](https://help.form.io/form-building/data-components.md): Using and configuring Data Components in the Form Builder
- [Layout Components](https://help.form.io/form-building/layout-components.md): Using and configuring Layout Components in the Form Builder
- [Component Settings](https://help.form.io/form-building/component-settings.md): Configuration options for the components
- [Enterprise Form Builder](https://help.form.io/form-building/enterprise-form-builder.md)
- [Logic and Conditions](https://help.form.io/form-building/logic-and-conditions.md)
- [Form Revisions](https://help.form.io/form-building/form-revisions.md)
- [Form View Pro](https://help.form.io/form-building/form-view-pro.md)
- [Using Form View Pro](https://help.form.io/form-building/form-view-pro/formview.md): Describes the Form.io FormView application
- [Using Nested Forms](https://help.form.io/form-building/nested-forms.md): Additional details about the Nested Form premium component.
- [Resources](https://help.form.io/form-building/resources-readme.md): Use Resources as data objects within your forms or application
- [Existing Resource Fields](https://help.form.io/form-building/resources-readme/existing-resource-fields.md): Using pre-defined fields in a Resource as components of a form
- [Using Resources as a Select Component Data Source](https://help.form.io/form-building/resources-readme/using-resources-as-a-select-component-data-source.md): Additional information and design considerations when using a Resource as the Data Source for a Select Component.
- [Actions](https://help.form.io/form-building/actions.md): Configuring actions that fire on submission of a form
- [Email Actions](https://help.form.io/form-building/actions/email-actions.md): Configuring a form to send an email on submission
- [Google Sheets Actions](https://help.form.io/form-building/actions/google-sheets-actions.md)
- [Group Assignment Actions](https://help.form.io/form-building/actions/group-assignment-actions.md)
- [LDAP Login Actions](https://help.form.io/form-building/actions/ldap-login-actions.md): Configuring a a form to use LDAP Login actions for authentication
- [Login Actions](https://help.form.io/form-building/actions/login-actions.md): Configuring a Login action to fire on form submission
- [OAuth Actions](https://help.form.io/form-building/actions/oauth-actions.md): Using OAuth actions to authenticate a Form user.
- [Role Assignment Actions](https://help.form.io/form-building/actions/role-assignment-actions.md): Setting up a form action to add, modify, or remove a role associated with a submission
- [Save Submission Actions](https://help.form.io/form-building/actions/save-submission-actions.md): Configure an action to record submission data against a Form or esource.
- [SQL Connector Actions](https://help.form.io/form-building/actions/sql-connector-actions.md): The SQL Connector Action has been deprecated
- [Two-Factor Auth & Recovery Actions](https://help.form.io/form-building/actions/two-factor-auth-and-recovery-actions.md)
- [Webhook Actions](https://help.form.io/form-building/actions/webhook-actions.md): Configuring a form action to interact with an external service via webhook
- [Submissions](https://help.form.io/form-building/submissions.md)
- [Accessing Submissions](https://help.form.io/form-building/submissions/accessing-submissions.md)
- [Importing Submissions](https://help.form.io/form-building/submissions/importing-submissions.md)

## Developer Guide

- [Form.io Developer Guide](https://help.form.io/dev/readme.md)
- [AI and Form.io](https://help.form.io/dev/ai.md): Using AI, LLMs, and machine learning alongside the Form.io Platform.
- [Agentic Coding Toolset](https://help.form.io/dev/ai/agentic-coding-toolset.md): Using AI in the development of Form.io applications.
- [UAG](https://help.form.io/dev/ai/uag.md)
- [Connecting an AI Agent to UAG](https://help.form.io/dev/ai/uag/connecting-an-ai-agent-to-uag.md)
- [Deploying UAG](https://help.form.io/dev/ai/uag/deploying-uag.md): Creating a running instance of UAG.
- [Application Development](https://help.form.io/dev/application-development.md): Let's create an application using Form.io!
- [Authentication and Authorization](https://help.form.io/dev/authentication-and-authorization.md): A developers guide to the User Authentication and Authorization processes
- [Email Authentication](https://help.form.io/dev/authentication-and-authorization/email-authentication.md)
- [LDAP](https://help.form.io/dev/authentication-and-authorization/ldap.md)
- [OAuth](https://help.form.io/dev/authentication-and-authorization/oauth.md)
- [SAML](https://help.form.io/dev/authentication-and-authorization/saml.md)
- [Resource Based Authentication](https://help.form.io/dev/authentication-and-authorization/resource-based-authentication.md)
- [Two Factor Authentication](https://help.form.io/dev/authentication-and-authorization/resource-based-authentication/two-factor-authentication.md): Using 2FA with Formio Resource-based authentication
- [Form.io E-Sign+](https://help.form.io/dev/form.io-e-sign+.md): Describes Form.io E-Sign+, a digital signature module.
- [Integrations](https://help.form.io/dev/integrations.md)
- [e-Sign+](https://help.form.io/dev/integrations/e-sign+.md)
- [e-Sign Integrations](https://help.form.io/dev/integrations/e-sign-integrations.md)
- [Email Integrations](https://help.form.io/dev/integrations/email-integrations.md)
- [File Storage](https://help.form.io/dev/integrations/file-storage.md)
- [Google Developer Console](https://help.form.io/dev/integrations/google-developer-console.md)
- [Relational Databases](https://help.form.io/dev/integrations/relational-databases.md)
- [Enterprise Form Builder Module](https://help.form.io/dev/enterprise-form-builder-module.md): Integrating a robust form building and management tool in an application with the Enterprise Form Builder Module.
- [Using Enterprise Form Builder](https://help.form.io/dev/enterprise-form-builder-module/using-enterprise-form-builder.md)
- [Application Integration](https://help.form.io/dev/enterprise-form-builder-module/application-integration.md)
- [Angular Applications](https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md): Installing the Enterprise Form Builder Module in an Angular application.
- [Angular Component Reference](https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications/angular-component-reference.md)
- [React Applications](https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications.md): Integrating the Enterprise Form Builder Module in a React application.
- [React Component Reference](https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications/react-component-reference.md)
- [React Context Provider](https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications/react-context-provider.md)
- [React Hook Reference](https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications/react-hook-reference.md)
- [Custom Components](https://help.form.io/dev/custom-components.md): Describes the process of building and creating a Custom Form Component.
- [Form Development](https://help.form.io/dev/form-development.md)
- [Form Builder](https://help.form.io/dev/form-development/form-builder.md): Learn how to use the Form.io JavaScript form builder
- [Form Renderer](https://help.form.io/dev/form-development/form-renderer.md): A technical deep-dive into the powerful Form.io JavaScript Renderer
- [Form Embedding](https://help.form.io/dev/form-development/rendering.md): How to embed a Form.io form within your application.
- [Translations](https://help.form.io/dev/form-development/translations.md): Documentation of Form.io Translations
- [Form Evaluations](https://help.form.io/dev/form-development/form-evaluations.md): This section describes how the Form.io Renderer evaluates javascript code.
- [Protected Evaluator](https://help.form.io/dev/form-development/form-evaluations/protected-evaluator.md)
- [The Security Module](https://help.form.io/dev/the-security-module.md)
- [Form Templates](https://help.form.io/dev/form-templates.md): Describes the Form.io Form Templating System
- [The Form.io Standard Template](https://help.form.io/dev/form-templates/the-form.io-standard-template.md): An easier way to customize your forms' look and feel.
- [Translations](https://help.form.io/dev/translations.md)
- [Accessibility Compliance Module](https://help.form.io/dev/accessibility.md)
- [About Accessibility and Webforms](https://help.form.io/dev/accessibility/about-accessibility-and-webforms.md)
- [Using the Accessibility Compliance Module](https://help.form.io/dev/accessibility/using-the-accessibility-compliance-module.md)
- [Developer License](https://help.form.io/dev/dev-license.md): A local deployment license for the Form.io platform used for development and testing purposes.
- [JavaScript Development](https://help.form.io/dev/javascript-development.md)
- [JavaScript Frameworks](https://help.form.io/dev/javascript-development/frameworks.md): A list of all the Progressive Web Application frameworks supported by the Form.io platform.
- [JavaScript SDK](https://help.form.io/dev/javascript-development/javascript-sdk.md): This page describes the Form.io JavaScript SDK
- [JavaScript Utilities](https://help.form.io/dev/javascript-development/javascript-utilities.md): This section documents the utilities functions available within the JavaScript SDK
- [JavaScript Evaluator](https://help.form.io/dev/javascript-evaluator.md)
- [Protected Evaluator](https://help.form.io/dev/javascript-evaluator/protected-evaluator.md)
- [Audit Logging](https://help.form.io/dev/audit-logging.md)
- [Form.io CLI Tool](https://help.form.io/dev/cli-tool.md)
- [CSS Frameworks](https://help.form.io/dev/css-frameworks.md)
- [Fetch Plugin API](https://help.form.io/dev/fetch-plugin-api.md)
- [Embedding a Form](https://help.form.io/dev/form-embedding.md): Learn how to embed a form within Form.io
- [Form Renderer](https://help.form.io/dev/form-renderer.md)
- [Form.io Reporting Module](https://help.form.io/dev/form.io-reporting-module.md): The Form.io Reporting Module lets you design and generate reports from form submission data. You can pull data from one or multiple forms within a project, perform calculations, and present the result
- [JavaScript Frameworks](https://help.form.io/dev/frameworks.md): A list of all the Progressive Web Application frameworks supported by the Form.io platform.
- [Integration Libraries](https://help.form.io/dev/integration-libraries.md): Describes all of the Integration libraries for Form.io
- [JavaScript SDK](https://help.form.io/dev/javascript-sdk.md): This page describes the Form.io JavaScript SDK
- [JavaScript Utilities](https://help.form.io/dev/javascript-utilities.md)
- [Modules](https://help.form.io/dev/modules.md): Describes the Form.io Module system
- [Offline Mode](https://help.form.io/dev/offline-mode.md)
- [Form Embedding](https://help.form.io/dev/rendering.md): How to embed a Form.io form within your application.
- [SQL Connector - Deprecated](https://help.form.io/dev/sql-connector.md): This feature has been deprecated. Refer to the following guidance for alternatives.

## Administration & Portal

- [Portal & Platform Administrator Guide](https://help.form.io/admin/readme.md)
- [Form.io Developer Portal](https://help.form.io/admin/form.io-developer-portal.md)
- [Roles and Permissions](https://help.form.io/admin/roles-and-permissions.md): Roles and Permissions allow users within the Form.io platform to be granted certain permissions to perform certain actions and have access to forms and submissions within a project.
- [Field-Based Resource Access](https://help.form.io/admin/roles-and-permissions/field-based-resource-access.md)
- [Field Match-Based Access](https://help.form.io/admin/roles-and-permissions/field-match-based-access.md)
- [Group Permissions](https://help.form.io/admin/roles-and-permissions/group-permissions.md)
- [Projects](https://help.form.io/admin/projects.md)
- [Creating a Project](https://help.form.io/admin/projects/creating-a-project.md)
- [Multi-Tenancy](https://help.form.io/admin/projects/multi-tenancy.md)
- [Project Settings](https://help.form.io/admin/projects/project-settings.md)
- [Project UI](https://help.form.io/admin/projects/project-ui.md)
- [Stages](https://help.form.io/admin/projects/stages.md)
- [What is a project?](https://help.form.io/admin/projects/what-is-a-project.md)
- [Licensing](https://help.form.io/admin/licensing.md)
- [License Utilization Checks](https://help.form.io/admin/licensing/license-utilization-checks.md)
- [Library Licenses](https://help.form.io/admin/licensing/library-licenses.md)
- [License Management](https://help.form.io/admin/licensing/license-management.md)
- [Form Manager](https://help.form.io/admin/form-manager.md)
- [Teams](https://help.form.io/admin/teams.md): Collaborate on projects with other Form.io users.

## Deployment & Infrastructure

- [Deployment and Infrastructure Guide](https://help.form.io/deploy/readme.md)
- [Trial Deployment Quick Start](https://help.form.io/deploy/trial-deployment-quick-start.md): A rapid deployment process to try out the Form.io Platform.
- [Deployment Overview](https://help.form.io/deploy/deployment-overview.md)
- [Cloud Deployment](https://help.form.io/deploy/cloud-deployment.md)
- [AWS Deployment](https://help.form.io/deploy/cloud-deployment/aws-deployment.md)
- [AWS Lambda](https://help.form.io/deploy/cloud-deployment/aws-deployment/aws-lambda.md)
- [E2E Encryption with Elastic Beanstalk](https://help.form.io/deploy/cloud-deployment/aws-deployment/e2e-encryption-with-elastic-beanstalk.md)
- [Azure Deployment](https://help.form.io/deploy/cloud-deployment/azure-deployment.md)
- [Azure Virtual Machine](https://help.form.io/deploy/cloud-deployment/azure-deployment/azure-virtual-machine.md)
- [Set Up the DB](https://help.form.io/deploy/cloud-deployment/azure-deployment/set-up-the-db.md)
- [Azure App Service](https://help.form.io/deploy/cloud-deployment/azure-deployment/azure-app-service.md)
- [Deprecated - Azure MSSQL Connector](https://help.form.io/deploy/cloud-deployment/azure-deployment/azure-app-service/deprecated-azure-mssql-connector.md)
- [GCP Deployment](https://help.form.io/deploy/cloud-deployment/gcp-deployment.md)
- [GCP Cloud Run](https://help.form.io/deploy/cloud-deployment/gcp-deployment/gcp-cloud-run.md)
- [On-Premises Deployment](https://help.form.io/deploy/on-premises-deployment.md)
- [Local Deployment](https://help.form.io/deploy/local-deployment.md)
- [Local File Storage](https://help.form.io/deploy/local-deployment/local-file-storage.md)
- [Deployment Configurations](https://help.form.io/deploy/deployment-configurations.md)
- [DNS Configuration](https://help.form.io/deploy/deployment-configurations/dns-configuration.md)
- [Load Balancer Configuration](https://help.form.io/deploy/deployment-configurations/load-balancer-configuration.md)
- [Reserved Subdomains](https://help.form.io/deploy/deployment-configurations/reserved-subdomains.md)
- [Enterprise Server](https://help.form.io/deploy/enterprise-server.md)
- [PDF Server](https://help.form.io/deploy/pdf-server.md)
- [PDF Solution](https://help.form.io/deploy/pdf-solution.md)
- [Portal Base Project](https://help.form.io/deploy/portal-base-project.md)
- [Portal SSO](https://help.form.io/deploy/portal-base-project/portal-sso.md)
- [Portal Translations](https://help.form.io/deploy/portal-base-project/portal-translations.md)
- [Kubernetes](https://help.form.io/deploy/kubernetes.md)
- [Maintenance and Migration](https://help.form.io/deploy/maintenance-and-migration.md)
- [Changes to Premium Libraries](https://help.form.io/deploy/maintenance-and-migration/changes-to-premium-libraries.md)
- [Major Updates](https://help.form.io/deploy/maintenance-and-migration/major-updates.md)
- [Enterprise Server 5.x to 6.x](https://help.form.io/deploy/maintenance-and-migration/major-updates/enterprise-server-5.x-to-6.x.md)
- [Enterprise Server 6.x to 7.x](https://help.form.io/deploy/maintenance-and-migration/major-updates/enterprise-server-6.x-to-7.x.md)
- [Enterprise Server 7.x to 8.x](https://help.form.io/deploy/maintenance-and-migration/major-updates/enterprise-server-7.x-to-8.x.md)
- [Enterprise Server 8.x to 9.x](https://help.form.io/deploy/maintenance-and-migration/major-updates/enterprise-server-8.x-to-9.x.md)
- [PDF Server 1.x-3.x to 5.x](https://help.form.io/deploy/maintenance-and-migration/major-updates/pdf-server-1.x-3.x-to-5.x.md)

## Tutorials & Examples

- [Tutorials & Examples](https://help.form.io/how/readme.md)
- [Examples](https://help.form.io/how/examples.md)
- [FAQ](https://help.form.io/how/faq.md): Frequently Asked Questions Section.
- [Approval Workflow](https://help.form.io/how/approval-workflow.md)
- [Nested Form Workflows](https://help.form.io/how/nested-form-workflows.md)
- [Nested Wizard Workflow](https://help.form.io/how/nested-form-workflows/nested-wizard-workflow.md)
- [Custom Component](https://help.form.io/how/custom-component.md)
- [Data Source Validation](https://help.form.io/how/data-source-validation.md)
- [Dynamic Select Filtering](https://help.form.io/how/dynamic-select-filtering.md)
- [Dynamic Radio and Select Box Values](https://help.form.io/how/dynamic-values-in-radio-or-select-box.md)
- [Embedding a Video](https://help.form.io/how/embedding-a-video.md)
- [Override CKEDITOR](https://help.form.io/how/override-ckeditor.md)
- [Password Reset](https://help.form.io/how/password-reset.md)
- [Role-Based Conditions](https://help.form.io/how/role-based-conditions.md)
- [Save as Draft](https://help.form.io/how/save-as-draft.md)
- [Select Data Source Options](https://help.form.io/how/select-data-source-options.md)
- [SSO Email Token](https://help.form.io/how/sso-email-token.md)
- [Using Camunda with Form.io](https://help.form.io/how/using-camunda-with-form.io.md)
- [Using TermHub with Form.io](https://help.form.io/how/using-termhub-with-form.io.md): Capture standards-aligned healthcare data.

## Reference

- [Form.io Reference Docs](https://help.form.io/reference/readme.md)
- [API Documentation](https://help.form.io/reference/api-documentation.md): All of the Form.io API Documentation
- [Error Codes](https://help.form.io/reference/error-codes.md)
- [Releases and Updates](https://help.form.io/reference/releases-and-updates.md)
- [Version History](https://help.form.io/reference/releases-and-updates/version-history.md)
- [Notable Changes](https://help.form.io/reference/releases-and-updates/notable-changes.md)
- [Enterprise Server 9.5.0](https://help.form.io/reference/releases-and-updates/notable-changes/enterprise-server-9.5.0.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://help.form.io/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
