Roles and Permissions: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
 
(76 intermediate revisions by the same user not shown)
Line 1: Line 1:
QPR ProcessAnalyzer has a role-based access control, where all operations require appropriate rights in order to be executable. Rights are given to '''users''' and '''groups''' by assigning '''roles''' to them. Roles are a collection of '''permissions'''. Permissions are fixed in QPR ProcessAnalyzer allowing certain operations to be done. Some roles are '''project-specific''' meaning that that role (and its permissions) is applicable only for that project. Roles can also be '''global''' which gives rights to all projects in the system. Users belonging to a group, have all the roles assigned to that group.
QPR ProcessAnalyzer has a role-based access control, where all operations require appropriate rights in order to be executable. Rights are given to ''users'' and ''groups''' by assigning ''roles'' to them. Roles are a collection of ''permissions''. Permissions are fixed in QPR ProcessAnalyzer allowing certain operations to be done. Some roles are ''project roles'' meaning that role (and its permissions) is applicable only for that project. Roles can also be ''global'' which gives rights to all projects in the system. Users belonging to a group, have all the roles assigned to that group.


== Global and Project Roles ==
== Roles and Permissions ==
There are two types of roles in QPR ProcessAnalyzer:
By default, QPR ProcessAnalyzer system contains roles that are shown in the following table (roles are as columns). The roles have been mapped to certain ''permissions'' that are also shown in the following table (permissions are as rows).
* '''Global roles''' are used to give rights in the entire QPR ProcessAnalyzer system.
* '''Project roles''' are used to give rights in a certain project. When assigning projects roles, the project is also defined.
 
By default, QPR ProcessAnalyzer system contains global and project roles that are shown in the following table (roles are as columns). The roles have been mapped to certain '''permissions''' that are also shown in the following table (permissions are as rows). It's possible to create new roles in QPR ProcessAnalyzer.


{| style="color:black; cellpadding="10" class="wikitable"
{| style="color:black; cellpadding="10" class="wikitable"
Line 27: Line 23:
|-
|-
||'''Design dashboards'''<br>(EditDashboards)||
||'''Design dashboards'''<br>(EditDashboards)||
* Create, modify and delete dashboards (as a project role, dashboards in the assigned project; as a global role, all dashboards).
* Create, modify and delete dashboards in the project.
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||
|-
|-
||'''Import data'''<br>(GenericWrite)||
||'''Import data'''<br>(GenericWrite)||
* Import data to datatables, modify/remove rows in datatable, add/modify/remove columns in datatable
* Create, edit, delete design diagrams
* Edit model settings (but not possible to create or delete models)
* Edit model settings (but not possible to create or delete models)
* Import data to datatables (either directly or import to a model which uses datatables)
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||||
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||||
|-
|-
Line 41: Line 38:
|-
|-
||'''Manage project'''<br>(ManageProject)||
||'''Manage project'''<br>(ManageProject)||
* Modify project information (name and description) (also ''GenericRead'' permission is needed)
* Modify project information, such as name and description.
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]|| || ||
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]|| || ||
|-
|-
||'''Delete models'''<br>(DeleteModel)||
||'''Delete models'''<br>(DeleteModel)||
As a project specific permission:
As a project specific permission:
* Moving model to recycle bin (soft deleting) (also project specific ManageProject permission is needed)
* Moving model to recycle bin (soft deleting)
* Delete datatables (for datatables deletion is always permanent)
* Delete datatables (for datatables deletion is always permanent)
As a global permission:
As a global permission:
* Permanently deleting models and projects (remove from the recycle bin) (also global ManageProject permission is needed)
* Permanently deleting models and projects (remove from the recycle bin)
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]|| || ||
||[[File:Tick.gif|center]]|| || ||[[File:Tick.gif|center]]|| || ||
|-
|-
||'''Manage scrips'''<br>(ManageScripts)||
||'''Manage scrips'''<br>(ManageScripts)||
* As a project role, create, modify and delete scripts in ''project'' and ''model'' context.
* Create, modify and delete scripts in the project.
* As a global role, create, modify and delete all scripts.
 
This permission to be effective requires also the RunScript permission.
||[[File:Tick.gif|center]]
||[[File:Tick.gif|center]]
|| || ||[[File:Tick.gif|center]]|| || ||
|| || ||[[File:Tick.gif|center]]|| || ||
|-
|-
||'''Manage operations'''<br>(ManageOperations)||
||'''Manage&nbsp;operations'''<br>(ManageOperations)||
* View operations from all users in the [[QPR ProcessAnalyzer Operation Log]]
* View the [[QPR_ProcessAnalyzer_Logs#Task_Log|Task log]]
* Terminate in progress operations run by any user
* Terminate in progress tasks run by any user
||[[File:Tick.gif|center]]|| || || || || ||
||[[File:Tick.gif|center]]|| || || || || ||
|-
|-
||'''Manage users'''<br>(ManageUsers)||
||'''Manage users'''<br>(ManageUsers)||
* Administrate users and groups, e.g. create new users and groups, and add users to groups.
* Manage users, groups, roles and permissions. Also changing any user password is possible. Note that with this permission, user can assign any permissions to itself.
||[[File:Tick.gif|center]]|| || || || || ||
||[[File:Tick.gif|center]]|| || || || || ||
|-
|-
||'''Create model'''<br>(CreateModel)||
||'''Create model'''<br>(CreateModel)||
* Create projects, models and datatables. When a project is created, the creator gets project Administrator role for the project (giving full permissions to the project).
* Create projects, models and datatables. When a project is created, the user gets project Administrator role for the project (giving full permissions to the project).
||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||||||||||
||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||||||||||
|-
|-
||'''SQL scripting'''<br>(RunScripts)||
||'''SQL scripting'''<br>(RunScripts)||
* View [[Data_Extraction,_Transformation,_and_Loading|scripts]] code and other script properties (with additional restrictions listed below)
* Run SQL scripts in sandbox.
* Run scripts (with additional restrictions listed below)
* Create, modify and delete scripts that are in user's own context.
 
The rights depend also in which of the following '''contexts''' the script is located:
* '''project''': To view scripts that are in ''project'' or ''model'' context, user needs to have the ''GenericRead'' for the project.
* '''user''': Only the user itself can view, create, modify and delete scripts that are in the user's own context (except users with global ''ManageScripts'' permission can see scripts in other users' context).
* '''system''': All users with ''RunScripts'' can see scripts in the ''system'' context.
|||| ||[[File:Tick.gif|center]]|||| || ||
|||| ||[[File:Tick.gif|center]]|||| || ||
|}
|}


== Datatable Permission ==
== User Management Concepts ==
Permissions required for datatables:
 
* List datatables, view datatable properties and data contents: '''GenericRead''' for the project.
[[File:User management schema.png|right|800px]]
* Create datatable: '''GenericWrite''' for the project and global '''CreateModel'''.
 
* Change datatable properties and import data to datatable: '''GenericWrite''' for the project.
User management in QPR ProcessAnalyzer is based on the following concepts (which are also illustrated in the diagram on the right):
* Move datatable between projects: '''GenericWrite''' and '''DeleteModel''' to source project, '''GenericWrite''' for target project, and global '''CreateModel'''.
* '''User''': Each person using the system should have an own user account. When a successful authentication has been made a ''session'' is created for a certain user. In addition to groups, roles can be assigned directly to users.
* Delete datatable (permanently): '''GenericWrite''' and '''DeleteModel''' for the project.
* '''Group''': Group contain selected roles and also selected users are assigned to the group, giving the roles to those users. Groups make managing users easier.
* '''Role''': Role contains specific permissions and thus giving certain kind of rights in the system. There are commonly used roles available in QPR ProcessAnalyzer, and additionally new roles can be created for customized use cases. Roles can be divided into two types:
** '''Global role''' are used to give rights in the entire QPR ProcessAnalyzer system.
** '''Project role''' are used to give rights in a certain project. When assigning projects roles, the project is also defined.
* '''Permission''': Permission defines what user can do (e.g. read, create, modify, delete) to certain kinds of objects. Permissions are fixes in the system, i.e. new permissions cannot be added by users.
 
The diagram also includes term ''role assignment'' which links one user/group (either of those), one project, and one role together.
 
(In the diagram, ''0..N'' means that an entity is linked to none, one or several other entities, ''1..N'' means that an entity is linked one or several other entities, and ''1'' means that the linkage is always to a single entity.)


== Dashboard Permissions ==
== Dashboard Permissions ==
Line 99: Line 94:
* Move dashboard: '''EditDashboards''' for the original project and for the target project.
* Move dashboard: '''EditDashboards''' for the original project and for the target project.
* Delete dashboard (permanently): '''EditDashboards''' for the project.
* Delete dashboard (permanently): '''EditDashboards''' for the project.
== Filter Permissions ==
* View own private filters, all published filters and model default filter: '''GenericRead''' for the project.
* View all filters: '''ManageViews''' for the project.
* Create filter: '''Filtering''' for the project.
* Edit own filter: '''Filtering''' for the project.
* Edit all filters: '''ManageViews''' for the project.
* Publish own filter: '''Filtering''' for the project.
* Publish all filters: '''ManageViews''' for the project.
* Delete own filter (permanently): '''Filtering''' for the project.
* Delete all filters (permanently): '''ManageViews''' for the project.
* Set model default filter: '''ManageViews''' for the project.


== Model Permissions ==
== Model Permissions ==
* View model: '''GenericRead''' for the project.
* View model: '''GenericRead''' for the project.
* Create model: global '''CreateModel'''.
* Create model: '''GenericRead''' and '''GenericWrite''' for the project and global '''CreateModel'''.
* Import model from pacm file: '''GenericRead''', '''GenericWrite''' and '''ManageViews''' for the project and global '''CreateModel'''.
* Change model properties (e.g. name): '''GenericRead''' and '''GenericWrite''' for the project.
* Change model properties (e.g. name): '''GenericRead''' and '''GenericWrite''' for the project.
* Move model: '''GenericRead''' for the original project, and '''CreateModel''' for the target project.
* Move model: '''GenericRead''' and '''DeleteModel''' for the source project, and '''GenericRead''' and '''GenericWrite''' for the target project.
* Delete model (to bin): '''GenericRead''' and '''DeleteModel''' for the project.
* Delete model (to bin): '''GenericRead''' and '''DeleteModel''' for the project.
* Delete model (permanently): global '''DeleteModel'''.
* Delete model (permanently): global '''DeleteModel'''.
* Copy model: Global '''CreateModel''' permission and '''GenericRead''' for the copied model.
* Copy model: '''GenericRead''' and '''GenericWrite''' for the project and global '''CreateModel'''.
* Initiate model loading: '''GenericRead''' for the project (*).
 
(*) The model loading might also require other permissions, e.g. access to the datatables or permissions required by the commands in the loading script. Models are not loaded using the permissions of the initiating user, but instead models are loaded in the following security context: '''GenericRead''' and '''GenericWrite''' for the project, global '''RunScripts'''. Models might also be loaded automatically during the server startup and this behavior ensures consistency regardless on how the model was loaded.


== Project Permissions ==
== Project Permissions ==
* View project: '''GenericRead''' for the project. (There are separate permissions for viewing different type of objects in the project.)
* View project: '''GenericRead''' for the project. (There are separate permissions for viewing dashboards/models/datatables/scripts in the project.)
* Create project: global '''CreateModel'''.
* Create project: global '''CreateModel''', and '''GenericRead''' for the parent project (if creating a child project).
* Change project properties (e.g. name): '''GenericRead''' and '''ManageProject''' for the project.
* Change project properties (e.g. name): '''GenericRead''' and '''ManageProject''' for the project.
* Move project: '''ManageProject''' for the moved project, '''GenericRead''' for the original parent project, and '''CreateModel''' for the target parent project.
* Move project: global '''CreateModel''', '''ManageProject''' for the moved project, '''GenericRead''' for the original parent project, and '''GenericRead''' for the target parent project (if target is not root level).
* Delete project (to bin): '''ManageProject''' and '''DeleteModel''' for the project.
* Delete project (to bin): '''ManageProject''' and '''DeleteModel''' for the project.
* Delete project (permanently): global '''DeleteModel''' and '''ManageProject''' permission for the project.
* Delete project (permanently): global '''DeleteModel''' and '''ManageProject''' permission for the project.
* Copy project: Global '''CreateModel''' permission, and '''GenericRead''' and '''ManageProject''' for the copied project.
* Copy project: Global '''CreateModel''' permission, and '''GenericRead''' and '''ManageProject''' for the copied project.


== SQL Scripting Permissions ==
Note: Projects hierarchy doesn't generally affect the permissions, e.g., to see a project, permissions to its parent project are not required.
* View and run system script: global '''RunScripts'''
 
* View and run project script: global '''RunScripts''' and '''GenericRead''' for the project.
== Datatable Permission ==
* Create, edit and delete system script: global '''RunScripts''' and global '''ManageScripts'''
* List datatables, view datatable properties and data contents: '''GenericRead''' for the project.
* Create, edit and delete project script: global '''RunScripts''' and '''ManageScripts''' for the project.
* Create datatable: '''GenericWrite''' for the project and global '''CreateModel'''.
* Change datatable properties, import data to datatable, modify/delete datatable rows, add/modify/delete datatable columns: '''GenericWrite''' for the project.
* Move datatable between projects: '''GenericWrite''' and '''DeleteModel''' to source project, '''GenericWrite''' for target project, and global '''CreateModel'''.
* Delete datatable (permanently): '''GenericWrite''' and '''DeleteModel''' for the project.


== Expression Scripting Permissions (future) ==
== Filter Permissions ==
* View project script: '''GenericRead''' for the project.
* View own private filters, all published filters, and model default filter: '''GenericRead''' for the project.
* Run project script: '''RunScripts''' for the project.
* View all filters: '''ManageViews''' for the project.
* Create, edit and delete project script: '''ManageScripts''' for the project.
* Create filter: '''Filtering''' for the project.
* View system script: global '''GenericRead'''.
* Edit own filters: '''Filtering''' for the project.
* Run system script: global '''RunScripts'''.
* Edit all filters: '''ManageViews''' for the project.
* Create, edit and delete system  script: global '''ManageScripts'''.
* Publish own filters: '''Filtering''' for the project.
* Publish all filters: '''ManageViews''' for the project.
* Delete own filters (permanently): '''Filtering''' for the project.
* Delete any filters (permanently): '''ManageViews''' for the project.
* Set model default filter: '''ManageViews''' for the project.


== Group Roles ==
Note: When a filter is published, the filter still has owner which is applied for the permissions.
{| style="color:black; cellpadding="10" class="wikitable"
!||Group administrator||Normal member||Hidden Member
|-
|Add and remove group members||[[File:Tick.gif|center]]||||
|-
|Create users to group||[[File:Tick.gif|center]] || ||
|-
|Add and remove project access rights of a user||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||
|-
|Open model accessible to group members||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]
|-
|See unhidden group members||[[File:Tick.gif|center]]||[[File:Tick.gif|center]]||
|-
|See hidden group members||[[File:Tick.gif|center]]|| ||
|}


If a group member is a project '''Administrator''', the user can add and remove project specific access rights for the group or for any individual member of the project.
== Script Permissions ==
* View, call and run expression script: '''GenericRead''' for the project.
* Create, edit and delete expression script: '''ManageScripts''' for the project.
* View, call and run SQL script: global '''RunScripts''' and '''GenericRead''' for the project.
* Create, edit and delete SQL script: global '''RunScripts''' and '''ManageScripts''' for the project.


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Latest revision as of 20:55, 24 April 2024

QPR ProcessAnalyzer has a role-based access control, where all operations require appropriate rights in order to be executable. Rights are given to users and groups' by assigning roles to them. Roles are a collection of permissions. Permissions are fixed in QPR ProcessAnalyzer allowing certain operations to be done. Some roles are project roles meaning that role (and its permissions) is applicable only for that project. Roles can also be global which gives rights to all projects in the system. Users belonging to a group, have all the roles assigned to that group.

Roles and Permissions

By default, QPR ProcessAnalyzer system contains roles that are shown in the following table (roles are as columns). The roles have been mapped to certain permissions that are also shown in the following table (permissions are as rows).

Global roles Project roles
Permission Allowed operations Administrator Create models SQL Scripting Administrator Designer Analyzer Viewer
View dashboards
(GenericRead)
  • View project's and model's information (name, description, configuration etc.)
  • List datatables and view their contents
  • Open dashboards (queries made by the dashboards are still restricted by the permissions)
  • Run analyses for model and view the analysis results
  • See own private filters, all published filters and the model default filter (not allowed to create/modify/delete filters)
Tick.gif
Tick.gif
Tick.gif
Tick.gif
Tick.gif
Save filters
(Filtering)
  • Create, modify and delete own filters (private and public, but not model default)
  • Publish own private filters for other users (but not set the model default filter). Published filters are still user's own, so other users cannot modify them.
Tick.gif
Tick.gif
Tick.gif
Tick.gif
Design dashboards
(EditDashboards)
  • Create, modify and delete dashboards in the project.
Tick.gif
Tick.gif
Tick.gif
Tick.gif
Import data
(GenericWrite)
  • Import data to datatables, modify/remove rows in datatable, add/modify/remove columns in datatable
  • Create, edit, delete design diagrams
  • Edit model settings (but not possible to create or delete models)
Tick.gif
Tick.gif
Tick.gif
Manage filters
(ManageViews)
  • View, create, modify and delete all filters in the model (also other users' private filters).
  • Set the model default filter.
Tick.gif
Tick.gif
Manage project
(ManageProject)
  • Modify project information, such as name and description.
Tick.gif
Tick.gif
Delete models
(DeleteModel)

As a project specific permission:

  • Moving model to recycle bin (soft deleting)
  • Delete datatables (for datatables deletion is always permanent)

As a global permission:

  • Permanently deleting models and projects (remove from the recycle bin)
Tick.gif
Tick.gif
Manage scrips
(ManageScripts)
  • Create, modify and delete scripts in the project.
Tick.gif
Tick.gif
Manage operations
(ManageOperations)
  • View the Task log
  • Terminate in progress tasks run by any user
Tick.gif
Manage users
(ManageUsers)
  • Manage users, groups, roles and permissions. Also changing any user password is possible. Note that with this permission, user can assign any permissions to itself.
Tick.gif
Create model
(CreateModel)
  • Create projects, models and datatables. When a project is created, the user gets project Administrator role for the project (giving full permissions to the project).
Tick.gif
Tick.gif
SQL scripting
(RunScripts)
  • Run SQL scripts in sandbox.
Tick.gif

User Management Concepts

User management schema.png

User management in QPR ProcessAnalyzer is based on the following concepts (which are also illustrated in the diagram on the right):

  • User: Each person using the system should have an own user account. When a successful authentication has been made a session is created for a certain user. In addition to groups, roles can be assigned directly to users.
  • Group: Group contain selected roles and also selected users are assigned to the group, giving the roles to those users. Groups make managing users easier.
  • Role: Role contains specific permissions and thus giving certain kind of rights in the system. There are commonly used roles available in QPR ProcessAnalyzer, and additionally new roles can be created for customized use cases. Roles can be divided into two types:
    • Global role are used to give rights in the entire QPR ProcessAnalyzer system.
    • Project role are used to give rights in a certain project. When assigning projects roles, the project is also defined.
  • Permission: Permission defines what user can do (e.g. read, create, modify, delete) to certain kinds of objects. Permissions are fixes in the system, i.e. new permissions cannot be added by users.

The diagram also includes term role assignment which links one user/group (either of those), one project, and one role together.

(In the diagram, 0..N means that an entity is linked to none, one or several other entities, 1..N means that an entity is linked one or several other entities, and 1 means that the linkage is always to a single entity.)

Dashboard Permissions

  • View dashboard: EditDashboards for the project.
  • Create dashboard: EditDashboards for the project.
  • Edit dashboard: EditDashboards for the project.
  • Move dashboard: EditDashboards for the original project and for the target project.
  • Delete dashboard (permanently): EditDashboards for the project.

Model Permissions

  • View model: GenericRead for the project.
  • Create model: GenericRead and GenericWrite for the project and global CreateModel.
  • Import model from pacm file: GenericRead, GenericWrite and ManageViews for the project and global CreateModel.
  • Change model properties (e.g. name): GenericRead and GenericWrite for the project.
  • Move model: GenericRead and DeleteModel for the source project, and GenericRead and GenericWrite for the target project.
  • Delete model (to bin): GenericRead and DeleteModel for the project.
  • Delete model (permanently): global DeleteModel.
  • Copy model: GenericRead and GenericWrite for the project and global CreateModel.
  • Initiate model loading: GenericRead for the project (*).

(*) The model loading might also require other permissions, e.g. access to the datatables or permissions required by the commands in the loading script. Models are not loaded using the permissions of the initiating user, but instead models are loaded in the following security context: GenericRead and GenericWrite for the project, global RunScripts. Models might also be loaded automatically during the server startup and this behavior ensures consistency regardless on how the model was loaded.

Project Permissions

  • View project: GenericRead for the project. (There are separate permissions for viewing dashboards/models/datatables/scripts in the project.)
  • Create project: global CreateModel, and GenericRead for the parent project (if creating a child project).
  • Change project properties (e.g. name): GenericRead and ManageProject for the project.
  • Move project: global CreateModel, ManageProject for the moved project, GenericRead for the original parent project, and GenericRead for the target parent project (if target is not root level).
  • Delete project (to bin): ManageProject and DeleteModel for the project.
  • Delete project (permanently): global DeleteModel and ManageProject permission for the project.
  • Copy project: Global CreateModel permission, and GenericRead and ManageProject for the copied project.

Note: Projects hierarchy doesn't generally affect the permissions, e.g., to see a project, permissions to its parent project are not required.

Datatable Permission

  • List datatables, view datatable properties and data contents: GenericRead for the project.
  • Create datatable: GenericWrite for the project and global CreateModel.
  • Change datatable properties, import data to datatable, modify/delete datatable rows, add/modify/delete datatable columns: GenericWrite for the project.
  • Move datatable between projects: GenericWrite and DeleteModel to source project, GenericWrite for target project, and global CreateModel.
  • Delete datatable (permanently): GenericWrite and DeleteModel for the project.

Filter Permissions

  • View own private filters, all published filters, and model default filter: GenericRead for the project.
  • View all filters: ManageViews for the project.
  • Create filter: Filtering for the project.
  • Edit own filters: Filtering for the project.
  • Edit all filters: ManageViews for the project.
  • Publish own filters: Filtering for the project.
  • Publish all filters: ManageViews for the project.
  • Delete own filters (permanently): Filtering for the project.
  • Delete any filters (permanently): ManageViews for the project.
  • Set model default filter: ManageViews for the project.

Note: When a filter is published, the filter still has owner which is applied for the permissions.

Script Permissions

  • View, call and run expression script: GenericRead for the project.
  • Create, edit and delete expression script: ManageScripts for the project.
  • View, call and run SQL script: global RunScripts and GenericRead for the project.
  • Create, edit and delete SQL script: global RunScripts and ManageScripts for the project.