Gear Rule Templates allow you to define a standard set of gear rules for every newly created Flywheel project. These templates help keep gear processing consistent across projects, while giving project admins the flexibility to customize the settings of the gear rules for their particular project.
Before setting up Gear Rule Templates impacting all site projects, be sure to review the process for setting up and managing Gear Rules on an individual project.
Setting up a Gear Rule Template
Gear Rule Templates define the default set of Gear Rules for new projects and are set by Site Admins. To set up a gear rule template, click on Gear Rule Templates in the left Nav.
There you will find all the current Gear Rule Templates defined for the site.
Click the Add New Rule button to create a new Template.
The mechanics of filling out the Gear Rule Template at the Site level is similar to filling out a Gear Rule at the project level for these fields:
- Provide a Rule Name. This name will be used to create the rule at the project level.
- Define the container level of the data (Acquisitions, Sessions,Subjects, Projects, Any Container, or Analysis Output)
- Provide the ANY, ALL, and EXCEPT...ANY criteria.
- Click Select Gear to pick the Gear that should be included in the template. You will be asked to provide the gear type, as well as configuration values.
Depending on the characteristics of the particular gear you will have visibility to what the Project Admin will need to complete on the gear rule before it can be enabled on the new project.
For SDK Gears: the Project Admin will have to fill out the Role that the gear should operate under. More information on SDK Gears.
For gears with multiple inputs: You as Site Admin can select the trigger input from the required inputs of the gear. The Project Admin will be able to modify this on a new project. For gears with multiple inputs, all remaining required inputs will require the Project Admin to fill those in before they can enable the gear on their project, since these files are project specific.
Finally the Site Admin should click the Save button to save the Gear Rule Template. Gear Rule Templates are saved in a disabled state by default. The Site Admin can enable if desired.
Project Creation with Gear Rule Templates
When a project is created on the site, the current gear rule templates are used to populate the gear rules for the new project. Gear rule templates that are enabled will result in enabled gear rules on the project. Gear rule templates that are disabled will also cause gear rules to be created, but they will be created in a disabled state.
When you use the Smart Copy function, a new project is created and populated with data copied from another project. The gear rule templates on the site will be used to populate the new project.
Project administrators can override or modify these default Gear rules within the project in order to customize them to their particular project. For some gear rules this will be a required step before they can enable a gear rule, since project-specific input files or permission roles may be needed for a particular gear.
Changes to the Gear Rule Templates do not affect existing projects. Gear Rule Templates only play a part in new project creation.
Prior to Flywheel v16.13 Gear Rules are limited to gears that specify a single input file and to SDK gears that have "read-only" permissions.