Role Groups

Modified on Wed, 19 Jan 2022 at 03:36 PM

TABLE OF CONTENTS

Introduction

This section describes how to manage permissions that roles provide. Role groups are used to define which level of access, or access privileges to functions in ManagementStudio, ranging from view-only access to full administration rights. Management role groups simplify the assignment and maintenance of permissions to users in ManagementStudio. For example Power users and Restricted Users abilities. Anyone who wishes to use and interact with ManagementStudio must have a user account, and only an authenticated administrator can add, edit, and delete a user.




Default Role Groups

  • Project Admin: A member of this group will be granted full administrative rights. They will have complete and unrestricted access to the entire ManagementStudio product.
  • Project Member: A project member is a user who is assigned to a project. A member can be assigned to one or more projects and to one or more roles.
  • Power User: By default, members of this group will be granted specific administrator rights and permissions to perform common system tasks.
  • Api Connectors: Members of this group will be able to run the API commands and also the Connectors.



Role Group Permissions Explained


PermissionsDescription
Applications - Deny Access |Read /Write |Read only
CreateAbility to create a new Application.
LockAbility to Lock an Application.
ArchiveAbility to Archive an Application.
DeleteAbility to Delete an Application.
ImporterAbility to use the Data Importer to import Applications.
Disable Context MenuRestrict access to the Context menu within the Applications module.
Run Custom ActionsAbility to run Custom Actions via the context menu in Applications.
Send EmailsAbility to send emails from the Applications module.
View Hidden TabProvides access to the Hidden tab within the Applications module.
Assigned ToAllow the user to be assigned Applications.
Owned ByAllow the user to be set as an owner of the Application.
Packaged ByAllows the user to be assigned an Application as a packager.
Delegate To 1Allows the user to be set as a Delegate 1 of an Application.
Delegate To 2Allows the user to be set as a Delegate 2 of an Application.
ConfigurationProvides access to the Application configs within the Admin section.




PermissionDescription
User Migrations - Deny Access |Read /Write |Read only
CreateAbility to create a new User Migration.
LockAbility to Lock a User Migration record.
ArchiveAbility to Archive a User Migration.
DeleteAbility to Delete a User Migration.
ImporterAbility to use the Data Importer to import User Migrations.
Disable Context MenuRestrict access to the Context menu within the User Migrations module.
Run Custom ActionsAbility to run Custom Actions via the context menu in the User Migrations module.
Send EmailsAbility to send emails from the User Migrations module.
View Hidden TabProvides access to the Hidden tab within the User Migrations module.
Initiate MigrationAbility to initiate a User Migration.
Assigned ToAllow the user to be assigned to a User Migration.
Delegate To 1Allows the user to be set as a Delegate 1 of a User Migration.
Delegate To 2Allows the user to be set as a Delegate 2 of a User Migration.
ConfigurationProvides access to the User Migration configs within the Admin section.




PermissionDescription
Devices - Deny Access |Read /Write |Read only
CreateAbility to create a new Device.
LockAbility to Lock a Device record.
ArchiveAbility to Archive a Device.
DeleteAbility to Delete a Device.
ImporterAbility to use the Data Importer to import Devices.
Disable Context MenuRestrict access to the Context menu within the Devices module.
Run Custom ActionsAbility to run Custom Actions via the context menu in the Devices module.
Send EmailsAbility to send emails from the Devices module.
View Hidden TabProvides access to the Hidden tab within the Devices module.
Initiate MigrationAbility to initiate a migration.
Assigned ToAllow the user to be assigned to a Device.
Delegate To 1Allows the user to be set as a Delegate 1 of a Device.
Delegate To 2Allows the user to be set as a Delegate 2 of a Device.
ConfigurationProvides access to the Devices configs within the Admin section.




PermissionDescription
Mailboxes - Deny Access |Read /Write |Read only
CreateAbility to create a new Mailbox. 
LockAbility to Lock a Mailbox record.
ArchiveAbility to Archive a Mailbox record.
DeleteAbility to Delete a Mailbox.
ImporterAbility to use the Data Importer to import Mailboxes.
Disable Context MenuRestrict access to the Context menu within the Mailboxes module.
Run Custom ActionsAbility to run Custom Actions via the context menu in Mailboxes.
Send EmailsAbility to send emails from the Mailboxes module.
View Hidden TabProvides access to the Hidden tab within the Mailboxes module.
Assigned ToAllow the user to be assigned to a Mailbox.
Initiate MigrationAbility to initiate a migration.
Delegate To 1Allows the user to be set as a Delegate 1 of a Mailbox.
Delegate To 2Allows the user to be set as a Delegate 2 of a Mailbox.
ConfigurationProvides access to the Mailbox configs within the Admin section.




PermissionDescription
Bespoke - Deny Access |Read /Write |Read only
CreateAbility to create a new Bespoke item.
LockAbility to Lock a Bespoke record.
ArchiveAbility to Archive a Bespoke item.
DeleteAbility to Delete a Bespoke item.
ImporterAbility to use the Data Importer to import Bespoke items.
Disable Context MenuRestrict access to the Context menu within the Bespoke module.
Run Custom ActionsAbility to run Custom Actions via the context menu in the Bespoke module.
Send EmailsAbility to send emails from the Bespoke module.
View Hidden TabProvides access to the Hidden tab within the Bespoke module.
Initiate MigrationAbility to initiate a migration.
Assigned ToAllow the user to be assigned to a Bespoke item.
Delegate To 1Allows the user to be set as a Delegate 1 of a Bespoke item.
Delegate To 2Allows the user to be set as a Delegate 2 of a Bespoke item.
ConfigurationProvides access to the Bespoke configs within the Admin section.




PermissionDescription
Deployment Units - Deny Access |Read /Write |Read only
CreateAbility to create a new Deployment Unit.
LockAbility to Lock and unlock a Deployment Unit.
ArchiveAbility to Archive and unarchive a Deployment Unit.
DeleteAbility to Delete and undelete a Deployment Unit.
ImporterAbility to use the Data Importer to import Deployment Units.
Disable Context MenuRestrict access to the Context menu within the Deployment Unit module.
Run Custom ActionsAbility to run Custom Actions via the context menu in Deployment Units.
Send EmailsAbility to send emails from the Deployment Units module.
View Hidden TabProvides access to the Hidden tab within the Deployment Unit module.
Initiate MigrationAbility to initiate a migration.
Populate Deployment UnitsAbility to populate and manage a Deployment unit.
Customise Scheduling SlotsAbility to edit and customise migration timeslots in a Deployment Unit.
Update Migration SlotAbility to override and update a Migration slot.
Assigned ToAllow the user to be assigned to a deployment unit.
Delegate To 1Allows the user to be set as a Delegate 1 of a deployment unit.
Delegate To 2Allows the user to be set as a Delegate 2 of a deployment unit.
ConfigurationProvides access to the Deployment unit configs within the Admin section.




PermissionDescription
Defects - Deny Access |Read /Write |Read only
CreateAbility to create a new Defect.
LockAbility to Lock and unlock a Defect.
ArchiveAbility to Archive and unarchive a Defect.
DeleteAbility to Delete and undelete a Defect.
ImporterAbility to use the Data Importer to import Defects.
Disable Context MenuRestrict access to the Context menu within the Defects module.
Run Custom ActionsAbility to run Custom Actions via the context menu in Defects.
Send EmailsAbility to send emails from the Defects module.
View Hidden TabProvides access to the Hidden tab within the Defects module.
Assigned ToAllow the user to be assigned to a Defect.
Delegate To 1Allows the user to be set as a Delegate 1 of a Defect.
Delegate To 2Allows the user to be set as a Delegate 2 of a Defect.
ConfigurationProvides access to the Defects configs within the Admin section.




PermissionDescription
Tasks - Deny Access |Read /Write |Read only
CreateAbility to create a new a New Task.
LockAbility to Lock and unlock a Task.
ArchiveAbility to Archive and unarchive a Task.
DeleteAbility to Delete and undelete a Task.
ImporterAbility to use the Data Importer to import  Tasks.
Disable Context MenuRestrict access to the Context menu within the Tasks module.
Run Custom ActionsAbility to run Custom Actions via the context menu in the Tasks module.
Send EmailsAbility to send emails from the Tasks module.
Assigned ToAllow the user to be assigned to a Task.
ConfigurationProvides access to the Tasks configs within the Admin section.




PermissionDescription
Contact 
CreateAbility to create a new Contact.
EditAbility to edit a Contact record.
DeleteAbility to Delete and undelete a Contact.
ImporterAbility to use the Data Importer to import Contacts.




PermissionDescription
Link 
CreateAbility to create a new Link between modules.
RejectAbility to Reject a link.
DeleteAbility to Delete and undelete a link.
ImporterAbility to use the Data Importer to import links.
ConfigurationProvides access to the Application configs within the Admin section.




PermissionDescription
Project
Member
Other Project Roles
Admin UI AccessGrants the user access to the Admin UI.
Run Scripts AsThis enables the User to run a script directly.
View Email QueueProvides the ability to view the email messaging queue.
Edit Email QueueProvides the ability to edit the email messaging queue.
Project Config Roles
Manage ConfigurationProvides access to edit and manage a Project configuration.
Manage ContactsProvides access to manage Contacts.
Manage ScriptsProvides access to create and run Project scripts.
Manage Scheduled TasksProvides access to create and edit Scheduled tasks in a Project.
Manage BlueprintsProvides access to create and edit Blueprints in a Project.
Module Config Roles
Manage SettingsProvides access to the modules settings function in the Admin area.
Manage Tabs, Details, MenuItemsAllows access to the Tabs, Details & MenuItems within the Admin area.
Manage WorkflowAllows access to manage the workflow within the modules.
Manage SurveysProvides access to manage Surveys.
Delete SurveysAllows the user to delete Surveys.
Manage Test TypesAbility to create and edit Test Types.
Delete Test TypesAbility to delete Test Types.
Manage CustomFormsAbility to create and edit Customforms.
Manage Email TemplatesAbility to create and edit email templates.
Manage UI ButtonsAllows the user to be able to manage the UI buttons.
User Account Roles
Manage User AccountsAccess to User Management in the Admin section.
Manage Role GroupsAccess to User role management in the Admin section.
Manage Blueprint RulesProvides access to manage and modify Blueprint rules.



Custom Permissions 1 - 10

These custom permissions are used for controlling which user can run specific functions within PowerShell Custom actions. For more information, please visit ManagementStudio's Service Desk to create a new support ticket.



Create a Role Group


StepExample
Switch to Administration view and select the Role Groups menu from within the User accounts, Roles and Permissions section.
Click on Click here to add new item 
Enter a unique name for the role group and a brief optional description (1)
Click Save Changes (2)
Click Edit Rules next to the newly created role group.
Grant the permissions required by going through the permissions section and selecting the appropriate permissions against each module.  
Click Finished after selecting the required permissions.
Click Save Changes.

Add a User to a Role Group

User permissions are granted by adding Roles to an account. 


StepsExample
Switch to Administration view and select the MS User Accounts menu from within the User accounts, Roles and Permissions section.
Select the User or Users (1) (CTRL + Click to select multiple users).
Right Click and select Add Roles (2) from the context menu.
Click a Role or Roles (1) (CTRL + Click to select multiple roles).
Then Click Add Roles (2).


Remove a User from a Role Group


StepsExample
Switch to Administration view and select the MS User Accounts menu from within the User accounts, Roles and Permissions section.
Select the User or Users (1) (CTRL + Click to select multiple users).
Right Click and select Remove Roles (2) from the context menu.
Click a Role or Roles (1) (CTRL + Click to select multiple roles).
Then Click Remove Roles (2).

Further Support

If you require further support, please visit ManagementStudio's Service Desk to search the knowledge base or create a new support ticket.