Changes for page Managing HDC Projects

Last modified by Dennis Segebarth on 2024/08/14 17:08
From version 7.1
edited by Dennis Segebarth
on 2023/11/23 10:44
Change comment: There is no comment for this version
To version 1.16
edited by Susan Evans
on 2023/07/11 16:12
Change comment: (Autosaved)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dsegebarth
1 +XWiki.sgevans
Content
... ... @@ -1,7 +5,3 @@
1 -{{box cssClass="floatinginfobox" title="Table of Contents"}}
2 -{{toc depth="2"/}}
3 -{{/box}}
4 -
5 5  This section of the User Guide describes the features available to Project Administrators to manage their Project.
6 6  
7 7  Each Project is owned by a Project Administrator, a role analogous to an academic Principal Investigator. More than one person can hold the Project Administrator role, allowing for role delegation and backup. Creation of your own Project can be requested by submitting an inquiry (see //Contact Us//).
... ... @@ -103,7 +103,7 @@
103 103  
104 104  Project Administrators are notified about pending Copy to Core requests with a red notification dot on the **Requests icon**. The following steps describe how to review, approve, and/or deny Copy to Core requests:
105 105  
106 -[[image:Projects Requests Left Menu v2.3.3 2023-04-26.png||height="16%" width="30%"]]
102 +[[image:Projects Requests Left Menu v2.3.3 2023-04-26.png||height="27%" width="50%"]]
107 107  
108 108  (((
109 109  1. Click the **Requests icon** from the Project left menu bar and view the tab **Copy Data To Core Request**.
... ... @@ -191,7 +191,7 @@
191 191  |Download files from own Project Green Room folder|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
192 192  |Download files from any Project Green Room folder|(% style="text-align:center" %)☑️ Allowed| |
193 193  |Request file copy from Green Room to Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed| |
194 -|Copy files from Green Room to Core|(% style="text-align:center" %)☑️ Allowed| |
190 +|Copy files from Green Room to Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
195 195  |(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Core Room File Operations**
196 196  | |(% style="background-color:#edf1f4; text-align:center" %)**Project Administrator**|(% style="background-color:#edf1f4; text-align:center" %)**Project Collaborator**|(% style="background-color:#edf1f4; text-align:center" %)**Project Contributor**
197 197  |Access own files in Project Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
... ... @@ -213,9 +213,9 @@
213 213  | |(% style="background-color:#edf1f4; text-align:center" %)**Project Administrator**|(% style="background-color:#edf1f4; text-align:center" %)**Project Collaborator**|(% style="background-color:#edf1f4; text-align:center" %)**Project Contributor**
214 214  |Access Jupyterhub|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
215 215  |Access Superset|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
216 -|Access Guacamole VMs|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)
217 217  |Access XWiki|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
218 218  
214 +
219 219  Note: Be reminded that Platform Administrators hold no Project specific role, and are, therefore, not listed in the table above. However, within each Project, they have - by default - the same permissions as a Project Administrator.
220 220  
221 221  == Viewing Project Member Profiles and Account Activities ==
... ... @@ -268,35 +268,6 @@
268 268  
269 269  After Jupyterhub is deployed for the Project, members can click **Jupyterhub **in the Workspace icon group to launch their own Jupyter environment. Login is seamless with single sign-on - just click **Sign in with Keycloak**. See //Using Jupyterhub// for more details on how to use the application in the platform.
270 270  
271 -== Guacamole ==
272 -
273 -Apache Guacamole is a clientless remote desktop gateway that provides access to Project Virtual Machines (VMs). Guacamole is not automatically deployed when the Project is created. Project Administrators can submit a support request to have Guacamole and connected VMs deployed for their Project.
274 -
275 -After the Guacamole application and the VMs have been set up by a Platform Administrator, members can submit access requests for Guacamole-connected VMs (see //Using Apache Guacamole//) and Project Administrators can grant access to the requested VM(s) following the instructions below, //Granting Access to Guacamole VMs//.
276 -
277 -=== Granting Access to Guacamole VMs ===
278 -
279 -Project Administrators can grant access to Guacamole-connected Virtual Machines (VMs) requested by Project Members (including themselves).
280 -
281 -[[image:Manage Projects Approve Guacamole Access v2.1.5 2023-02-02 1627.png||height="17%" width="60%"]]
282 -
283 -1. Launch your Project and click the **Requests** icon from the Project left menu bar.
284 -1. Click the **Guacamole VM Request** tab. The table displays Project members who have requested access. The Status column differentiates users whose VM access has been previously completed from those who are waiting for access.
285 -1. Please reach out to the Platform Admin by creating a support ticket and provide the following details:
286 -1*. The project code
287 -1*. The user who shall be granted access to a VM, including the associated email address
288 -1*. The VM for which access shall be granted
289 -1. Please wait for confirmation that the VM-specific account has been created before proceeding with step 5.
290 -1. In the VM column, select one or more connected VMs and click **Confirm Selection**.
291 -1. Click **Complete** to finish the setup.
292 -1. The requester will receive an email notification that their access was granted and they can launch Guacamole to access the selected VMs.
293 -
294 -See //Using Guacamole in HDC //for more details on how to use the application in the platform.
295 -
296 -== Superset ==
297 -
298 -After Superset is deployed for the Project, members can click **Superset **in the Workspace icon group to launch their own Superset instance. Login is seamless with single sign-on, and users will have access to the visualization tools to design charts and visualizations, and the SQL lab to query the data in the project-specific database. See //Using Superset// for more details on how to use the application in the platform.
299 -
300 300  == XWiki ==
301 301  
302 302  After XWiki is deployed for the Project, members can click **XWiki** in the Workspace icon group to launch the application and be logged in seamlessly with single sign-on. See //Using XWiki// for more details on how to use the application in the platform.
... ... @@ -351,13 +351,20 @@
351 351  
352 352  1. Launch your Project and click on the Project **Settings **icon.
353 353  1. Select the **File Attributes** tab and locate an existing template.
354 -1. Click an available action:
355 -1*. **Rename**: When an Attribute template is renamed, all Files annotated with the template will show the new template name. Click **Save**, or **Cancel **to exit without making the change.
356 -1*. **Delete**: An Attribute template can only be deleted if it has not yet been used to annotate any files.
357 -1*. **Export**: Click to download the Attributes template as a JSON file.
358 -1*. **Add Attribute**: Attributes denoted as Optional can be added to the template, as described above in step 4 of the section //Creating a File Attribute Template//. Click the **checkmark **to save each addition.
359 -1**. Attributes denoted as Mandatory cannot be added.
360 -1**. Existing attributes cannot be edited or removed.
321 +1. (((
322 +Click an available action:
323 +
324 +1. **Rename**: When an Attribute template is renamed, all Files annotated with the template will show the new template name. Click **Save**, or **Cancel **to exit without making the change.
325 +1. **Delete**: An Attribute template can only be deleted if it has not yet been used to annotate any files.
326 +1. **Export**: Click to download the Attributes template as a JSON file.
327 +1.
328 +
329 +**Add Attribute**: Attributes denoted as Optional can be added to the template, as described above in step 4 of the section //Creating a File Attribute Template//. Click the **checkmark **to save each addition.
330 +
331 +1.
332 +1*. Attributes denoted as Mandatory cannot be added.
333 +1*. Existing attributes cannot be edited or removed.
334 +)))
361 361  1. The changes will be effective for any new File Attribute annotations.
362 362  
363 363  == Importing File Attribute Templates ==
... ... @@ -406,19 +406,10 @@
406 406  {"attributes":[{"name":"Group","options":["A","B","C","D"],"type":"multiple_choice","optional":true},{"name":"FaveMeal","options":["breakfast","lunch","dinner"],"type":"multiple_choice","optional":false},{"name":"FaveFruit","options":["apples","oranges","strawberries","bananas","other"],"type":"multiple_choice","optional":true},{"name":"OtherFaveFruit","type":"text","optional":true}]}
407 407  {{/code}}
408 408  
409 -= Deleting and Archiving Projects =
410 410  
411 -Please contact a Platform Administrator if you need to delete or archive your Project.
412 412  
413 413  
414 414  
415 -----
416 416  
417 -Copyright © 2023 [[Indoc Systems>>url:https://www.indocsystems.com]].
418 418  
419 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
420 -
421 -
422 -
423 -
424 424  
Manage Projects Approve Guacamole Access v2.1.5 2023-02-02 1627.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.sgevans
Size
... ... @@ -1,1 +1,0 @@
1 -489.0 KB
Content