Form Manager
Introduction
The Form Manager application is a dedicated form-building and data management interface built specifically for non-developers. This application is useful to offer to a team of non-developers so that they can easily manage the forms within a project without running the risk of modifying configurations or making advanced changes that could potentially affect the stability of the application running on Form.io. Only forms designated to be seen by the Form Manager are available within the interface. This interface looks like the following.
This also provides an interface for building forms as well as managing the data within those forms.
Self-Hosted Environments: This feature is enabled by first enabling the Developer Portal within your deployment by providing the PORTAL_ENABLED variable. For more information on how to set this up, see Portal Environment deployment in the enterprise deployment section. Then, once a project has been created within the environment with the portal enabled, decide which stage you wish to enable the Form Manager App. Many times the Form Manager App is enabled on a Non-Live stage, such as Authoring.
Then, navigate to the License Management UI to enable the Form Manager on the stage of your choice.
Then, navigate to the Stage within your Self-Hosted Developer Portal where the Form Manager has been enabled, and click the Form Manager Button in the upper right corner of the screen as below:
The Form Manager application URL endpoint
Or, if you are using a subdirectory project path method, it may look like the following.
For a SaaS project hosted on portal.form.io, Contact Support to enable the Form Manager application for your Project(s).
Authentication
By Default, The Form Manager uses the Admin Resource within the stage where it is enabled for authentication. The Form Manager Application login and users are separate from the Developer Portal Login, and need to be set up on a per-URL basis (Per Form Manager App / Stage). This is to ensure that the users logging into the Form Manager Application do not have the permission context to modify any stage or project other than the one that they are logging into.
By default, the Form Manager application uses the Admin Login Form within the project for the UI to log into the app. Because of this the following form:
Is the same form you get when you go to your Project | Admin Login form.
Any configurations made to this form, such as SSO configurations, are applied to the Form Manager Login functionality and UI. This enables the Form Manager to be used with other SSO strategies such as SAML or OAuth. For documentation on how to setup Form Manager for SSO, go to the following documentation.
Form Manager Users
If you are not using SSO, your Form Manager users will need a way to access via Resource Authentication. By default, the Administrator role has this access, which is provided to anyone who is added to the Admin resource. We can do this by first navigating to the Admin resource and adding a new user account by using that form.
Once this is done, you will now be able to log in to the Form Manager application and manage the forms using the new "admin" that you just created
Adding Forms to Form Manager
Any form within the Developer Portal can be configured to be shown within Form Manager. In order to do this, the form you wish to display within Form Manager must be configured with a tag called common
Once this is done, that form will now appear within the Form Manager application where it can be managed by the form-building administrators.
Form Manager Configurations
The Form Manager application can 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 Manager application. To change the Form Manager configurations, first, navigate to the Public Configurations of your project as follows.
Once you are here, you can now use the Public Configuration to provide any of the following configurations, which will customize how the Form manager behaves.
Setting | Description | Example |
title | The title you would like to give to the Form Manager Application | Form Manager |
logo | The url for the logo to present within the Form Manager | https://manager.form.io/assets/logo.png |
logoHeight | The height of the logo within the Form Manager | 40px |
logout | The Logout URL which will redirect when the user clicks logout. | https://yourapplication.com/logout |
js | The URL to a custom JavaScript file that allows for custom components and logic. | https://yoursite.com/js/custom.js |
css | The URL to a custom CSS file for custom styling. This can also be used to change the Bootswatch theme as follows. | assets/lib/bootswatch/dist/cosmo/bootstrap.min.css |
navbar | The class to apply to the Navbar to allow for inverted, etc. | navbar-dark bg-primary |
sso | The type of Single Sign On to perform. Currently only supports “saml”. | saml |
ssoProject | The project that will be used as the Authentication project for the Form Manager application. | https://yourdomain.com/formio |
userIndicator | An HTML indicator that you would like to have for the user indicator within the navbar of the application | {{ user.data.email }} |
branding | With any Enterprise Subscription or Self Hosted Configuration, remove Form.io Branding from Form Manager and FormviewPro | false |
Last updated
