Installation of Form Builder and Viewer

The Flywheel Form Builder and Viewer Application Extension allows users with Manage Project Settings permissions to easily create custom forms for Flywheel users to fill out. The information captured in the form is saved as metadata on the associated container. Forms can be associated with project, subject, session, or acquisition containers. Before the Form Builder and Viewer application can be used, it must be installed, or registered at either the site level, or on a specific project. This article covers the installation/registration process.

This article explains how to:

• Install the Flywheel Form Builder Extension Site-Wide (requires Site Admin privileges)
• Install the Flywheel Form Builder Extension for a specific Project (requires Project Admin privileges)

Visit the "Creating Forms" documentation page for more information on how to build custom forms.

Site Wide Installation

To install the Flywheel Form Builder and Viewer Extension, we will register it as an application in the Flywheel Admin UI and choose the places the Flywheel Form Builder and Viewer Extension application should be accessible. In this example, we will make the Builder available at the Project level and allow the Viewer to be used at each level of the hierarchy, from Project, to Subject, Session, and Acquisition.

1. From the Main Navigation Sidebar, Choose "Applications"

   

2. Click "Register New Application"

   

   This will bring up the "Register Application" modal.

3. Now we'll register the Form Builder application.

   Within the "Register Application" modal, enter the following:

   • Type: Viewer
   • Name: Form Builder
   • URL: https://cdn.flywheel.io/apps/form-viewer/5cfca3f8f8b188542cb02f3155aea5b3d38be73c/index.html
   • Description: Flywheel Form Builder
   • Match Container File Types: Project

   • Application Options:

     1 2 3

     { "mode": "builder" }

   The modal should look like the following:

   

4. Click "Register"

5. Next we'll repeat the process to install the Form Viewer application.

   Click the "Register Application" again and this time enter the following to register the Form Viewer:

   • Type: Form
   • Name: Form Viewer
   • URL: https://cdn.flywheel.io/apps/form-viewer/5cfca3f8f8b188542cb02f3155aea5b3d38be73c/index.html
   • Description: Flywheel Form Viewer
   • Match Container File Types: project subject session acquisition

   • Application Options:

     1 2 3 4

     { "mode": "viewer", "definitions": "project.settings" }

   The modal should look like the following:

   

6. Click "Register"

Now, you will see both Form Builder and Form Viewer as registered applications:

That's it!

Now, your users will be able to build and view forms across projects in Flywheel! Just navigate to the context menu on any project and choose "Launch in Form Builder"!

Visit the "Creating Forms" documentation page for more information on how to build custom forms.

Project Specific Installation

1. Navigate to the project upon which you want to register the Flywheel Form Builder and Viewer application and from the extended menu, choose "Applications"

   

2. Click "Register New Application"

   

   This will bring up the "Register Application" modal.

3. Now we'll register the Form Builder application.

   Within the "Register Application" modal, enter the following:

   • Type: Viewer
   • Name: Form Builder
   • URL: https://cdn.flywheel.io/apps/form-viewer/5cfca3f8f8b188542cb02f3155aea5b3d38be73c/index.html
   • Description: Flywheel Form Builder
   • Match Container File Types: Project
   • Application Options:

   1 2 3

   { "mode": "builder" }

   The modal should look like the following:

   

4. Click "Register"

5. Next we'll repeat the process to install the Form Viewer application.

   Click the "Register Application" again and this time enter the following to register the Form Viewer:

   • Type: Form
   • Name: Form Viewer
   • URL: https://cdn.flywheel.io/apps/form-viewer/5cfca3f8f8b188542cb02f3155aea5b3d38be73c/index.html
   • Description: Flywheel Form Viewer
   • Match Container File Types: project subject session acquisition
   • Application Options:

   1 2 3 4

   { "mode": "viewer", "definitions": "project.settings" }

   The modal should look like the following:

   

6. Click "Register"

Now you will see both Form Builder and Form Viewer as registered applications.

That's it!

Now users with proper permission on the project will be able to build and view forms within the project by navigating to the context menu on that project and choosing "Launch in Form Builder"!

Next -> Visit the "Creating Forms" documentation page for more information on how to build and view custom forms.