Installation of Form Builder and Viewer

The Flywheel Form Builder and Viewer Extension Application 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 and Viewer Extension Site-Wide (requires Site Admin privileges)
• Install the Flywheel Form Builder and Viewer Extension for a specific Project (requires Project Admin privileges)

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

Applications to Register

Both installation methods register the same two applications — the Form Builder and the Form Viewer — with identical settings. Only where you register them (site or project) and the privileges required differ. In this example, the Builder is made available at the project level, and the Viewer is made available at each level of the hierarchy: project, subject, session, and acquisition.

From the Applications page, click "Register New Application" and register each of the following. See Site-Wide Installation or Project-Specific Installation for how to open the page.

Form Builder

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

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

• Application Options:

  1 2 3

  { "mode": "builder" }

The modal should look like the following, then click "Register":

Form Viewer

Click "Register New Application" again and enter the following:

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

• Application Options:

  1 2 3 4

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

The modal should look like the following, then click "Register":

Site-Wide Installation

Installing at the site level makes the Form Builder and Viewer available to all users across every project.

1. From the main navigation sidebar, choose "Applications".

   

2. Register the Form Builder and Form Viewer applications using the settings in Applications to Register above.

   

Both applications now appear in the registered applications list:

Your users can now build and view forms across projects. Navigate to the context menu on any project and choose "Launch in Form Builder".

Project-Specific Installation

Install at the project level to make the Form Builder and Viewer available to users of a single project. This is useful when you are not a Site Admin, or when you prefer that users register the application project-by-project.

1. Navigate to the project where you want to register the application, and from the extended menu choose "Applications".

   

2. Register the Form Builder and Form Viewer applications using the settings in Applications to Register above.

   

Both applications now appear in the registered applications list:

Users with the proper permissions on the project can now build and view forms. Navigate to the context menu on that project and choose "Launch in Form Builder".

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

Release History