Changes for page Managing HDC Projects

Last modified by Dennis Segebarth on 2024/08/14 17:08
From version 1.6
edited by Susan Evans
on 2023/07/11 15:42
Change comment: (Autosaved)
To version 3.1
edited by Susan Evans
on 2023/07/11 16:26
Change comment: There is no comment for this version

Summary

Details

Page properties
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//).
... ... @@ -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:Projects Requests Left Menu v2.3.3 2023-04-26.png||height="16%" width="30%"]]
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**.
... ... @@ -179,141 +179,215 @@
179 179  
180 180  The following table describes available Project roles and their permissioned data and project operations:
181 181  
182 -|=(% style="background-color: rgb(1, 139, 126); color:white" %)Activity |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Administrator |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Collaborator |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Contributor
186 +|(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Green Room File Operations**
187 +| |(% 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**
188 +|Access own files in Project Green Room|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
189 +|Access all files in Project Green Room|(% style="text-align:center" %)☑️ Allowed| |
190 +|Upload and annotate files to Project Green Room|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
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 +|Download files from any Project Green Room folder|(% style="text-align:center" %)☑️ Allowed| |
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| |
195 +|(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Core Room File Operations**
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 +|Access own files in Project Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
198 +|Access all files in Project Core|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
199 +|Upload and annotate files from from Workspace to Project Core (via Command Line Interface)|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
200 +|Download files from Project Core own folder|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
201 +|Download files from Project Core any folder|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
202 +|(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**User Management**
203 +| |(% 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**
204 +|View, add, remove, manage Project members|(% style="text-align:center" %)☑️ Allowed| |
205 +|(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Project Management**
206 +| |(% 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**
207 +|Update Project Information|(% style="text-align:center" %)☑️ Allowed| |
208 +|Create and manage File Attribute templates|(% style="text-align:center" %)☑️ Allowed| |
209 +|Fulfill Project member file copy requests from Green Room to Core|(% style="text-align:center" %)☑️ Allowed| |
210 +|Approve Project member VM access requests|(% style="text-align:center" %)☑️ Allowed| |
211 +|Create Project Announcements|(% style="text-align:center" %)☑️ Allowed| |
212 +|(% style="background-color:#dcdcdc; text-align:center" %) **Activity** |(% colspan="3" style="background-color:#dcdcdc; text-align:center" %)**Workspace Tools**
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 +|Access Jupyterhub|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
215 +|Access Superset|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|
216 +|Access XWiki|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed
183 183  
184 -|= |=(% colspan="3" style="background-color: rgb(220, 220, 220)" %)**Role**| |
185 -**Project Administrator**| **Project Collaborator** |**Project Contributor**
186 -|=(% colspan="3" activity="(%" style="background-color:#dcdcdc" %)(((
187 -**Green Room File Operations**
218 +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.
219 +
220 +== Viewing Project Member Profiles and Account Activities ==
221 +
222 +Project Administrators can review the Project membership, member profiles and account activities.
223 +
224 +1. Launch your Project and open the **Project Members** page.
225 +1. Click the **Action icon** (three vertical dots) in the member’s entry in the **Members **table and click **Profile**.
226 +1. The Member Profile page displays basic profile information and history of actions in their account (invited when and by whom, date activated, role changes).
227 +
228 +== Changing Project Member Roles ==
229 +
230 +Project Administrators can change the role of any Project member other than themselves.
231 +
232 +1. Launch your Project and open the **Members **table in the **Project Members** page.
233 +1. In the member’s entry, click **Change Role **and select a new role from the dropdown menu.
234 +1. A popup window prompts you to confirm the change. Click **OK** to confirm, or **Cancel** to exit without making the change.
235 +
236 +After clicking **OK**, the role change takes effect immediately and the Project member will receive an email notification confirming their new role assignment.
237 +
238 +=== Considerations ===
239 +
240 +* Assigning a Project Member to a less privileged role may cause them to lose access to Project data they previously had access to.
241 +* As a Project Administrator you cannot change your own role, but another Project Administrator can change your role.
242 +
243 +== Removing Members from the Project ==
244 +
245 +Project Administrators can remove members from the Project.
246 +
247 +1. Launch your Project and open the **Members** table on the **Project members** page.
248 +1. Click the **Action icon** (three vertical dots) in the member’s entry and click **Delete**.
249 +1. A popup window prompts you to confirm the change. Click **OK** to confirm, or **Cancel** to exit without making the change.
250 +
251 +After clicking **OK**, the member is removed from the Project immediately. Their membership in other Projects is not affected. The member will not receive an email notification.
252 +
253 +Note: removing a member from a Project removes their access to all the Project data in the Green Room, Core, and Workspace VMs. However, the user will continue to have access to Project data held in any Datasets they have created as long as their user account is active.
254 +
255 += Managing Project Workspace Tools =
256 +
257 +Workspace tools like Jupyterhub enable your Project members to work with the Project data right within the HDC platform, fostering remote collaboration. In addition, the workspace tool XWiki allows your Project members to collaboratively work on your Project wiki documentation. Integrated Workspace tools are configured at the time of Project creation, or later, by a Platform Administrator.
258 +
259 +As Project Administrator, you can check the deployment status of Workspace tools by opening the Project **Settings** page and clicking the **Workspace** tab.
260 +
261 +[[image:Manage Projects Workspace Deployment v2.1.5 2023-02-02 1517.png||height="24%" width="50%"]]
262 +
263 +
264 +If you need a Workspace tool deployed for the project, please contact a Platform Administrator.
265 +
266 +== Jupyterhub ==
267 +
268 +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.
269 +
270 +== Superset ==
271 +
272 +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.
273 +
274 +== XWiki ==
275 +
276 +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.
277 +
278 += Creating Project Announcements =
279 +
280 +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.
281 +
282 +[[image:Manage Projects Announcements v2.1.5 2023-01-30.png||height="19%" width="20%"]]
283 +
284 +
285 +To create a Project announcement as Project Administrator,
286 +
287 +1. Launch your Project and click the **Announcements **icon in the left menu bar.
288 +1. In the **Create new announcement** window, enter your announcement (maximum length 250 characters) and click **Publish**.
289 +1. Your announcement will be visible to all Project members in **Announcements **page of the corresponding Project, as well as in their Notifications area (accessible via the orange bell icon in the navigation bar at the top of the portal website), and in their **Newsfeed **on the **Dashboard **page.
290 +
291 += Managing File Attribute Templates =
292 +
293 +Project Administrators can create and configure File Attribute templates that will be available to all Project Members to annotate files during or after upload (see //Working with HDC Project Files in the Portal// > //Adding and Modifying File Attributes//).
294 +
295 +== Creating a File Attribute Template ==
296 +
297 +To create a new File Attribute template for your project as Project Administrator,
298 +
299 +[[image:Manage Projects File Attributes v2.1.5 2023-02-01.png||height="7%" width="50%"]]
300 +
301 +
302 +1. Launch your Project and click on the Project **Settings **icon.
303 +1. Select the **File Attributes** tab and click **Create New Attribute Template**.
304 +1. Enter a name for the Template and click **Next Step.**
305 +1. (((
306 +Click **+ Add Attribute** to create a new attribute and configure the key parameters:
307 +
308 +* //Name//: Provide the name of the attribute (letters or numbers, no spaces, maximum 32 characters).
309 +* //Type: //Select the type of information to be collected (text, multiple choice). Text fields will allow entries of up to 100 characters.
310 +* //Value~:// If you selected multiple choice as type, you can define the available value options (maximum 32 characters each), pressing Enter after each entry.
311 +* //Optional~:// Specify whether the Attribute is optional or mandatory (optional by default). Uncheck the box if the Attribute is mandatory.
188 188  )))
189 -|Access own files in Project Green Room|(((
190 -☑️ Allowed
191 -)))|(((
192 -☑️ Allowed
193 -)))|(((
194 -☑️ Allowed
313 +1. Click the **checkmark **to save the new field or **X** to clear the field.
314 +1. To add more fields, repeat steps 4-5 until all fields have been added.
315 +1. Review the newly created fields for accuracy and completeness. Be sure to click the **checkmark **in the Actions column beside each field to save the entry, or **X **to discard the field. Once a field is saved, use the **Edit **or **Delete **icons to make any changes. Note: after a File Attribute template has been saved, new fields can be added to the template but existing fields cannot be edited or removed, and any new attributes added to the template must be Optional.
316 +1. Click **Create**.** **
317 +
318 +Your new File Attribute template is saved and Project Members will be able to see the template and annotate files with these Attributes. For more details on how to annotate files, see //Working with HDC Project Files in the Portal// > //Adding and Modifying File Attributes//.
319 +
320 +You can create multiple File Attribute templates for the Project, but a Project file can only be annotated with a single File Attribute template.
321 +
322 +== Managing a File Attributes Template ==
323 +
324 +After a File Attribute template has been created, a Project Administrator can make limited changes to the template, delete it, or export it as a JSON file.
325 +
326 +1. Launch your Project and click on the Project **Settings **icon.
327 +1. Select the **File Attributes** tab and locate an existing template.
328 +1. Click an available action:
329 +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.
330 +1*. **Delete**: An Attribute template can only be deleted if it has not yet been used to annotate any files.
331 +1*. **Export**: Click to download the Attributes template as a JSON file.
332 +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.
333 +1**. Attributes denoted as Mandatory cannot be added.
334 +1**. Existing attributes cannot be edited or removed.
335 +1. The changes will be effective for any new File Attribute annotations.
336 +
337 +== Importing File Attribute Templates ==
338 +
339 +Instead of using the Project **Settings **page to create Attributes template, Project Administrators can import the template configuration as a JSON file.
340 +
341 +1. On your local computer, create and save a JSON file containing your annotations, see //Formatting Guideline for JSON File Attribute Templates// below.
342 +1. Launch your Project and click on the **Settings** icon.
343 +1. Select the **File Attributes** and click **Import Attribute Template**. 
344 +1. Enter an Attribute Template name, upload the JSON file you created, then click **OK**. If there are errors in the JSON file, a parse error message will be returned. Please review the //Formatting Guideline for JSON File Attribute Templates// section below, then check your uploaded file and try again after adapting it accordingly.
345 +1. Once the file has been successfully uploaded and saved, it will be available to all Project Members to annotate files.
346 +
347 +=== Formatting Guideline for JSON File Attribute Templates ===
348 +
349 +JSON is built around two structures:
350 +
351 +* (((
352 +Objects
353 +
354 +* Key-value pairs
355 +* Surrounded by curly brackets ({})
195 195  )))
196 -|Access all files in Project Green Room|(((
197 -☑️ Allowed
198 -)))| |
199 -|Upload and annotate files to Project Green Room|(((
200 -☑️ Allowed
201 -)))|(((
202 -☑️ Allowed
203 -)))|(((
204 -☑️ Allowed
357 +* (((
358 +Arrays
359 +
360 +* Lists of items
361 +* Surrounded by square brackets ([])
205 205  )))
206 -|Download files from own Project Green Room folder|(((
207 -☑️ Allowed
208 -)))|(((
209 -☑️ Allowed
210 -)))|(((
211 -☑️ Allowed
212 -)))
213 -|Download files from any Project Green Room folder|(((
214 -☑️ Allowed
215 -)))|(((
216 -
217 -)))|
218 -|Request file copy from Green Room to Core|(((
219 -☑️ Allowed
220 -)))|(((
221 -☑️ Allowed
222 -)))|
223 -|Copy files from Green Room to Core|(((
224 -☑️ Allowed
225 -)))|(((
226 -☑️ Allowed
227 -)))|
228 -|**Activity**|(% colspan="3" %)(((
229 -**Core File Operations**
230 -)))
231 -|Access own files in Project Core|(((
232 -☑️ Allowed
233 -)))|(((
234 -☑️ Allowed
235 -)))|(((
236 -
237 -)))
238 -|Access all files in Project Core|(((
239 -☑️ Allowed
240 -)))|(((
241 -☑️ Allowed
242 -)))|
243 -|Upload and annotate files from from Workspace to Project Core (via Command Line Interface)|(((
244 -☑️ Allowed
245 -)))|(((
246 -☑️ Allowed
247 -)))|
248 -|Download files from Project Core own folder|(((
249 -☑️ Allowed
250 -)))|(((
251 -☑️ Allowed
252 -)))|
253 -|Download files from Project Core any folder|(((
254 -☑️ Allowed
255 -)))|(((
256 -☑️ Allowed
257 -)))|
258 -|**Activity**|(% colspan="3" %)(((
259 -**User Management**
260 -)))
261 -|View, add, remove, manage Project members|(((
262 -☑️ Allowed
263 -)))| |
264 -|**Activity**|(% colspan="3" %)(((
265 -**Project Management**
266 -)))
267 -|Update Project Information|(((
268 -☑️ Allowed
269 -)))| |
270 -|Create and manage File Attribute templates|(((
271 -☑️ Allowed
272 -)))| |
273 -|Fulfill Project member file copy requests from Green Room to Core|(((
274 -☑️ Allowed
275 -)))| |
276 -|Approve Project member VM access requests|(((
277 -☑️ Allowed
278 -)))| |
279 -|Create Project Announcements|(((
280 -☑️ Allowed
281 -)))| |
282 -|**Activity**|(% colspan="3" %)(((
283 -**Workspace Tools Management**
284 -)))
285 -|Access Jupyterhub|(((
286 -☑️ Allowed
287 -)))|(((
288 -☑️ Allowed
289 -)))|
290 -|Access XWiki|(((
291 -☑️ Allowed
292 -)))|(((
293 -☑️ Allowed
294 -)))|(((
295 -☑️ Allowed
296 -)))
297 297  
298 -(% border="1" style="margin-right:auto" %)
364 +Parameters for File Attributes JSON templates are as follows:
299 299  
300 -|=(% style="background-color: rgb(1, 139, 126); color:white" %)Activity |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Administrator |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Collaborator |=(% style="background-color: rgb(1, 139, 126); color:white" %)Project Contributor
301 -|Activity | | |
302 -| Access own files in Project Green Room |✅ Allowed|✅ Allowed|✅ Allowed
303 -| Access all files in Project Green Room |✅ Allowed| |
304 -| Upload and annotate files to Project Green Room |✅ Allowed|✅ Allowed|✅ Allowed
305 -| Download files from own Project Green Room folder |✅ Allowed|✅ Allowed|✅ Allowed
306 -| Download files from any Project Green Room folder |✅ Allowed| |
307 -|Request file copy from Green Room to Core|✅ Allowed|✅ Allowed|
308 -|Copy files from Green Room to Core|✅ Allowed|✅ Allowed|
309 -|Activity|Core| |
310 -|Access own files in Project Core| | |
311 -|Access all files in Project Core| | |
312 -|Upload and annotate files from from Workspace to Project Core (via Command Line Interface)| | |
313 -|Download files from Project Core own folder| | |
314 -|Download files from Project Core any folder| | |
315 -|View, add, remove, manage Project members| | |
316 -| | | |
317 -| | | |
318 -| | | |
319 -| | | |
366 +* //Name//: The Attribute name (letters or numbers, no spaces).
367 +* //Type//: The type of information to be collected (text, multiple choice)
368 +* //Value//: If the Type is Multiple Choice, a list of the accepted values, separated by commas.
369 +* //Optional//: Default is true. Set to false if the Attribute should be mandatory on collection.
370 +
371 +The following example depicts a File Attribute template created in the Project Settings menu and the corresponding JSON file format. You can use this example as a guideline to create your own JSON file.
372 +
373 +Template created in the Project Settings menu:
374 +
375 +[[image:Manage Projects File Attributes Example for JSON v2.1.5 2023-02-01.png||height="17%" width="50%"]]
376 +
377 +Corresponding JSON file format:
378 +
379 +{{code language="json"}}
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 +{{/code}}
382 +
383 += Deleting and Archiving Projects =
384 +
385 +Please contact a Platform Administrator if you need to delete or archive your Project.
386 +
387 +
388 +----
389 +
390 +Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]].
391 +
392 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].
393 +
394 +
395 +
396 +
397 +
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
Manage Projects File Attributes Example for JSON v2.1.5 2023-02-01.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +45.1 KB
Content
Manage Projects File Attributes v2.1.5 2023-02-01.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +289.0 KB
Content
Manage Projects Workspace Deployment v2.1.5 2023-02-02 1517.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +667.4 KB
Content