Overview
A Permission Set is a named collection of User permissions that you can apply together. Use Permission Sets to give people the permissions they need for their role, without selecting every permission individually each time.
You can create your own Permission Sets, alongside the built-in sets provided by Softools. For example, create a Contributor set for everyday data entry, a Data Steward set for managing data, or a Read-and-Export Viewer set for users who need to review and export information.
Your custom sets are available on the Invite users to Softools screen, allowing you to choose the right combination of permissions when inviting one or more Users. You can also apply or remove a set from an existing User’s Permissions form.
Permissions determine which actions a User can perform. Team membership and App and Record access rights determine which Apps and Records they can access. Selecting a Permission Set does not replace those access settings.
Built-in and custom Permission Sets are listed together, with the permissions included in each set.
Contents
- Before you start
- Open the Permission Sets App
- Built-in and custom Permission Sets
- Create a custom Permission Set
- Use a custom set when inviting Users
- Apply or remove a set for an existing User
- How Permission Sets work after use
-
Users managed through CSV import
Before you start
You need the appropriate User administration permissions to create and manage Permission Sets: Users Teams Create and Users Teams Update.
Open the Permission Sets App
- Open the Launchpad.
- Select the cog to display the settings Apps.
- Open Permission Sets.
Open Permission Sets from the settings Apps in the Launchpad.
The Permission Sets report lists the available sets and their permissions across five categories:
| Category | What it covers |
|---|---|
| Record Permissions | Actions on individual Records, such as Create, Update, Copy and Export. |
| Report Permissions | Actions from Reports, such as Import, Export, Archive and Delete. |
| Activity Stream Permissions | Attaching files, adding comments and viewing history. |
| Settings Permissions | User, Team and other site administration actions. |
| App Studio Permissions | Creating and configuring Apps and other App Studio features. |
Built-in and custom Permission Sets
Sets marked Built-In are provided by Softools and are read-only. They remain available for use alongside your custom sets.
The built-in sets shown in this example are None, Minimal, Basic Tasks, Advanced Tasks, Basic App Builder, Advanced App Builder, Manage Users, Manage Settings and All Settings.
Custom sets have the Built-In checkbox unticked. Give them names that administrators can easily recognise when inviting or updating Users.
To find a particular set, select the filter icon and filter by Name. Open a set to review its configured permissions.
Use the Name filter to find a Permission Set.
Create a custom Permission Set
- In the Permission Sets App, select New Record.
- Enter a Name. This is required and is the name administrators will see when choosing the set.
- Add a Description explaining who the set is for and what it allows. The Description supports up to 120 characters.
- Select the permissions you want to include in each category.
The record is created automatically once the required Name is completed, and changes save automatically. Review all five permission categories before using the set.
Start a new Permission Set and complete the required Name field.
Example: Contributor
Suppose colleagues need to enter and maintain data, export information and collaborate through the Activity Stream. They do not need to archive or delete Records, administer the site or change App designs.
Create a set named Contributor with the following selections:
| Category | Permissions selected |
|---|---|
| Record Permissions | Create, Update, Copy, Export |
| Report Permissions | Export |
| Activity Stream Permissions | All Activity Stream Permissions |
| Settings Permissions | Leave blank |
| App Studio Permissions | Leave blank |
For the Description, you could use:
Everyday data entry and collaboration. Create, update, copy and export records; no archive or delete.
Contributor brings the permissions needed for everyday data entry and collaboration into one reusable set.
These are example selections. Choose the permissions that suit the responsibilities of Users on your site.
Use a custom set when inviting Users
Custom Permission Sets let you control the combination of permissions used for new invitations. You can select your own set directly instead of relying on a built-in combination and adjusting individual permissions afterwards.
- Open the Pending Users App from the settings Apps.
- Open the ellipsis (…) menu and select Invite.
- Select the appropriate Teams in the left-hand panel.
- Select one or more Permission Sets in the right-hand panel. Built-in and custom sets are available here.
- Enter each email address on a separate line.
- Leave Send invitation email selected to send an invitation email, then select Invite.
The selected sets determine the permissions applied through the invitation. If you select several sets, their permissions are combined.
Select Contributor when inviting Users to apply your chosen permissions as part of onboarding.
For example, select the appropriate Team and Contributor to invite colleagues with the same starting permissions. Use a separate invitation for people who need a different combination of Teams or permissions.
For the full invitation process, see Inviting a New User.
Apply or remove a set for an existing User
- Open the Users App from the settings Apps.
- Select the User you want to update.
- Open Permissions from the left-hand menu.
- Use Apply Permission Set to add the permissions included in a set, or Remove Permission Set to clear them.
Applying a set adds to the User’s existing permissions. Other permissions remain selected. You can also adjust individual permissions using the checkboxes.
Removing a set clears the permissions included in that set, regardless of how they were originally added. This includes permissions selected manually or included in another set you previously applied.
Example: a Contributor becomes a Data Steward
A colleague previously worked as a Contributor and is now responsible for managing data. You have created a Data Steward set containing All Record Permissions, the Report permissions shown below, and All Activity Stream Permissions.
To change their permissions:
1. Remove Contributor
Select Remove Permission Set, then Contributor.
Remove the permissions included in Contributor.
In this example, Contributor was the only set of permissions the User had, so removing it leaves their permissions unticked.
The Record and Report permissions are cleared after Contributor is removed.
2. Apply Data Steward
Select Apply Permission Set, then Data Steward.
Apply the permissions configured in Data Steward.
The example Data Steward set applies All Record Permissions and these Report permissions: Import, Export, Archive, Show Archived, Link and Delete. Report Security remains unticked.
The set also includes All Activity Stream Permissions, with no Settings or App Studio permissions selected.
The User now has the Record and Report permissions configured in Data Steward.
Remove the old set before applying the new one. Sets may share permissions. If you apply Data Steward first and then remove Contributor, removing Contributor will also clear shared permissions such as Update and Export.
Changes to User permissions take effect immediately. Review the final selections, including any permissions outside the old and new sets. If the User’s role also changes which Apps or Records they should access, review their Team membership and access rights separately.
How Permission Sets work after use
Permission Sets are reusable templates. Selecting a set adds or removes its permissions at that moment; it does not create an ongoing assignment between the User and the set.
This means:
- Editing a set does not update existing Users. Its revised permissions are used the next time you select it for an invitation, apply it or remove it.
- Removing a set uses its current contents. If the set has changed since you applied it, review the User’s individual permissions as part of the update.
- Applying several sets combines their permissions. Removing one later still clears all permissions currently included in that set, including any shared with another set.
- Manual adjustments remain available. You can use sets as a starting point and then change individual permissions for a particular User.
Users managed through CSV import
CSV imports specify individual permission codes rather than selecting a Permission Set by name. Permissions use an array in the following form:
[{"Code":1001}, {"Code":1002}, {"Code":3001}]
Each code represents an individual permission. Refer to the permission-code spreadsheet attached to the User permissions guidance for the full breakdown.
For import instructions, see Adding new users via .csv Import and Edit Users via Export Import of .csv.
For more information about individual permissions, see User Account Permissions.
Comments
0 comments
Please sign in to leave a comment.