Difference between revisions of "Users' Management"

From Gcube Wiki
Jump to: navigation, search
m (Roles Management)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''DEPRECATED'''
 
 
 
The Users and Groups Management Portlet provides the functionality for managing the available users and groups for each VO/VRE. This portlet can only by accessed by users with the "VO-Admin" role at VO level and with the "VRE-Manager" role at VRE level<br>
 
The Users and Groups Management Portlet provides the functionality for managing the available users and groups for each VO/VRE. This portlet can only by accessed by users with the "VO-Admin" role at VO level and with the "VRE-Manager" role at VRE level<br>
  
[[File:Ump_main.png]]
+
[[File:Ump main 1-request.png|800px]]
  
=== User Guide ===
+
= User Guide =
  
 
The portlet is divided into 2 main tabs offering distinct functionality for the management of users and groups respectively.
 
The portlet is divided into 2 main tabs offering distinct functionality for the management of users and groups respectively.
  
==== Users Management ====
+
== Users Management ==
Users belonging to the VO/VRE can be management here. For every user the following information is available in a table view and you can see additional information by simply clicking on the desired row.
+
Users belonging to the VO/VRE can be managed here. For every user the following information is available in a table view and you can see additional information by simply clicking on the desired row.
 
* username: user's username
 
* username: user's username
 
* email: user's email address
 
* email: user's email address
Line 19: Line 17:
 
* validation date: date user has been added to the VO/VRE
 
* validation date: date user has been added to the VO/VRE
 
* acceptance manager: who added the user to the VO/VRE
 
* acceptance manager: who added the user to the VO/VRE
 +
 +
When the available information is not shown completely a balloon is displayed if you point the specific field with the cursor.
 +
 +
[[Image:Ump-aditional info bubble.png|800px]]
 +
 +
The following image shows how user's details are displayed:
 +
[[Image:Ump-details modal.png|800px]]
  
 
When you select one or more rows the following options are activated:
 
When you select one or more rows the following options are activated:
Line 25: Line 30:
 
* Assign Roles: Assign roles to the selected users
 
* Assign Roles: Assign roles to the selected users
 
* Add to Group: Add the selected users to any of the available groups
 
* Add to Group: Add the selected users to any of the available groups
* Delete Selected: Remove the selected users from the VO/VRE
+
* Delete Selected: Remove the selected users from the VO/VRE. You have the option to send a custom message to the user being removed from the VO/VRE
 +
 
 +
These options are displayed on the top of the table as you can see below:
 +
[[Image:Ump-user selected-options.png|800px]]
 +
 
 +
=== Edit User Info ===
 +
Clicking on  ''Edit Selected'' you can edit users' roles and groups. A modal is displayed showing the current roles and groups and you can perform any change.
 +
 
 +
[[Image:Ump-mass edit users.png|800px]]
 +
 
 +
* The same options are available separately by clicking on the ''Assign Roles'' or ''Add to Group'' options.
 +
 
 +
=== Manage Join Requests ===
 +
Requests for joining the VO/VRE are displayed on the top right corner of the users management tab. In order to manage these requests you should click on them and a window appears showing all the requests.
 +
 
 +
[[File:Ump main 1-request.png|800px]]
 +
 
 +
You can decide which users will be added or rejected from the VO/VRE. Multiple acceptance/rejection is available by first selecting the requests and then click on the ''Accept Selected'' or ''Reject Selected'' option on the top of the window. Alternatively you can accept or reject all requests by clicking on the ''Accept All'' / ''Reject All'' options at the bottom right corner. Both options are highlighted in the following image.
 +
 
 +
[[File:Ump requests modal.png|800px]]
 +
 
 +
=== Filter Users ===
 +
 
 +
Search is available in order to filter the available users. Start typing on the search text box and rows are automatically filtered
 +
 
 +
[[File:Ump filtered grid.png|800px]]
 +
 
 +
== Groups Management ==
 +
Managers of a VRE can create groups and assign a subset of VRE's members to them. Groups can be then used to give access to specific functionality only to their members and more.<br>
 +
 
 +
[[File:Ump-groups mgmt.png|800px]]
 +
 
 +
For every available group the following information is available:
 +
* Name: the group's name
 +
* Description: the group's description (optional)
 +
* Number of users
 +
* Creation date
 +
* Last modification date
 +
* Creator's name
 +
 
 +
By simply clicking on a group's row a window is shown listing group's members. At the bottom you have the option to click on the ''Add Users'' button in order to easily add more members to this group.
 +
 
 +
[[File:Ump group memberd add-user highlight.png|800px]]
 +
 
 +
=== Create new Group ===
 +
By clicking on the ''New Group'' option you can create a new group. A title is required and optionally you can add a description
 +
 
 +
[[File:Ump-new group.png|800px]]
 +
 
 +
=== Edit Existing Group ===
 +
You can edit the name and/or description of a group by first selecting it and then click on the ''Edit Group'' option. In addition you can delete it by clicking on the ''Delete Group'' option, as this can be seen below.
  
* The first tab - '''''Manage Registered Users''''' - is for the management of the existing users and their roles. The users that are currently registered to the VO/VRE and their roles are displayed.
+
[[File:Ump-groups options.png|800px]]
** You are able to change any user's roles. This can be done either by right clicking on the user you would like to edit and then click the '''edit roles''' option, or by checking the user you would like to edit and click on the '''Edit Selected User Roles''' button. Notice here that this button is functional only when only one user is selected.<br> A pop-up window appears listing all the available roles with prechecked the user's current assigned roles.<br> [[Image:UsersMgmtEditRolesRightClick.png]] [[Image:UsersMgmtEditRolesWindow.png]]
+
** You can remove any user from the current VO/VRE. Select the users you would like to remove and click on the '''Remove Selected Users''' button. Confirm the deletion action or click "No" in order no to apply the changes.<br> [[Image:RemoveSelUsersConfMsg.png]]
+
** You can add new users to the current VO/VRE. Click on the'''Add new Users''' button. A pop-up window appears where you can select which users will be added.
+
*** The users that appear at this list are users that do not belong to this VO/VRE and users that have already asked for registration to this VO/VRE<br>[[Image:UsersMgmtAddNewUsers.png]]<br><br>
+
** Using the filter panel you can filter the list with the available users by providing at least one criterion. If you provide more than one criteria then the list is filtered by matching all the given criteria.
+
In order to filter the grid you have to click on the '''Filter''' button. If you want to reset the filters and list again all the available users click on the '''Reset''' button.<br>
+
[[Image:UmpFilters.png]]
+
<br>
+
  
* The second tab - '''''Manage Users' Requests''''' - is for the management of the users' requests for registration. If a user that does not belong to this VO/VRE has requested to be registered to it, his/her name appears at this list and the manager can decide if this user will be added to this VO/VRE or if his/her request will be rejected.
+
== Roles Management ==
** Users can ask for registration using the login portlet. Then an email is sent to the managers who can approve this request.
+
** In order to approve some requests you have to select the users you would like to approve and then click on the '''Authorize selected users''' button.
+
** After this step you should go to the first tab in order to assign roles to the new users. A message informs the manager about the next required step.
+
** In order to reject requests you have to select the users you would like to reject and then click on the '''Remove selected users''' button. [[Image:UsersMgmtAuthorizeReqs.png]]
+
** If there are no requests for registration a information message appears. You can click on the '''Refresh''' button in order to check for new requests. [[Image:UsersMgmtNoReqs.png]]
+
<br>
+
  
* The third tab - '''''Email Notifications''''' - is for sending either automated emails by loading any of the available templates or not automated by writing your subject and body message to all registered users of the current VO/VRE.<br> [[Image:EmailNotPanel.png]]
+
By using either the [[#Edit_User_Info|Edit User Info]] or the Assign Role menu entry of the [[#Users_Management|User Management]] it is possible to assign roles to users. The following roles are supported:
** You can load any of the available templates, make some changes if needed, and send the email by clicking on the '''Send''' button.<br> [[Image:EmailNotPanelLoadTmp.png]]
+
** You can write an email in HTML format by using the rich editor that is provided
+
** You can save the resistered users' names and their emails to an external file at your desktop by clicking on the icon placed at the upright corner of the panel. This is shown at the image below.<br>[[Image:EmailNotPanelToolTip.png]]
+
  
=== Deployment Guide ===
+
* '''''Accounting Manager''''': this role is envisaged to grant the ability to use the '''[[Accounting_Portlet|Accounting Portlet]]'''.
When deploying this portlet a configuration file named: '''umPortlet-email.config''' should be created and placed under: "$CATALINA_HOME/shared/d4s" directory.
+
** This role is no '''longer supported''' since in the current settings the portlet is made available for VRE Managers;
The content of this file should be: '''email.to=''EMAIL_ADDRESS''''', where ''EMAIL_ADDRESS'' is the email that will be used in the '''TO''' field from the portlet's email system. <br>
+
* '''''Catalogue Admin''''': this role is envisaged to manage the '''[[GCube_Resource_Catalogue|Resource Catalogue]]''' serving the VRE (if any). In particular, users with this role can
 +
** view the private items;
 +
** publish new items;
 +
** edit or delete any of the VRE items;
 +
** make items public or private.
 +
* '''''Catalogue Editor''''': this role is envisaged to manage the '''[[GCube_Resource_Catalogue|Resource Catalogue]]''' serving the VRE (if any). In particular, users with this role can 
 +
** view the private items;
 +
** publish new items;
 +
** edit or delete the items they are owner of;
 +
* '''''Data Manager''''': this role is envisaged to grant the ability to deal with data management tasks. 
 +
** This role is no '''longer supported''' since it has been specialized to specific roles when needed, e.g. Catalogue Admin/Manager;
 +
* '''''Infrastructure Manager''''': this role is envisaged to grant the ability to manage all aspects of an entire '''[[Administrator%27s_Guide#Infrastructure_Deployment_and_Daily_Management|gCube-based Infrastructure]]'''.
 +
** It is recommended to '''not assign this role to VRE members''';
 +
* '''''Site Administrator''''': this role corresponds to the '''Liferay role'''. The Site Administrator role grants the ability to manage almost all aspects of a site (i.e. a VRE) including site content, site memberships, and site settings. Site Administrators cannot delete the membership of or remove roles from other Site Administrators or Site Owners. They also cannot assign other users as Site Administrators or Site Owners.
 +
** It is recommended to '''not assign this role to VRE members''';
 +
* '''''Site Editor''''': this role corresponds to the '''Liferay role'''. The Site Editor role grants the ability to manage site content, e.g. edit existing pages in a VRE;
 +
** It is recommended to '''not assign this role to VRE members''';
 +
* '''''Site Member''''': this role corresponds to the '''Liferay role'''. The Site Member role grants basic privileges within a site (i.e. a VRE), such as the ability to visit the site’s private pages. All the VRE Members are Site Member;
 +
* '''''Site Owner''''': this role corresponds to the '''Liferay role'''. The Site Owner role is the same as the Site Administrator role except that it grants the ability to manage all aspects of a site (a VRE), including the ability to delete the membership of or remove roles from Site Administrators or other Site Owners. They can assign other users as Site Administrators or Site Owners.
 +
** It is recommended to '''not assign this role to VRE members''';
 +
* '''''VO Admin''''': this role is envisaged to grant the ability to manage almost all aspects of a '''[[Administrator%27s_Guide#Virtual_Organisation_Management|Virtual Organization]]'''.
 +
** It is recommended to '''not assign this role to VRE members''';
 +
* '''''VRE Designer''''': this role is envisaged to manage the '''[[VRE_Administration|VREs Management]]'''. Users with this role can
 +
** define a VRE (when assigned to a user at VO Level);
 +
* '''''VRE Manager''''': this role is envisaged to manage the '''[[VRE_Administration|VREs Management]]'''. Users with this role can
 +
** create, edit, a VRE (when assigned at VO Level)
 +
** manage VRE users (e.g. approve / reject membership requests, assign roles, create and manage groups);
  
* '''NOTE:''' This file is not mandatory. If it is not available, then the sender's email address will be used in the '''TO''' field.
+
== Deployment Guide ==
 +
The portlet is part of the gcube portal bundle. Downloading and installing the bundle will also make this portlet ready to use.

Latest revision as of 11:31, 21 May 2018

The Users and Groups Management Portlet provides the functionality for managing the available users and groups for each VO/VRE. This portlet can only by accessed by users with the "VO-Admin" role at VO level and with the "VRE-Manager" role at VRE level

Ump main 1-request.png

User Guide

The portlet is divided into 2 main tabs offering distinct functionality for the management of users and groups respectively.

Users Management

Users belonging to the VO/VRE can be managed here. For every user the following information is available in a table view and you can see additional information by simply clicking on the desired row.

  • username: user's username
  • email: user's email address
  • full name: user's full name
  • roles: user's assigned roles for the current VO/VRE
  • groups: user's belonging groups for the current VO/VRE
  • request date: date user requested to join the VO/VRE
  • validation date: date user has been added to the VO/VRE
  • acceptance manager: who added the user to the VO/VRE

When the available information is not shown completely a balloon is displayed if you point the specific field with the cursor.

Ump-aditional info bubble.png

The following image shows how user's details are displayed: Ump-details modal.png

When you select one or more rows the following options are activated:

  • Deselect All: unselects the selected rows
  • Edit Selected: Edit the selected users' roles and groups. You have the option to remove the pre-existing roles and groups before adding the new ones
  • Assign Roles: Assign roles to the selected users
  • Add to Group: Add the selected users to any of the available groups
  • Delete Selected: Remove the selected users from the VO/VRE. You have the option to send a custom message to the user being removed from the VO/VRE

These options are displayed on the top of the table as you can see below: Ump-user selected-options.png

Edit User Info

Clicking on Edit Selected you can edit users' roles and groups. A modal is displayed showing the current roles and groups and you can perform any change.

Ump-mass edit users.png

  • The same options are available separately by clicking on the Assign Roles or Add to Group options.

Manage Join Requests

Requests for joining the VO/VRE are displayed on the top right corner of the users management tab. In order to manage these requests you should click on them and a window appears showing all the requests.

Ump main 1-request.png

You can decide which users will be added or rejected from the VO/VRE. Multiple acceptance/rejection is available by first selecting the requests and then click on the Accept Selected or Reject Selected option on the top of the window. Alternatively you can accept or reject all requests by clicking on the Accept All / Reject All options at the bottom right corner. Both options are highlighted in the following image.

Ump requests modal.png

Filter Users

Search is available in order to filter the available users. Start typing on the search text box and rows are automatically filtered

Ump filtered grid.png

Groups Management

Managers of a VRE can create groups and assign a subset of VRE's members to them. Groups can be then used to give access to specific functionality only to their members and more.

Ump-groups mgmt.png

For every available group the following information is available:

  • Name: the group's name
  • Description: the group's description (optional)
  • Number of users
  • Creation date
  • Last modification date
  • Creator's name

By simply clicking on a group's row a window is shown listing group's members. At the bottom you have the option to click on the Add Users button in order to easily add more members to this group.

Ump group memberd add-user highlight.png

Create new Group

By clicking on the New Group option you can create a new group. A title is required and optionally you can add a description

Ump-new group.png

Edit Existing Group

You can edit the name and/or description of a group by first selecting it and then click on the Edit Group option. In addition you can delete it by clicking on the Delete Group option, as this can be seen below.

Ump-groups options.png

Roles Management

By using either the Edit User Info or the Assign Role menu entry of the User Management it is possible to assign roles to users. The following roles are supported:

  • Accounting Manager: this role is envisaged to grant the ability to use the Accounting Portlet.
    • This role is no longer supported since in the current settings the portlet is made available for VRE Managers;
  • Catalogue Admin: this role is envisaged to manage the Resource Catalogue serving the VRE (if any). In particular, users with this role can
    • view the private items;
    • publish new items;
    • edit or delete any of the VRE items;
    • make items public or private.
  • Catalogue Editor: this role is envisaged to manage the Resource Catalogue serving the VRE (if any). In particular, users with this role can
    • view the private items;
    • publish new items;
    • edit or delete the items they are owner of;
  • Data Manager: this role is envisaged to grant the ability to deal with data management tasks.
    • This role is no longer supported since it has been specialized to specific roles when needed, e.g. Catalogue Admin/Manager;
  • Infrastructure Manager: this role is envisaged to grant the ability to manage all aspects of an entire gCube-based Infrastructure.
    • It is recommended to not assign this role to VRE members;
  • Site Administrator: this role corresponds to the Liferay role. The Site Administrator role grants the ability to manage almost all aspects of a site (i.e. a VRE) including site content, site memberships, and site settings. Site Administrators cannot delete the membership of or remove roles from other Site Administrators or Site Owners. They also cannot assign other users as Site Administrators or Site Owners.
    • It is recommended to not assign this role to VRE members;
  • Site Editor: this role corresponds to the Liferay role. The Site Editor role grants the ability to manage site content, e.g. edit existing pages in a VRE;
    • It is recommended to not assign this role to VRE members;
  • Site Member: this role corresponds to the Liferay role. The Site Member role grants basic privileges within a site (i.e. a VRE), such as the ability to visit the site’s private pages. All the VRE Members are Site Member;
  • Site Owner: this role corresponds to the Liferay role. The Site Owner role is the same as the Site Administrator role except that it grants the ability to manage all aspects of a site (a VRE), including the ability to delete the membership of or remove roles from Site Administrators or other Site Owners. They can assign other users as Site Administrators or Site Owners.
    • It is recommended to not assign this role to VRE members;
  • VO Admin: this role is envisaged to grant the ability to manage almost all aspects of a Virtual Organization.
    • It is recommended to not assign this role to VRE members;
  • VRE Designer: this role is envisaged to manage the VREs Management. Users with this role can
    • define a VRE (when assigned to a user at VO Level);
  • VRE Manager: this role is envisaged to manage the VREs Management. Users with this role can
    • create, edit, a VRE (when assigned at VO Level)
    • manage VRE users (e.g. approve / reject membership requests, assign roles, create and manage groups);

Deployment Guide

The portlet is part of the gcube portal bundle. Downloading and installing the bundle will also make this portlet ready to use.