Document toolboxDocument toolbox

(2024.2) Best Practice - Permission Sets

Permission Sets

'Permissions' and 'Roles' are often thought of as a One to One relationship. For example, a Role of 'Admin' and a Permission Set of 'Admin'. This can mean a massive number of both that must be created if there are pieces of the application that the Administrator wishes to restrict from a User group. A more effective way of handling this is to create a Permission Set that manages a specific function and then assigning that Permission Set to the appropriate Role as needed. Said another way, Permissions are most effective when used to disallow single or small sets of items, rather than to explicitly allow all sets of an item.

For the example, the User should examine allowing a section of the application to a Role. This Role is the 'Example Role'. The 'Example Role' has a specific business role that must be controlled so the User cannot access some sections of the application but for other sections, access is desired. This 'Example Role' should have the following rules:

  1. 'Example Role' should be able to access the CustomerCenter

  2. 'Example Role' should be able to access the Knowledgebase

  3. 'Example Role' should be able to access Service Desk: Requests, however, Example Role should NOT be able to 'Delete Selected'.

  4. 'Example Role' should NOT be able to modify Requestor.

In this case, the Best Practice of Permission Sets for Example Role could have five Permissions assigned to it. By taking this incremental access approach to Permissions Sets, an Admin can guarantee that even organizations with a large number of Users only access the portions of PCR-360 that are allowed to specific User groups and management of Roles, and Permissions becomes easier in the long term. The following list of examples shows how to create these Permissions Set and end with creating the Role.

Example One - CustomerCenter Only

The first 'Permissions Set' allows access to ONLY CustomerCenter.

  1. Navigate to Admin > User Management > Permissions Sets.

  2. Click the button.

  3. Enter a 'Name' of "CustomerCenter Only".

    This title lets other Users easily know the intent of the Permissions Set.

  4. Leave the 'Default Permission for Menus & Modules/Controllers:' set to 'Deny'. This ensures access to ONLY what is added.

  5. On the 'Menu' tab, click the 'Add' button.

  6. This opens the 'Add New Menu Permissions' form. Click the 'CustomerCenter Menu' field.

  7. Select 'Check all'

  8. Click the Unknown Attachment button.

This creates a Permission Set that only allows access to the CustomerCenter.

Note: Roles that are assigned this Permission Set are not allowed to access any other area of the application unless additional Permissions are granted.

Example Two - Knowledgebase Only

The second 'Permissions Set' allows access to ONLY CustomerCenter.

  1. From Admin > User Management > Permissions Sets again click the 'Add' button.

  2. Enter a 'Name' of "Knowledgebase Only". 

  3. Leave the 'Default Permission for Menus & Modules/Controllers:' set to 'Deny'. This ensures access to ONLY what is added.

  4. On the 'Menu' tab, click the 'Add' button.

  5. This opens the 'Add New Menu Permissions' form. Click the 'Knowledgebase' check box.

  6. Click the Unknown Attachment button.

This creates a Permission Set that only allows access to the Knowledgebase.

Note: Roles that are assigned this Permission Set are not allowed to access any other area of the application unless additional Permissions are granted.

Example Three - Service Desk: Requests Only

The third Permissions Set allows access to the Service Desk, but ONLY to the Requests sub menu.

  1. From Admin > User Management > Permissions Sets again, click the 'Add' button.

  2. Enter a 'Name' of "Service Desk: Requests Only".

  3. Leave the 'Default Permission for Menus & Modules/Controllers:' set to 'Deny'. This ensures access to ONLY what is added.

  4. On the 'Menu' tab, click the 'Add' button.

  5. This opens the 'Add New Menu Permissions' form. Click the 'Service Desk' check box.

  6. Deselect the all the check boxes in the Service Desk tree EXCEPT for the 'Requests' check box.

  7. Click the Unknown Attachment button. 

This creates a Permission Set that only allows access to the Knowledgebase.

Note: Roles that are assigned this Permission Set are not allowed to access any other area of the application unless additional Permissions are granted.

Example Four - Service Desk: Requests (no delete)

The fourth example removes the 'Delete Selected' button image-20240501-174923.png from the 'Service Desk: Requests' Grid. Both the fourth and fifth examples start in the Permissions Sets Grid and move to 'Service Desk: Requests' to finish creating the specific Permissions.

  1. From Admin > User Management > Permissions Sets again click the 'Add' button.

  2. Enter a 'Name' of "Service Desk: Requests (no delete)",

    and then click the Save button.

  3. 'Add' another Permission Set and give it a 'Name' of "Service Desk: Requests (lock requestor)", and then click the Save button.

Now that there are two blank Permissions Sets, ("Service Desk: Requests (no delete)" and "Service Desk: Requests (lock requestor)") navigate to Main > Service Desk > Requests

To set up the fourth Permissions Set of 'Service Desk: Requests (no delete)', follow these steps:

  1. From the 'Service Desk: Requests' Grid, locate and click the "Permissions" button in the lower left-hand corner of the Grid.

  2. This opens the 'Add New Grid Permissions' form.

  3. In the 'Permission Set' field, locate and select the "Service Desk: Requests (no delete)" Permission that was set up in Step 2 above.

  4. In the 'Button' field, locate and select "deleteButton".

  5. Make sure the 'Permission' field is set to "Deny". 

  6. Click the Save New button.

This saves the fourth Permission Set of Service Desk: Requests (no delete).

Example Five - Service Desk: Requests (lock requestor)

The fifth and final Permission Set is a little more complicated. The desire is to lock the 'Requestor' field on the Requests so that this User Role cannot modify it. This needs to be done for all three Types of Requests ('Incident Request', 'Service Request', and 'Inquiry') to be effective. To do this follow, the following steps:

  1. Start with an Incident Request. Locate a Request in the Grid that starts with "IR" and double-click or select and click the Unknown Attachment button.

  2. Click themenu and then click 'Permissions Builders'

    Unknown Attachment

    in the menu.

  3. Small 'Lock' buttons appears next to all lockable form elements. Click the one next to 'Requestor'

  4. This opens the 'Add New Form Element Permissions' form.

    • In the 'Permission Set' field

      locate and select the "Service Desk: Requests (lock requestor)" Permission that was set up in Step 2 of Example Four .

  5. Make sure the 'Permission' field is set to "Read". This keeps Users with the Role from editing the field.

  6. Click the Save New button.

That sets up the fifth and final Permission. The only step remaining is to define the Role.

Setting up 'Example Role'

To bring it all together, the User should create the Role 'Example Role'. Navigate to Admin > User Management > Roles

  1. Click the Add button.

  2. This opens the 'Add New Role' form.
     

  3. Add a name of "Example Role" in the 'Role:' field.

  4. Add a 'Description' of what the Role does. This 'Description' shows in the Grid, and can help identify the intent of a Role.

  5. On the 'Permissions Sets' tab,

    click the button.

  6. This opens the 'Add New Existing Permission Sets' form.

  7. Select the five Permissions Sets ('CustomerCenter Only', 'Knowledgebase Only', 'Service Desk: Requests Only', 'Service Desk: Requests (no delete)', and 'Service Desk: Requests(lock requestor)') that were created at the begining of the Best Practices wiki.

  8. Click the Unknown Attachment button.

    The Permissions Sets are added to the Grid on the Permissions Sets tab.

  9. Click the Save New button.

The Role appears in the Grid now.

Now Users can be added to the "Example Role" and the Administrator knows that any User with a Role of "Example Role" are limited to only the sections that were set for it. Using this method of incremental Permissions Sets an Administrator can effectively and quickly manage the User Roles. For instance, now that Example Role is set with its Permissions Sets, suppose another Role is needed with only access to the CustomerCenter and Knowledgebase. It becomes a simple matter to create a new Role, "Example Role Two" and assign to it the Permissions Sets of 'CustomerCenter Only' and 'Knowledgebase' only. In this way, the previous Role of "Example Role" is unaffected by the need to create a second Role while the Admin can re-use previously created Permissions Sets.