Links

FAQ

Frequently Asked Questions Section.

Forms and Resources

Can I name a Resource anything I want to?

The easy answer is "No". There are certain names that are reserved and should not be used.
This list reserves the listed subdomains also.
See DNS Configuration for rest of list.
The following names are unavailable for use as form / resource names.
  • submission
  • report
  • version
  • tag
  • owner
  • exists
  • export
  • import
  • clone
  • deploy
  • wipe
  • role
  • current
  • logout
  • form
  • token
  • logs
  • classic
  • storage/s3
  • storage/dropbox
  • storage/azure
  • dropbox/auth
  • upgrade
  • access
  • atlassian/oath/authorize
  • atlassian/oath/finalize
  • sqlconnector
  • token
  • v
  • draft
  • saml
  • oath2
  • recaptcha
  • manage
  • action
  • actionItem
  • tag
  • upload
  • config.json
  • portal-check

Projects

How can I update the owner of a project?

There's no way to be able to do this through the UI. You will have to go into the database and update the owner manually. The following are steps to achieve that. The code included is for the Mongo shell:
  1. 1.
    Log into the formio database via the mongo shell or GUI.
    • use formio
  2. 2.
    Go into the projects collection and find the formio project
    • db.projects.find({name: 'formio'});
  3. 3.
    Then find the user form in this project
    • db.forms.find({name: 'user', project: ObjectId(project._id)});
  4. 4.
    Then find the user in this form
  5. 5.
    Then update the project with the ID of that user
    • db.projects.update({_id:ObjectId(YOUR_PROJECT_ID)}, {$set: {owner:ObjectId(YOUR_USER_ID)}})

Authentication

How to use Session Storage instead of Local Storage?

Apply the following JS to your Form Module settings to use Session Storage. While Local Storage will retain the token in the browser cache, Session Storage will remove the JWT token as soon as the tab or browser is closed.
{
options: {
form: {
useSessionToken: true
}
}
}
Alternatively, you can apply the following JS in your YAML file to utilize Session Storage within your deployment
localStorage.setItem('useSessionToken', true)

API Server Deployments

How do I check the API server version in my deployed Environments?

To see what version of the API Server is currently deployed in your remote environment, the /status endpoint can be used. Simply navigate to the URL of the environment and add /status like: https://.yourenvironment.com/status. This will return the following information:
  • Environment ID
    • The Environment ID is also used in the License Management UI in portal.form.io for Enabling / Disabling API Server Environment utilization.
  • API Server version
  • DB Schema version

Database Questions

What Databases can I use?

Form.io runs on and requires MongoDB (or compatible) database as our server utilizes the dynamic nature JSON data storage such as dynamic fields and multi value fields. This allows for maximum flexibility with forms, apis and databases.

Can I save data to my SQL Database?

The SQL Connector can be used to map the data to your own SQL database. This will move the data from mongodb to SQL using the connector. https://help.form.io/developers/sql-connector The submission event could also be intercepted and sent directly to your own API endpoint by bypassing our submission API. By doing this you can store the data wherever needed, but this will also bypass the Form.io server side validation and actions system, which are incredibly capable features which you may want to use.