FormView
Describes the Form.io FormView application
The FormView application is an application that enables end users the ability to consume and submit forms built and published within the Form.io platform. This is the application that you will see when you use the Launch feature, where you take any form that you create and then "launch" it so that end users can submit the form.
The most common location that many people see this application is at the URL https://pro.formview.io, which is the location you will go when you launch a form as seen below.
While this application is very simple conceptually, there are a number of features that enable this application to be used for a wide range of use cases, including full business process workflows. Considering that a "form" can be dynamic and multi-paged (using the wizard feature), it becomes clear that the simple use case of rendering a form can achieve a lot of functionality. For example, this application is perfect for the following use cases:
- Student Enrollment and Onboarding
- Employment Applications
- Quick Surveys
- Patient Registration
- Conference Registration
- Loan Applications
- and the list goes on and on
The term "hosted" is used to describe any form that is hosted on the Form.io SAAS product @ https://portal.form.io. This is the place you would go to create an account with Form.io as well as create a project that is "hosted" by Form.io, and the forms that are "launched" from our hosted platform will always use https://pro.formview.io application as the FormView application. You can read the documentation on Launching a Form so see a walkthrough on how this works.
Once a form has been launched, it will use URL parameters to determine which form is being viewed like the following.
https://pro.formview.io/#/examples/example
The format for this URL is as follows.
https://pro.formview.io/#/{PROJECT_NAME}/{FORM_NAME}
Because of this, any hosted form within the Form.io SAAS platform can be hosted and displayed.
Configurations are provided to this application using Query parameters. For example, you can tell this application to use a different theme by providing the following.
https://pro.formview.io/#/examples/example?theme=materia
This switches the theme that is used to render the FormView application like so.
The following query parameters are accepted to change the behavior of this application.
Query Parameter | Description |
theme | Changes the theme of the rendered form. The names that can be used coincide with the Bootswatch themes found @ https://bootswatch.com/. Clicking on the "Themes" link on this page will show all the different themes that are available. |
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. |
The FormView application uses the exact same method for User authentication as the Form Manager application. Because of this, we suggest that you read through the Form Manager Authentication documentation to get an idea how you can authenticate within the Form View application.
Once you login to the application, it is also possible to view the Submissions of a form. This can be done by clicking on the Submissions link at the top of the screen.
Once you click on this link, you will see a list of all the submissions you have access to for this form. If you are authenticated as an Administrator then you will see all submissions, but if you are logged in as a User, then you will see the submissions that you have created. Of course, this could change based on the Access settings you have set on the form, so it is more accurate to state that you will see the submissions that you have access to based on the Access configurations of that form.
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.
Every deployed environment receives its own FormView application used to launch forms within that environment. The URL of the form view application within any deployed environment can be found at the following URL.
https://yourserver.com/yourproject/manage/view
You would need to replace
yourserver.com and yourproject with the names of your domain and project name respectively. For Portal deployments, it is also possible to get to the Deployed formview application using formio as the project name.Last modified 3mo ago