Setting Gear Access
Introduction
By default Gears can be used by any user site wide. However, Site Administrators or Site Developers can limit access to specific Gears to designated users and/or projects.
Gear access permissions control the user's ability to:
- Run a particular utility or analysis gear, either singly or in batch mode.
- Add a particular gear to a gear rule.
Visibility to gear outputs, gear logs, existence of gears in the site, or execution of gear rules are not affected by the permissions. For more info see this Table
Instruction Steps
From the Installed Gears list, Site Administrators and Gear Developers can restrict user access to a specific Gear. Access restrictions are set at the Project or User level. Combinations of Projects and Users are allowed.
Site Administrators will need to switch to Manage Site Mode to be able to modify Gear access across all projects in a site.
Site Developers can restrict access to only the projects they have access permissions on.
Tip
Using the SDK it is possible to restrict access to any site project if you have the project id. See setting gear access using the SDK
How to set Gear Access in the UI
-
Navigate to the Installed Gears page and locate the Gear for which you would like to change access settings.
-
Click the Manage Access button for the gear. This will bring up a modal from which you will have the option to turn on restricted access.
-
Set the Projects that should have access to this Gear. There is also a tab for giving specific Users access. If you give a user access, they can access the Gear on all their projects. If you would like to restrict access to a set of existing projects in a group, you can filter on the group and use the multi-select option. Note: The Project and User tabs work independently, allowing you to adjust access at the project and user levels.
-
Click Save.