They enable you to manage the permissions of multiple users at the same time rather than making individual changes to user account profiles.
Users must be added to at least one role before they can access Peak.
You can manage roles for your organization by going to Console > Roles
You must have Admin privileges to use Roles.
This article describes the different types of Roles available in Peak and how to create and use them.
Contents
- Default and Custom Roles
- Creating a Custom Role
- Editing a Custom Role
- Renaming a Custom Role
- Deleting a Custom Role
- Permissions
- Adding Users to Roles
Default and Custom Roles
There are two types of role available to use:
Default
Custom
Default Roles
These are fixed, uneditable roles. This means that you can only view information about the role or add users to it.
Default Roles are based around the following Peak user personas:
Admin
Has access to the entire platform to manage resources and access control.
Be careful when assigning the Admin role.
It must only be used for Peak Admin users of the organization and never given to a customer.
Power User
Typically uses multiple areas of Peak to solve business use cases.Commercial User
Typically uses the Work area of Peak to realize Decision Intelligence across their business.
Custom Roles
If a user does not fit into the permission criteria of any of the Default Roles, you can create a Custom Role that groups permissions together so that you can grant them to specific users.
When you create a Custom Role, you specify the the different sets of permissions that are enabled within it. For example, a role named “Reporting User” might have access to multiple areas within Work. This role could then be assigned to multiple users in the organization such as members of a customer’s reporting team.
Creating a Custom Role
To create a Custom Role:
Go to Console > Roles.
The Roles screen appears.
Click CREATE ROLE.
The Name Role window appears.
Enter a suitable name.
You can use alphanumeric characters and the special characters “@”, “-”, and “&”.Click NEXT.
The edit screen for your new role appears with the Permissions tab visible.
This tab lists each area of the platform as a dropdown.
Select the dropdown for the area of Peak that you want to define permissions for.
Select the required permissions from Read All, Write All and Deny All.
For an explanation of each of these, see Permissions (below).
To save the Role, click CREATE ROLE.
The Roles screen appears with the new role visible in the Custom Roles section.
Editing a Custom Role
To edit a Role:
Go to Console > Roles.
The Roles screen appears.Go to the Custom Roles area and find the role that you want to edit.
Click the action menu icon (three dots) for the role.
The action menu appears.Click View role details.
The edit screen for the Role appears with the Permissions tab active.
From here you can check each of the platform areas to see what permissions have been applied.
Click EDIT PERMISSION.
You will now be able to select or remove the required permissions from Read All, Write All and Deny All.
For an explanation of each of these, see Permissions (below).
Once you have made your edits, click SAVE or DISCARD.
SAVE immediately applies the changes to the Role and enables or disables the functions for any users that are in the Role. If you choose DISCARD, any changes you have made will be discarded. After clicking either option, you will be returned to the Role details screen.
Renaming a Custom Role
To rename a Custom Role:
Go to Console > Roles.
The Roles screen appears.Go to the Custom Roles area and find the role that you want to edit.
Click the action menu icon (three dots) for the role.
The action menu appears.Click Rename.
Edit the name.
You can use alphanumeric characters and the special characters “@”, “-”, and “&”.
Once you have made your edits, click UPDATE or CANCEL.
UPDATE saves your changes and CANCEL cancels any changes.
After clicking either option, you will be returned to the Roles screen.
Deleting a Custom Role
After deleting a role, any users added to the role will not be able to access the functions that were specified in it.
To delete a Custom Role:
Go to Console > Roles.
The Roles screen appears.Go to the Custom Roles area and find the role that you want to edit.
Click the action menu icon (three dots) for the role.
The action menu appears.Click Delete.
A confirmation message appears.
Click CONFIRM or CANCEL.
CONFIRM permanently deletes the role and CANCEL cancels the process.
After clicking either option, you will be returned to the Roles screen.
Permissions
For Permissions within Peak, you can choose from Read, Write or Deny:
Read
The user can see the content but not change it.Write
The user can read and change content within the section.Deny
The user will not see anything about this section.
Examples
| Scenario | Required permissions |
Allow a customer to upload a file | Dock > Write: Data Sources File Manager |
Allow a customer to download a file | Work > Write: Downloads |
Interacting with a dashboard | Work > Read/Write: Apps For this, confirm which type of ‘Intelligence’ this Dashboard is presented under. Check with your DS team to understand how they will be interacting with the Dashboard. For example, they may need Write permissions to change the data, or only need Read permissions for filtering data. |
Adding Users to Roles
The process for adding users to a Role is the same for both Default Roles and Custom Roles.
For more information about managing users and adding them to the platform, see Users.
To add a user to a Role:
Go to Console > Roles.
The Roles screen appears.Find the role that you want to edit.
Click the action menu icon (three dots) for the role.
The action menu appears.Click Add Users.
The Add Users screen appears. It shows a list of all of the users that have been added to the organization.
Select a single user or multiple users and click SAVE or CANCEL.
SAVE immediately adds the users to the role and they will be granted all of the permissions that are defined within it. CANCEL cancels the process. After clicking either option, you will be returned to the Roles screen.