LogoLogo
Getting StartedDevelopersDeployment GuideGet Help
  • Quick Links
  • Welcome to Form.io
    • Getting Started With Form.io
    • Launch a Form
    • Overview of Form.io
  • Developer Tool Ecosystem
    • PDF Solution
    • Enterprise Form Builder
    • Form View Pro
    • The Security Module
    • Accessibility Compliance Module
    • Developer License
    • SQL Connector - Deprecated
    • Integration Libraries
    • Form.io CLI Tool
  • User Guide
    • Introduction
    • Form.io Developer Portal
    • Teams
    • Projects
      • Project UI
      • Project Settings
      • Stages
      • Multi-Tenancy
    • Resources
      • ResourceJS
    • Forms
      • Form Creation
      • Form Types
      • PDF Forms
      • Embedding a Form
      • Form Revisions
      • Form Settings
    • Form Building
      • Form Builder UI
      • Form Components
        • Component Settings
        • Basic Components
          • Resource as Select Component Data Source
        • Advanced Components
        • Layout Components
        • Data Components
        • Premium Components
          • Nested Forms
        • Custom Components
      • Logic & Conditions
      • Existing Resource Fields
      • Actions
    • Submissions
      • Accessing Submissions
      • Importing Submissions
    • Form.io eSignature - Coming Soon
    • Form.io Reporting Module
    • PDF Template Designer
    • Form View Pro
    • Form Manager
    • Enterprise Form Builder Module
      • Installation
      • User Guide
  • Developer Guide
    • Introduction
      • Application Development
      • API Documentation
    • Form Development
      • Form Renderer
      • Form Builder
      • Form Embedding
      • Form Evaluations
      • Form Templates
      • Custom Components
      • Translations
    • JavaScript Development
      • JavaScript SDK
      • JavaScript Frameworks
      • JavaScript Utilities
    • Authentication and Authorization
      • SAML
      • OAuth
      • LDAP
      • Resource Based Authentication
      • Email Authentication
      • Two-Factor Authentication
    • Roles and Permissions
      • Field Match-Based Access
      • Field-Based Resource Access
      • Group Permissions
    • Integrations
      • Email Integrations
      • File Storage
      • Google Developer Console
      • eSign Integrations
      • Relational Databases
    • Modules
    • Fetch Plugin API
    • CSS Frameworks
    • Offline Mode
    • Audit Logging
  • Deployments
    • Self-Hosted Deployment
      • Local Deployment
        • Local File Storage
      • Kubernetes
      • Cloud Deployment
        • AWS Deployment
          • AWS Lambda
          • Form.io/AWS Elastic Beanstalk End-To-End Encrypted Deployment
        • Azure Deployment
          • Azure App Service
            • Azure MSSQL Connector - Deprecated
          • Azure Virtual Machine
          • Azure Kubernetes Service
          • Set up the DB
        • GCP Deployment
          • GCP Cloud Run
      • On-Premise Deployment
      • Enterprise Server
      • PDF Server
    • Deployment Configurations
      • DNS Configuration
      • Load Balancer Configuration
    • Licenses
      • License Management
      • Library Licenses
    • Portal Base Project
      • Portal SSO
      • Portal Translations
    • Maintenance and Migration
      • Changes to Premium Libraries
  • FAQ
    • FAQ
    • Tutorials & Workflows
      • Password Reset
      • Dynamic Select Filtering
      • Approval Workflow
      • SSO Email Token
      • Embedding A Video
      • Data Source Validation
      • Select Data Source Options
      • Nested Form Workflows
        • Nested Wizard Forms
      • Save as Draft
      • Role-Based Conditions
      • Custom Component
      • Dynamic Radio and Select Box Values
      • Override CKEDITOR
    • Errors
    • Examples
    • License Utilization Checks
  • Contact Us
Powered by GitBook
On this page
  • Developer Portal Page
  • Customer Applications

Was this helpful?

  1. User Guide

Introduction

PreviousForm.io CLI ToolNextForm.io Developer Portal

Last updated 3 months ago

Was this helpful?

To best understand the Form.io platform, and how you can use it to build your own applications, it is helpful to understand the major components of the Form.io system. While there are many detailed elements and features, the major components of the Form.io system are:

Component

Description

Projects are the main working areas within the Form.io Enterprise platform. They contain Forms, Resources, Submissions, Roles & Permissions among many other elements which reside all within an API endpoint.

Stages are sub-projects that allow the management of project based workflows between multiple environments and teams. These can be utilized for DEV - STAGE - PROD form management workflows, or to separate management of forms between different teams of users.

Teams allow multiple developers to collaborate on the same projects, and to manage the forms and resources between multiple stages within a project.

Resources are used to define data objects and data models within Form.io.

Forms are the primary interface within Form.io by allowing ad-hoc bespoke data collecting through the combination of fields and resources.

PDFs provide a way to upload existing PDF forms, and build webform overlays on top of them so that they can be consumed by Progressive Web Applications. It also provides a mechanism to download submissions as PDF's.

Submissions are the data records that are submitted by filling out a form.

Actions are executed when a form is submitted. Things like Save Submission, Email, Webhooks, and other integrations are configured as Actions attached to a form and are executed in sequential order.

Roles and Permissions provide a way to configure your own user roles within a project, and then to assign those roles to a set of provided permissions attached to a Project, Forms, and Resources. This enables a granular way to control who should have access to submit forms, read submissions, view project information, among other permissions.

The Form Manager is an application that provides non-developers their own simplified portal used to manage bespoke forms, submission data, and the roles and permissions associated with those forms.

The FormView application allows for the launch of a single form to be submitted by end users. This is the application that is behind the "Launch" feature within the Form.io platform and enables both the submitting of single forms as well as the management of the submissions of that form via project Administrator.

Developer Portal Page

When a developer logs in to the Form.io platform, they arrive on their own individual . This page is the main page and has a growing amount of general content for the developer. Here you can create a new project, manage existing projects, as well as manage your TEAMs.

Customer Applications

Whenever you see the word Application used within this User Guide, it is referring to the Application that developers are building outside of Form.io.

Form.io major components are created within the Form.io system, and are ultimately used in customer Application implementations. It is important to distinguish a customer Application from the work being completing within Form.io.

When developers are working within Form.io to create major components for their customer Applications, we refer to that work as Projects.

Developer Portal Page
Projects
Stages
Teams
Resources
Forms
PDFs
Submissions
Actions
Roles and Permissions
Form Manager
FormView