Changes for page Managing HDC Projects

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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sgevans
1 +XWiki.dsegebarth
Content
... ... @@ -1,3 +1,7 @@
1 +{{box cssClass="floatinginfobox" title="Table of Contents"}}
2 +{{toc depth="2"/}}
3 +{{/box}}
4 +
1 1  This section of the User Guide describes the features available to Project Administrators to manage their Project.
2 2  
3 3  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//).
... ... @@ -14,7 +14,7 @@
14 14  
15 15  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).
16 16  
17 -[[image:Manage Projects Settings v2.1.5 2023-01-30.png||height="19%" width="20%"]]
21 +[[image:1723654603707-412.png||height="269" width="282"]]
18 18  
19 19  
20 20  To edit your Project’s General Information (Project Administrator role),
... ... @@ -81,7 +81,7 @@
81 81  
82 82  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.
83 83  
84 -[[image:Manage Projects Copy to Core v2.1.5 2023-01-31.png||height="10%" width="50%"]]
88 +[[image:1723654635472-816.png||height="184" width="886"]]
85 85  
86 86  1. In the Project File Explorer, open the **Green Room** and navigate to the folder where the file(s) are stored.
87 87  1. Select one or more files and/or folders to be copied by clicking the checkbox beside each one, then select **Copy to Core**.
... ... @@ -99,7 +99,7 @@
99 99  
100 100  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:
101 101  
102 -[[image:Projects Requests Left Menu v2.3.3 2023-04-26.png||height="27%" width="50%"]]
106 +[[image:1723654648402-919.png||height="301" width="558"]]
103 103  
104 104  (((
105 105  1. Click the **Requests icon** from the Project left menu bar and view the tab **Copy Data To Core Request**.
... ... @@ -109,7 +109,7 @@
109 109  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:
110 110  1*. **Approve Selected** to copy the selected files/folders to be copied to the Core.
111 111  1*. **Deny Selected** if you do not wish to copy the selected files/folders to the Core.
112 -[[image:Manage Projects Approve or Deny Copy to Core v2.1.5 2023-01-31.png||height="16%" width="50%"]]
116 +[[image:1723654669740-995.png||height="273" width="853"]]
113 113  1. A confirmation code is randomly generated. Type the code in the entry box and then click **Approve **or **Deny** to confirm your intention.
114 114  1. Another popup confirms the action was completed. Click **Close** to dismiss.
115 115  )))
... ... @@ -120,7 +120,7 @@
120 120  
121 121  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,
122 122  
123 -[[image:Manage Projects Close Copy to Core Request v2.1.5 2023-01-31.png||height="10%" width="50%"]]
127 +[[image:1723654683455-327.png||height="170" width="865"]]
124 124  
125 125  
126 126  1. Click **Close Request & Notify User**.
... ... @@ -147,7 +147,7 @@
147 147  
148 148  Project Administrators have the flexibility to add or remove Project members, and change users' roles within the Project.
149 149  
150 -[[image:Manage Projects Members v2.1.5 2023-01-30.png||height="19%" width="20%"]]
154 +[[image:1723654696855-544.png||height="326" width="342"]]
151 151  
152 152  
153 153  To manage Project membership for your Project as Project Administrator role,
... ... @@ -160,7 +160,7 @@
160 160  
161 161  Project Administrators can add new members to the Project:
162 162  
163 -[[image:Manage Projects Add Member v2.1.5 2023-02-01.png||height="6%" width="50%"]]
167 +[[image:1723654713217-983.png||height="111" width="869"]]
164 164  
165 165  
166 166  1. Launch your Project and open the **Project Members** page, then click **+ Add Member**.
... ... @@ -187,7 +187,7 @@
187 187  |Download files from own Project Green Room folder|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
188 188  |Download files from any Project Green Room folder|(% style="text-align:center" %)☑️ Allowed| |
189 189  |Request file copy from Green Room to Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed| |
190 -|Copy files 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| |
191 191  |(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Core Room File Operations**
192 192  | |(% 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**
193 193  |Access own files in Project Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
... ... @@ -209,9 +209,9 @@
209 209  | |(% 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**
210 210  |Access Jupyterhub|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
211 211  |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" %)
212 212  |Access XWiki|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
213 213  
214 -
215 215  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.
216 216  
217 217  == Viewing Project Member Profiles and Account Activities ==
... ... @@ -255,7 +255,7 @@
255 255  
256 256  As Project Administrator, you can check the deployment status of Workspace tools by opening the Project **Settings** page and clicking the **Workspace** tab.
257 257  
258 -[[image:Manage Projects Workspace Deployment v2.1.5 2023-02-02 1517.png||height="24%" width="50%"]]
262 +[[image:1723654733035-792.png||height="409" width="869"]]
259 259  
260 260  
261 261  If you need a Workspace tool deployed for the project, please contact a Platform Administrator.
... ... @@ -264,6 +264,35 @@
264 264  
265 265  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.
266 266  
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 +
267 267  == XWiki ==
268 268  
269 269  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.
... ... @@ -272,7 +272,7 @@
272 272  
273 273  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.
274 274  
275 -[[image:Manage Projects Announcements v2.1.5 2023-01-30.png||height="19%" width="20%"]]
308 +[[image:1723654770127-448.png||height="321" width="334"]]
276 276  
277 277  
278 278  To create a Project announcement as Project Administrator,
... ... @@ -289,7 +289,7 @@
289 289  
290 290  To create a new File Attribute template for your project as Project Administrator,
291 291  
292 -[[image:Manage Projects File Attributes v2.1.5 2023-02-01.png||height="7%" width="50%"]]
325 +[[image:1723654789441-207.png||height="114" width="864"]]
293 293  
294 294  
295 295  1. Launch your Project and click on the Project **Settings **icon.
... ... @@ -318,20 +318,13 @@
318 318  
319 319  1. Launch your Project and click on the Project **Settings **icon.
320 320  1. Select the **File Attributes** tab and locate an existing template.
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 -)))
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.
335 335  1. The changes will be effective for any new File Attribute annotations.
336 336  
337 337  == Importing File Attribute Templates ==
... ... @@ -372,7 +372,7 @@
372 372  
373 373  Template created in the Project Settings menu:
374 374  
375 -[[image:Manage Projects File Attributes Example for JSON v2.1.5 2023-02-01.png||height="17%" width="50%"]]
401 +[[image:1723654813207-477.png||height="296" width="869"]]
376 376  
377 377  Corresponding JSON file format:
378 378  
... ... @@ -380,10 +380,18 @@
380 380  {"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}]}
381 381  {{/code}}
382 382  
409 += Deleting and Archiving Projects =
383 383  
411 +Please contact a Platform Administrator if you need to delete or archive your Project.
384 384  
385 385  
386 386  
415 +----
387 387  
417 +Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
388 388  
389 -
419 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
420 +
421 +
422 +
423 +
1723654603707-412.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +91.6 KB
Content
1723654635472-816.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +93.4 KB
Content
1723654648402-919.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +204.7 KB
Content
1723654669740-995.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +143.9 KB
Content
1723654683455-327.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +101.1 KB
Content
1723654696855-544.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +93.5 KB
Content
1723654713217-983.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +83.1 KB
Content
1723654733035-792.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +132.8 KB
Content
1723654749116-514.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +101.4 KB
Content
1723654770127-448.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +94.5 KB
Content
1723654789441-207.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +67.2 KB
Content
1723654813207-477.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +44.7 KB
Content
Manage Projects Approve Guacamole Access v2.1.5 2023-02-02 1627.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +489.0 KB
Content