Custom permissions allow you to create and maintain your own list of permissions to assign to users, roles and objects. This offers a flexible layer of additional security beyond the standard and exclusive permissions within your Slate database. This article will outline how to create custom permissions, how to apply them to objects, and provide some examples to help understand how custom permissions can improve your database.
Tip - Keep track of your custom permissions!
The nature of custom permissions allows them to be applied to many users, roles and objects simultaneously. We would advise creating and maintaining documentation to keep track of where custom permissions are applied, as this will make it easy to track them down and make changes in the future. An easy way to remember key data points is to ask yourself: What is it for, Where is it applied, and Who has access?
Creating A Custom Permission
1. Click Database in the top navigation bar and select User Permissions. 2. Select Custom Permissions from the navigation bar on the right. 3. Click on New Custom Permission. |
|
4. Enter the following configurations in the popup window and hit Save once complete:
|
|
Applying Custom Permissions
Once your custom permission has been created, you are ready to apply it to objects within your database.
Assigning Custom Permissions
Now that your custom permission has been applied to your object, it's time to determine who will be granted access.
Tip - Test your custom permissions!
To ensure that your custom permissions are working as intended, we recommend adding access to your custom permission on a test account. You can then impersonate this account to confirm that your users will be able to see or interact with these objects. Impersonating another account without this custom permission allows you to confirm that it does not have access to do so.
Example 1 - Custom Read Permissions on a Custom Tab
In this example, I want to add a custom permission to a custom tab containing Financial Aid Details. I've already created the application scoped tab and have associated my application scoped form of choice with it. I am now ready to add permissions to ensure that only select staff can view this tab.
- I click on Database in the top navigation bar, then select User Permissions.
- On the right, I select Custom Permissions and click New Custom Permission.
- I've determined that I may add this custom permission to a role in the future, so I leave the permission type as non-exclusive and enter the name "Financial Aid Tab Read Only" and click Save.
- I navigate back to the Database and select Tabs.
- I click on my Financial Aid Details tab to open the popup window and look for the Read Permissions dropdown. I select my custom permission "Financial Aid Tab Read Only" and click Save. I know that I want a separate permission for users to write to this Financial Aid Tab, so I leave the Write Permission dropdown blank for now.
- Back within the User Permissions tool, I select a test user of my choice under Active Users, click Edit User and assign my custom permission to them and save my change.
- Impersonating this user, I can now confirm that they are able to view my Financial Aid Details tab on an application record.
- I exit impersonation and repeat the process with another test user that I did not assign my custom permission to, as I want to be sure that others can no longer see this tab.
- (Optional) I add this custom permission to a previously created role that will commonly need to view this tab's information. Instead of needing to grant this custom permission to each user separately, I have added it to the role and granted access to multiple users simultaneously.
- I document the custom permission I created. Following the criteria, I record:
-
- Financial Aid Tab Read Only Custom Permission
- What: Limiting read access to Financial Aid Tab.
- Where: Applied to single Financial Aid Tab read permissions.
- Who: Assigned to Admissions Staff role.
- Financial Aid Tab Read Only Custom Permission
-
Example 2 - Custom Read and Move Permissions on Reader Bins
In this example, I want to build custom permissions for my Undergraduate Review bins. I've determined that some of my staff will need to be able to see these bins but I don't want them to be able to manually move applications within them, so I will need two separate custom permissions. I intend to add these custom permissions to separate roles for easy updates to my reader's permissions year over year. (If your process allows every reader to move applications, you could opt to use a single custom permission for both settings.)
- I click on Database in the top navigation bar, then select User Permissions.
- On the right side navigation, I select Custom Permissions and click New Custom Permission.
- I create two custom permissions using these steps - Undergrad Bins Read and Undergrad Bins Move. I leave the permission type as non-exclusive.
- Clicking on the roles link on the right, I create a new role called Undergrad Review Read Only and assign the global Reader permission along with my custom Undergrad Review Read custom permission then click Save.
- I create a second role named Undergrad Review Read Move and assign the global Reader permission with both the Undergrad Review Read and Move custom permissions and click Save.
- I navigate back to the Database and select Reader Bins. (If you are using the Workflow Editor, select that instead and within your workflow of choice, click on your bin and navigate to the Next Bin and Queue Settings tab.)
- I select one of my Undergraduate bins, scroll down to the Custom Read and Custom Move permissions, and set them to my Read and Move custom permissions appropriately.
- After clicking save, I repeat this process with each Undergraduate Review bin as needed.
- Back within the User Permissions tool, I select a test user of my choice under Active Users, click Edit User and assign my Undergraduate Bins Read Only role to them within the Roles tab, and save my change.
- Impersonating this user, I can now confirm that they can view the Undergraduate Review bins but cannot move any applications.
- I exit impersonation and repeat the process with another test user that has been assigned the Undergraduate Bins Read Move role. I confirm that not only can this user view the bins, but they can move a test record's application forward throughout my bin structure.
- I exit impersonation and repeat the process with another test user that has not been granted either role but has the global Reader permission to ensure that they cannot view any of my Undergraduate Review bins.
- I document the custom permissions I've created. Following the criteria, I record:
-
- Undergraduate Bins Read Custom Permission
- What: Limiting custom read permissions for Undergraduate Review structure.
- Where: All bins with the Undergraduate Review grouping.
- Who: Assigned to Undergraduate Review Read Only and Undergraduate Review Read Move roles.
- Undergraduate Bins Move Custom Permission
- What: Limiting custom move permissions for Undergraduate Review structure.
- Where: All bins with the Undergraduate Review grouping.
- Who: Assigned to Undergraduate Review Read Move role.
- Undergraduate Bins Read Custom Permission
-