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
  • 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
  • Introduction
  • Form View Pro Configurations
  • Launching a Form
  • Share Settings
  • Authentication
  • Submission View
  • Deployed Environments

Was this helpful?

  1. User Guide

Form View Pro

Describes the Form.io FormView application

PreviousPDF Template DesignerNextForm Manager

Last updated 2 months ago

Was this helpful?

Introduction

Form.io is a Developer-Centric tool that is leveraged by developers to build out their own custom applications.

The Form View Pro application is a minimal sample application that is packaged with the formio-enterprise Docker Container delivered software.

The Form View Pro application is intended to be a lightweight, boilerplate application and is not a replacement for an end-user facing application.

This application is included with the Form.io project and can be accessed by Launching a form, to enable testing forms outside of the Developer Portal Application.

A form hosted through this application will be found at the URL after it is launched, as seen below:

Many features and workflows are not suitable candidates to be served through the Form View Pro application.

Form View Pro Configurations

Configurations are provided to the Form View Pro application using Query parameters. For example, Bootswatch Themes can be selected for displaying forms with the styling of these themes.

https://pro.formview.io/#/examples/example?theme=materia

This switches the theme that is used to render the Form View application like so:

Public Configurations

Form View Pro can also be configured using a project's Public Configurations. This provides an interface where each project can provide public configurations that are used to control the behavior of their applications, but it can also be used as the configuration mechanism for the Form View Pro application. To change the Form View Pro configurations:

  1. Open the project on the Form.io Devleoper Portal as a user with sufficient privileges.

  2. Click the Settings option on the left-hand menu.

  3. Navigate to the Public Configurations of the project as follows.

Query Parameter / Setting
Description

theme

css

Add a custom CSS file url to apply to the form. Must be a hosted CSS file.

js

Add a custom JS file url to apply to the form. Must be a hosted JS file.

reset

Resets all "cache" from previous form sessions. Useful to send as a URL to a user that will ensure they are not affected by cache.

src

A custom Form URL. You would use this instead of using the #/{PROJECT_NAME}/{FORM_NAME} in the url.

return

A URL to navigate to once the form has been submitted.

header

To hide or show the header. header=0 will hide the header.

iframe

To place this viewer in "iframe" mode where it removes all padding and headers.

host

Force the API Host for the form that is being rendered. Useful if you wish to render a form from a different deployment.

protocol

Force the URL protocol for the host. (https or http)

token

Force an Auth Token (JWT) to be used for this form submission. Used when sending an email that automatically logs into the application.

sso

Provides an SSO authentication into the FormView application. Can be "saml" or "okta"

saml

Same as "sso" but uses "saml" by default.

branding

With any Enterprise Subscription, remove the Form.io logo from FormviewPro by setting to "false"

Launching a Form

Click the Launch tab in the form header to configure settings that will affect the form in the FormView Pro application as well as launching the form within the applicaiton.

Share Settings

Configure these settings to modify how the form is displayed and behaves within the FormView Pro application.

Theme

Choose a Bootstrap theme to display the form in the FormView Pro application

Show Header

Check this setting to display the Form Name, Login Button, and any Logos added using Public Configurations within the Formview Pro application header.

Enable Thank You Page Editor

Check this setting to enable a WYSIWYG editor located at the bottom of the page. The content within this editor will display for the end-user after submitting the form within the FormView Pro application.

Go To Form

Click this button to launch the Form within the FormView Pro applicaiton

Make Public / Make Private

Click this button to enable/disable Anonymous submissions which allows unauthenticated users to submit the form within the application.

This setting will add or remove the Anonymous Role to the Create Own Permission within the Access settings of the form.

Authentication

Submission View

To view the Submissions of a form, the above authentication must be set up. Then, once logged into the app, by clicking on the Submissions link at the top of the screen, Submissions can be viewed.

This page provides a list of all the submissions of this form visible to the logged-in user. If authenticated as an Administrator, all submissions should be visible; if logged in as a User, only submissions created by that user will be seen. This could change based on the Access settings configured on the form.

Submission View Columns

The fields shown in the columns of the Submission View can be controlled by configuring each field within the form and checking or unchecking the Table View flag.

Unchecking this field will then remove the field from the submission view which will enable this view to be customized based on which fields you would like to show when viewing submissions.

Deployed Environments

Every deployed environment receives has a unique Form View Pro application provisioned to it, used to launch forms within that environment for testing purposes only. The URL of the Form View Pro application within any deployed environment can be found at the following URL:

https://yourserver.com/yourproject/manage/view

Where yourserver.com and yourproject are the names of the domain and project respectively. For Developer Portal deployments, it is also possible to get to the Deployed Form View Pro application using formio as the project name.

For more information on the Launch Form feature, check out the documentation on .

Changes the theme of the rendered form. The names that can be used coincide with the Bootswatch themes found @ . Clicking on the "Themes" link on this page will show all the different themes that are available.

Generally, SSO or an existing authentication scheme is integrated with a custom application as well as the Form.io context, for seamless use of Form.io within a custom application. The Form View Pro application can however leverage a Form.io Resource for authenticating into this application for testing purposes only. Review the documentation to get an idea how to authenticate within the Form View Pro application.

Launching a Form
https://bootswatch.com/
https://pro.formview.io
Read More About These Permissions Here
Form Manager Authentication