Changes for page Managing HDC Projects

Last modified by Dennis Segebarth on 2024/08/14 17:08
From version 10.1
edited by Dennis Segebarth
on 2024/08/14 17:07
Change comment: Deleted image "Manage Projects Announcements v2.1.5 2023-01-30.png"
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//).
... ... @@ -18,7 +18,7 @@
18 18  
19 19  When the Platform Administrator creates your Project, the Name and Code are assigned and other general information may have been initialized. The Project Code cannot be changed, but as a Project Administrator you can edit the other Project’s General Information in the Project **Settings **page (not available to regular Project members).
20 20  
21 -[[image:1723654603707-412.png||height="269" width="282"]]
17 +[[image:Manage Projects Settings v2.1.5 2023-01-30.png||height="19%" width="20%"]]
22 22  
23 23  
24 24  To edit your Project’s General Information (Project Administrator role),
... ... @@ -85,7 +85,7 @@
85 85  
86 86  Copying files from the //Green Room// to the //Core //can only be performed by users with the Project Administrator role in the corresponding Project, or by Platform Administrators.
87 87  
88 -[[image:1723654635472-816.png||height="184" width="886"]]
84 +[[image:Manage Projects Copy to Core v2.1.5 2023-01-31.png||height="10%" width="50%"]]
89 89  
90 90  1. In the Project File Explorer, open the **Green Room** and navigate to the folder where the file(s) are stored.
91 91  1. Select one or more files and/or folders to be copied by clicking the checkbox beside each one, then select **Copy to Core**.
... ... @@ -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:1723654648402-919.png||height="301" width="558"]]
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**.
... ... @@ -113,7 +113,7 @@
113 113  1. When at least one file or folder is selected, two options become visible at the top of the file explorer table. Click one of the following:
114 114  1*. **Approve Selected** to copy the selected files/folders to be copied to the Core.
115 115  1*. **Deny Selected** if you do not wish to copy the selected files/folders to the Core.
116 -[[image:1723654669740-995.png||height="273" width="853"]]
112 +[[image:Manage Projects Approve or Deny Copy to Core v2.1.5 2023-01-31.png||height="16%" width="50%"]]
117 117  1. A confirmation code is randomly generated. Type the code in the entry box and then click **Approve **or **Deny** to confirm your intention.
118 118  1. Another popup confirms the action was completed. Click **Close** to dismiss.
119 119  )))
... ... @@ -124,7 +124,7 @@
124 124  
125 125  After Approving or Denying every file/folder in the request, it’s time to close the request and notify the user. To close the request,
126 126  
127 -[[image:1723654683455-327.png||height="170" width="865"]]
123 +[[image:Manage Projects Close Copy to Core Request v2.1.5 2023-01-31.png||height="10%" width="50%"]]
128 128  
129 129  
130 130  1. Click **Close Request & Notify User**.
... ... @@ -151,7 +151,7 @@
151 151  
152 152  Project Administrators have the flexibility to add or remove Project members, and change users' roles within the Project.
153 153  
154 -[[image:1723654696855-544.png||height="326" width="342"]]
150 +[[image:Manage Projects Members v2.1.5 2023-01-30.png||height="19%" width="20%"]]
155 155  
156 156  
157 157  To manage Project membership for your Project as Project Administrator role,
... ... @@ -164,7 +164,7 @@
164 164  
165 165  Project Administrators can add new members to the Project:
166 166  
167 -[[image:1723654713217-983.png||height="111" width="869"]]
163 +[[image:Manage Projects Add Member v2.1.5 2023-02-01.png||height="6%" width="50%"]]
168 168  
169 169  
170 170  1. Launch your Project and open the **Project Members** page, then click **+ Add Member**.
... ... @@ -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 ==
... ... @@ -259,7 +259,7 @@
259 259  
260 260  As Project Administrator, you can check the deployment status of Workspace tools by opening the Project **Settings** page and clicking the **Workspace** tab.
261 261  
262 -[[image:1723654733035-792.png||height="409" width="869"]]
258 +[[image:Manage Projects Workspace Deployment v2.1.5 2023-02-02 1517.png||height="24%" width="50%"]]
263 263  
264 264  
265 265  If you need a Workspace tool deployed for the project, please contact a Platform Administrator.
... ... @@ -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:1723654749116-514.png||height="250" width="861"]]
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.
... ... @@ -305,7 +305,7 @@
305 305  
306 306  Project Administrators can use the **Announcements **page to send messages to all Project members to convey relevant Project news and information. Project Members can use this page to view Project announcements.
307 307  
308 -[[image:1723654770127-448.png||height="321" width="334"]]
275 +[[image:Manage Projects Announcements v2.1.5 2023-01-30.png||height="19%" width="20%"]]
309 309  
310 310  
311 311  To create a Project announcement as Project Administrator,
... ... @@ -322,7 +322,7 @@
322 322  
323 323  To create a new File Attribute template for your project as Project Administrator,
324 324  
325 -[[image:1723654789441-207.png||height="114" width="864"]]
292 +[[image:Manage Projects File Attributes v2.1.5 2023-02-01.png||height="7%" width="50%"]]
326 326  
327 327  
328 328  1. Launch your Project and click on the Project **Settings **icon.
... ... @@ -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 ==
... ... @@ -398,7 +398,7 @@
398 398  
399 399  Template created in the Project Settings menu:
400 400  
401 -[[image:1723654813207-477.png||height="296" width="869"]]
375 +[[image:Manage Projects File Attributes Example for JSON v2.1.5 2023-02-01.png||height="17%" width="50%"]]
402 402  
403 403  Corresponding JSON file format:
404 404  
... ... @@ -406,18 +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-2024 [[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 -
389 +
1723654603707-412.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -91.6 KB
Content
1723654635472-816.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -93.4 KB
Content
1723654648402-919.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -204.7 KB
Content
1723654669740-995.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -143.9 KB
Content
1723654683455-327.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -101.1 KB
Content
1723654696855-544.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -93.5 KB
Content
1723654713217-983.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -83.1 KB
Content
1723654733035-792.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -132.8 KB
Content
1723654749116-514.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -101.4 KB
Content
1723654770127-448.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -94.5 KB
Content
1723654789441-207.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -67.2 KB
Content
1723654813207-477.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -44.7 KB
Content
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
Manage Projects Announcements v2.1.5 2023-01-30.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +102.7 KB
Content