Wiki source code of Managing HDC Projects
Last modified by Dennis Segebarth on 2024/08/14 17:08
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="Table of Contents"}} | ||
| 2 | {{toc depth="2"/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This section of the User Guide describes the features available to Project Administrators to manage their Project. | ||
| 6 | |||
| 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//). | ||
| 8 | |||
| 9 | = Getting Access to your Project = | ||
| 10 | |||
| 11 | As a Project Administrator, you can start working in your Project after the Platform Administrator has created it and invited you. You’ll receive an email containing an invitation link - if it’s your first time using the platform, the link will direct you to register your user account; if you already have a user account, the link will take you to the login page where you can enter your username and password to open your Project from the Project Landing Page. For more information, see //Getting Started with HealthDataCloud//. | ||
| 12 | |||
| 13 | = File Access for Project Administrators = | ||
| 14 | |||
| 15 | As a Project Administrator, when you launch your Project the Project Canvas view displays file activity statistics from all Project members, not just your own. In the File Explorer, you have access to all Project member folders in the Green Room and Core, and can perform actions (upload, download, tag, annotate, delete) on any file. | ||
| 16 | |||
| 17 | = Modifying Project General Information = | ||
| 18 | |||
| 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 | |||
| 21 | [[image:1723654603707-412.png||height="269" width="282"]] | ||
| 22 | |||
| 23 | |||
| 24 | To edit your Project’s General Information (Project Administrator role), | ||
| 25 | |||
| 26 | 1. Launch the Project and click the **Settings** icon in the left menu bar. | ||
| 27 | 1. Click the **General Information** tab. If changes are desired, click the icon in the upper right corner to open **Edit **mode. | ||
| 28 | 1. Make the necessary changes. | ||
| 29 | 1. Click **Save** to save the changes or **Cancel** to exit without saving. | ||
| 30 | |||
| 31 | **General Information** includes the following: | ||
| 32 | |||
| 33 | * ((( | ||
| 34 | //Project Code// (required, cannot be changed): | ||
| 35 | |||
| 36 | * Uniquely identifies the Project across the platform. | ||
| 37 | * Between 1-32 characters. Must start with a letter and contain only lower case letters (a-z) and numbers (0-9) | ||
| 38 | ))) | ||
| 39 | * ((( | ||
| 40 | //Project Name// (required): | ||
| 41 | |||
| 42 | * A short name for your project to differentiate it from other projects. | ||
| 43 | * Maximum 100 characters | ||
| 44 | ))) | ||
| 45 | * ((( | ||
| 46 | //Description~:// | ||
| 47 | |||
| 48 | * A longer description of the Project to add more context and inform users of study details. | ||
| 49 | * Maximum 250 characters. | ||
| 50 | ))) | ||
| 51 | * ((( | ||
| 52 | //Project Administrator~:// | ||
| 53 | |||
| 54 | * Displays the names of the Project Administrators assigned to the Project as email links. | ||
| 55 | * Auto-populated. To add or remove Project Administrators, go to the Members page (see Managing Project Members) | ||
| 56 | ))) | ||
| 57 | * ((( | ||
| 58 | //Tags~:// | ||
| 59 | |||
| 60 | * Keywords to help make your Project findable. | ||
| 61 | * Between 1 and 32 characters and may only contain lowercase letters, numbers and/or hyphens. | ||
| 62 | ))) | ||
| 63 | * ((( | ||
| 64 | //Icon~:// | ||
| 65 | |||
| 66 | * An image uploaded from your computer to make your project more findable. | ||
| 67 | * Recommended size 200 x 200 pixels. | ||
| 68 | ))) | ||
| 69 | * ((( | ||
| 70 | //Visibility~:// | ||
| 71 | |||
| 72 | * A setting that controls the Project’s visibility in the Project Landing Page (ON/OFF). | ||
| 73 | * By default, visibility is set to ON, meaning that the Project’s general information is listed in the Project Landing Page All Projects tab and is visible to all Platform users. Turning this setting OFF hides the Project in the Project Landing Page from everyone except Project members. | ||
| 74 | ))) | ||
| 75 | |||
| 76 | = Managing Project Data = | ||
| 77 | |||
| 78 | Each Project has its own //Core// and //Green Room// areas. The //Green Room// is the landing zone for all files uploaded to the platform. In the Projects' //Green Room//, files are only visible to the respective User who uploaded them, as well as the corresponding Project Administrators. In contrast to the isolated //Green Room//, the //Core //of each Project serves as the common data storage area of the Project, where all Project members (except Project Contributors, see //Project Roles// below) can access each others’ files, create file collections, and use the workspace tools to open files and perform analyses. | ||
| 79 | |||
| 80 | In order to ensure compliance of all data in the //Core //with the Projects´ respective data management plan, the transfer of data from the isolated //Green Room// to the collaboratively used //Core// is a tightly controlled process, which can only be performed by a Project Administrator. Therefore, Project members who are not Project Administrators have to select files and/or folders in their own folder in the Projects´ //Green Room// and submit a Copy-to-Core request to the Project Administrator, in order to copy the selected files to the Projects´ //Core //(for more information on this process, see //Working with HDC Project Files in the Portal > Requesting File Copy from the Green Room to the Core//). Essentially, this grants Project Administrators full control of the data in their Projects` //Core//, for instance to ensure that all data are pseudonymized to the extent necessary to comply with the Projects` data management plan. | ||
| 81 | |||
| 82 | See the following sections for details on how Project Administrators can copy files from the Green Room to the Core, and process Copy-to-Core requests. | ||
| 83 | |||
| 84 | == Copying files from the Green Room to Core == | ||
| 85 | |||
| 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 | |||
| 88 | [[image:1723654635472-816.png||height="184" width="886"]] | ||
| 89 | |||
| 90 | 1. In the Project File Explorer, open the **Green Room** and navigate to the folder where the file(s) are stored. | ||
| 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**. | ||
| 92 | 1. In the confirmation pop-up, select a destination folder. | ||
| 93 | 1. A confirmation code is randomly generated. Type the code in the entry box to confirm your intention to copy the selected files to the specified destination, then click** Confirm**. | ||
| 94 | 1. Another popup confirms the action was completed. Click **Close** to dismiss. | ||
| 95 | |||
| 96 | After completing the Copy action, your files are visible in the File Explorer in the specified destination folder in the //Core //and can be accessed by all Project members (except Project contributors, see //Project Roles// below). | ||
| 97 | |||
| 98 | == Processing Copy to Core Requests == | ||
| 99 | |||
| 100 | Project members cannot copy files to the //Core //themselves but can select files and/or folders in their //Green Room// folder and submit a Copy to Core request to the Project Administrator to copy the selected files to the //Core//. Project Administrators can approve or deny each file in the request individually, then complete the request and notify the user. | ||
| 101 | |||
| 102 | === Approve or Deny selected files === | ||
| 103 | |||
| 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 | |||
| 106 | [[image:1723654648402-919.png||height="301" width="558"]] | ||
| 107 | |||
| 108 | ((( | ||
| 109 | 1. Click the **Requests icon** from the Project left menu bar and view the tab **Copy Data To Core Request**. | ||
| 110 | 1. Click **New** to view the new user requests that have not been fulfilled, or **Completed **to view requests that have been fulfilled. | ||
| 111 | 1. Select a **New** request to be fulfilled and review the request details in the header. A file explorer table on the right-hand side allows you to browse through all files and/or folders that are part of the selected request and approve/deny the copy to core request on an individual file-to-file (or folder-to-folder) basis. | ||
| 112 | 1. To approve or deny the copy to core request for an individual file or folder that is part of the copy to core request, select the file/folder by clicking its corresponding checkbox in the file explorer table. You can also approve or deny multiple files/folders at once by clicking all their corresponding checkboxes. Note: The decision you make (approve / deny) will be applied to all currently selected files/folders! | ||
| 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 | 1*. **Approve Selected** to copy the selected files/folders to be copied to the Core. | ||
| 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"]] | ||
| 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 | 1. Another popup confirms the action was completed. Click **Close** to dismiss. | ||
| 119 | ))) | ||
| 120 | |||
| 121 | After completing the above steps, approved files/folders will be copied to the destination in the //Core// that was specified in the copy to core request. All Project members (except Project Contributors, see //Project Roles// below) can now access the files via the File Explorer or workbench tools. Denied files are not copied. | ||
| 122 | |||
| 123 | === Close the Request === | ||
| 124 | |||
| 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 | |||
| 127 | [[image:1723654683455-327.png||height="170" width="865"]] | ||
| 128 | |||
| 129 | |||
| 130 | 1. Click **Close Request & Notify User**. | ||
| 131 | 1*. If you haven't approved or denied all the files/folders in the request, a popup window appears reminding you to go back and approve or deny the remaining files. | ||
| 132 | 1*. If you have approved or denied all the files/folders in the request, a popup window prompts you to confirm closure of this request and enter optional Review notes that will be shared with the requester. | ||
| 133 | 1. Click **Confirm**. | ||
| 134 | 1. An email notification is sent to the requester, and the request appears in the **Completed **tab in the **Requests **panel. | ||
| 135 | |||
| 136 | After completing the above steps, the request status moves to **Completed**. | ||
| 137 | |||
| 138 | == Considerations == | ||
| 139 | |||
| 140 | * Large files may take some time to copy to the Core. To view the progress, open the **File Status** panel in the Main Menu. | ||
| 141 | * If a file with same name already exists in the destination folder in the Core, the file will be copied and a time-stamp will be appended to its filename. | ||
| 142 | * If a folder with the same name already exists in the destination, the files will be copied into the existing folder and a 10-digit time-based integer hash will be appended to the duplicate filenames. | ||
| 143 | * ((( | ||
| 144 | The original file remains in the Green Room and a copy of the file is moved to the destination folder in the Core. The new Core file metadata and Data Lineage properties are updated: | ||
| 145 | |||
| 146 | * //Created //- the timestamp indicating the time the copy was created. | ||
| 147 | * //Data Lineage Pipeline - copy //- the time the file copy landed in the Core. | ||
| 148 | ))) | ||
| 149 | |||
| 150 | = Managing Project Members = | ||
| 151 | |||
| 152 | Project Administrators have the flexibility to add or remove Project members, and change users' roles within the Project. | ||
| 153 | |||
| 154 | [[image:1723654696855-544.png||height="326" width="342"]] | ||
| 155 | |||
| 156 | |||
| 157 | To manage Project membership for your Project as Project Administrator role, | ||
| 158 | |||
| 159 | 1. Launch the Project and click the **Project Members** icon in the left menu bar. | ||
| 160 | 1. The **Members** table displays all the members of the project. Use the search, sort, and page navigation tools to find users. | ||
| 161 | 1. Choose one of the available options described below to manage your Project members. | ||
| 162 | |||
| 163 | == Adding Project Members == | ||
| 164 | |||
| 165 | Project Administrators can add new members to the Project: | ||
| 166 | |||
| 167 | [[image:1723654713217-983.png||height="111" width="869"]] | ||
| 168 | |||
| 169 | |||
| 170 | 1. Launch your Project and open the **Project Members** page, then click **+ Add Member**. | ||
| 171 | 1. Enter the user’s email address and assign a Project Role (see //Project Roles//, below). | ||
| 172 | 1. Click **Submit** to continue, or **Cancel** to exit without adding the member. | ||
| 173 | 1. A second pop-up window prompts you to review the provided information. Click **Send** to complete the invitation, or **Cancel** to exit. | ||
| 174 | |||
| 175 | If the invited member already has a user account on the platform, they are added to the Project immediately and they will receive an email notification that their new Project access has been granted. Their member details will appear in the members page. | ||
| 176 | |||
| 177 | If the invited member doesn’t have a user account on the platform, they will receive an email with instructions on completing their account registration. For details on this process, see //Getting Started. //For new platform account holders, please note the following: | ||
| 178 | |||
| 179 | * Between the time of invitation and account activation, the user’s invitation status is listed as Pending in the **Invitations **tab. | ||
| 180 | * After the invited member completes their account activation, their member details appear in the Members page and their invitation status is listed as Completed in the **Invitations **tab. | ||
| 181 | |||
| 182 | == Project Roles == | ||
| 183 | |||
| 184 | The following table describes available Project roles and their permissioned data and project operations: | ||
| 185 | |||
| 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 Guacamole VMs|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %) | ||
| 217 | |Access XWiki|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed|(% style="text-align:center" %)☑️ Allowed | ||
| 218 | |||
| 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 | |||
| 221 | == Viewing Project Member Profiles and Account Activities == | ||
| 222 | |||
| 223 | Project Administrators can review the Project membership, member profiles and account activities. | ||
| 224 | |||
| 225 | 1. Launch your Project and open the **Project Members** page. | ||
| 226 | 1. Click the **Action icon** (three vertical dots) in the member’s entry in the **Members **table and click **Profile**. | ||
| 227 | 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). | ||
| 228 | |||
| 229 | == Changing Project Member Roles == | ||
| 230 | |||
| 231 | Project Administrators can change the role of any Project member other than themselves. | ||
| 232 | |||
| 233 | 1. Launch your Project and open the **Members **table in the **Project Members** page. | ||
| 234 | 1. In the member’s entry, click **Change Role **and select a new role from the dropdown menu. | ||
| 235 | 1. A popup window prompts you to confirm the change. Click **OK** to confirm, or **Cancel** to exit without making the change. | ||
| 236 | |||
| 237 | After clicking **OK**, the role change takes effect immediately and the Project member will receive an email notification confirming their new role assignment. | ||
| 238 | |||
| 239 | === Considerations === | ||
| 240 | |||
| 241 | * Assigning a Project Member to a less privileged role may cause them to lose access to Project data they previously had access to. | ||
| 242 | * As a Project Administrator you cannot change your own role, but another Project Administrator can change your role. | ||
| 243 | |||
| 244 | == Removing Members from the Project == | ||
| 245 | |||
| 246 | Project Administrators can remove members from the Project. | ||
| 247 | |||
| 248 | 1. Launch your Project and open the **Members** table on the **Project members** page. | ||
| 249 | 1. Click the **Action icon** (three vertical dots) in the member’s entry and click **Delete**. | ||
| 250 | 1. A popup window prompts you to confirm the change. Click **OK** to confirm, or **Cancel** to exit without making the change. | ||
| 251 | |||
| 252 | 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. | ||
| 253 | |||
| 254 | 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. | ||
| 255 | |||
| 256 | = Managing Project Workspace Tools = | ||
| 257 | |||
| 258 | 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. | ||
| 259 | |||
| 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 | |||
| 262 | [[image:1723654733035-792.png||height="409" width="869"]] | ||
| 263 | |||
| 264 | |||
| 265 | If you need a Workspace tool deployed for the project, please contact a Platform Administrator. | ||
| 266 | |||
| 267 | == Jupyterhub == | ||
| 268 | |||
| 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 | |||
| 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 | == XWiki == | ||
| 301 | |||
| 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. | ||
| 303 | |||
| 304 | = Creating Project Announcements = | ||
| 305 | |||
| 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 | |||
| 308 | [[image:1723654770127-448.png||height="321" width="334"]] | ||
| 309 | |||
| 310 | |||
| 311 | To create a Project announcement as Project Administrator, | ||
| 312 | |||
| 313 | 1. Launch your Project and click the **Announcements **icon in the left menu bar. | ||
| 314 | 1. In the **Create new announcement** window, enter your announcement (maximum length 250 characters) and click **Publish**. | ||
| 315 | 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. | ||
| 316 | |||
| 317 | = Managing File Attribute Templates = | ||
| 318 | |||
| 319 | 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//). | ||
| 320 | |||
| 321 | == Creating a File Attribute Template == | ||
| 322 | |||
| 323 | To create a new File Attribute template for your project as Project Administrator, | ||
| 324 | |||
| 325 | [[image:1723654789441-207.png||height="114" width="864"]] | ||
| 326 | |||
| 327 | |||
| 328 | 1. Launch your Project and click on the Project **Settings **icon. | ||
| 329 | 1. Select the **File Attributes** tab and click **Create New Attribute Template**. | ||
| 330 | 1. Enter a name for the Template and click **Next Step.** | ||
| 331 | 1. ((( | ||
| 332 | Click **+ Add Attribute** to create a new attribute and configure the key parameters: | ||
| 333 | |||
| 334 | * //Name//: Provide the name of the attribute (letters or numbers, no spaces, maximum 32 characters). | ||
| 335 | * //Type: //Select the type of information to be collected (text, multiple choice). Text fields will allow entries of up to 100 characters. | ||
| 336 | * //Value~:// If you selected multiple choice as type, you can define the available value options (maximum 32 characters each), pressing Enter after each entry. | ||
| 337 | * //Optional~:// Specify whether the Attribute is optional or mandatory (optional by default). Uncheck the box if the Attribute is mandatory. | ||
| 338 | ))) | ||
| 339 | 1. Click the **checkmark **to save the new field or **X** to clear the field. | ||
| 340 | 1. To add more fields, repeat steps 4-5 until all fields have been added. | ||
| 341 | 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. | ||
| 342 | 1. Click **Create**.** ** | ||
| 343 | |||
| 344 | 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//. | ||
| 345 | |||
| 346 | You can create multiple File Attribute templates for the Project, but a Project file can only be annotated with a single File Attribute template. | ||
| 347 | |||
| 348 | == Managing a File Attributes Template == | ||
| 349 | |||
| 350 | 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. | ||
| 351 | |||
| 352 | 1. Launch your Project and click on the Project **Settings **icon. | ||
| 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. | ||
| 361 | 1. The changes will be effective for any new File Attribute annotations. | ||
| 362 | |||
| 363 | == Importing File Attribute Templates == | ||
| 364 | |||
| 365 | Instead of using the Project **Settings **page to create Attributes template, Project Administrators can import the template configuration as a JSON file. | ||
| 366 | |||
| 367 | 1. On your local computer, create and save a JSON file containing your annotations, see //Formatting Guideline for JSON File Attribute Templates// below. | ||
| 368 | 1. Launch your Project and click on the **Settings** icon. | ||
| 369 | 1. Select the **File Attributes** and click **Import Attribute Template**. | ||
| 370 | 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. | ||
| 371 | 1. Once the file has been successfully uploaded and saved, it will be available to all Project Members to annotate files. | ||
| 372 | |||
| 373 | === Formatting Guideline for JSON File Attribute Templates === | ||
| 374 | |||
| 375 | JSON is built around two structures: | ||
| 376 | |||
| 377 | * ((( | ||
| 378 | Objects | ||
| 379 | |||
| 380 | * Key-value pairs | ||
| 381 | * Surrounded by curly brackets ({}) | ||
| 382 | ))) | ||
| 383 | * ((( | ||
| 384 | Arrays | ||
| 385 | |||
| 386 | * Lists of items | ||
| 387 | * Surrounded by square brackets ([]) | ||
| 388 | ))) | ||
| 389 | |||
| 390 | Parameters for File Attributes JSON templates are as follows: | ||
| 391 | |||
| 392 | * //Name//: The Attribute name (letters or numbers, no spaces). | ||
| 393 | * //Type//: The type of information to be collected (text, multiple choice) | ||
| 394 | * //Value//: If the Type is Multiple Choice, a list of the accepted values, separated by commas. | ||
| 395 | * //Optional//: Default is true. Set to false if the Attribute should be mandatory on collection. | ||
| 396 | |||
| 397 | 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. | ||
| 398 | |||
| 399 | Template created in the Project Settings menu: | ||
| 400 | |||
| 401 | [[image:1723654813207-477.png||height="296" width="869"]] | ||
| 402 | |||
| 403 | Corresponding JSON file format: | ||
| 404 | |||
| 405 | {{code language="json"}} | ||
| 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 | {{/code}} | ||
| 408 | |||
| 409 | = Deleting and Archiving Projects = | ||
| 410 | |||
| 411 | Please contact a Platform Administrator if you need to delete or archive your Project. | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | ---- | ||
| 416 | |||
| 417 | Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]]. | ||
| 418 | |||
| 419 | HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]]. |